diff options
| author | Ankur Dave <ankurdave@gmail.com> | 2014-01-10 16:08:58 -0800 |
|---|---|---|
| committer | Ankur Dave <ankurdave@gmail.com> | 2014-01-10 16:08:58 -0800 |
| commit | 85a6645d318e728454e81096ca8140b5f640e782 (patch) | |
| tree | 521c43276109d883a7ea1b1d877a0ef2f3bed1e7 /graphx/src | |
| parent | 04c20e7f4f98b18187f2320ddd7dedce69017de7 (diff) | |
| download | spark-85a6645d318e728454e81096ca8140b5f640e782.tar.gz spark-85a6645d318e728454e81096ca8140b5f640e782.tar.bz2 spark-85a6645d318e728454e81096ca8140b5f640e782.zip | |
Add doc for Algorithms
Diffstat (limited to 'graphx/src')
| -rw-r--r-- | graphx/src/main/scala/org/apache/spark/graphx/algorithms/Algorithms.scala | 10 |
1 files changed, 10 insertions, 0 deletions
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 |