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 4af7af545c25649ae0e62d95aded85c79bb4b68a..558d8da310b9bf93cd964900c86bafc41140a10a 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