From 85a6645d318e728454e81096ca8140b5f640e782 Mon Sep 17 00:00:00 2001
From: Ankur Dave <ankurdave@gmail.com>
Date: Fri, 10 Jan 2014 16:08:58 -0800
Subject: [PATCH] Add doc for Algorithms
---
.../apache/spark/graphx/algorithms/Algorithms.scala | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/graphx/src/main/scala/org/apache/spark/graphx/algorithms/Algorithms.scala b/graphx/src/main/scala/org/apache/spark/graphx/algorithms/Algorithms.scala
index 4af7af545c..558d8da310 100644
--- a/graphx/src/main/scala/org/apache/spark/graphx/algorithms/Algorithms.scala
+++ b/graphx/src/main/scala/org/apache/spark/graphx/algorithms/Algorithms.scala
@@ -4,6 +4,16 @@ import scala.reflect.ClassTag
import org.apache.spark.graphx._
+/**
+ * Provides graph algorithms directly on [[org.apache.spark.graphx.Graph]] via an implicit
+ * conversion.
+ * @example
+ * {{{
+ * import org.apache.spark.graph.algorithms._
+ * val graph: Graph[_, _] = loadGraph()
+ * graph.connectedComponents()
+ * }}}
+ */
class Algorithms[VD: ClassTag, ED: ClassTag](self: Graph[VD, ED]) {
/**
* Run a dynamic version of PageRank returning a graph with vertex attributes containing the
--
GitLab