class ConnectedComponents extends Arguments with Logging

Connected components algorithm.

Computes the connected component membership of each vertex and returns a DataFrame of vertex information with each vertex assigned a component ID.

The resulting DataFrame contains all the vertex information and one additional column:

  • component (LongType): unique ID for this component
Linear Supertypes
Logging, Arguments, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConnectedComponents
  2. Logging
  3. Arguments
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to any2stringadd[ConnectedComponents] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConnectedComponents, B)
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to ArrowAssoc[ConnectedComponents] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def ensuring(cond: (ConnectedComponents) ⇒ Boolean, msg: ⇒ Any): ConnectedComponents
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to Ensuring[ConnectedComponents] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ConnectedComponents) ⇒ Boolean): ConnectedComponents
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to Ensuring[ConnectedComponents] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ConnectedComponents
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to Ensuring[ConnectedComponents] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ConnectedComponents
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to Ensuring[ConnectedComponents] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def getAlgorithm: String

    Gets the connected component algorithm to use.

    Gets the connected component algorithm to use.

    See also

    org.graphframes.lib.ConnectedComponents.setAlgorithm.

  16. def getBroadcastThreshold: Int

    Gets broadcast threshold in propagating component assignment.

    Gets broadcast threshold in propagating component assignment.

    See also

    org.graphframes.lib.ConnectedComponents.setBroadcastThreshold

  17. def getCheckpointInterval: Int

    Gets checkpoint interval.

    Gets checkpoint interval.

    See also

    org.graphframes.lib.ConnectedComponents.setCheckpointInterval

  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getIntermediateStorageLevel: StorageLevel

    Gets storage level for intermediate datasets that require multiple passes.

  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def logDebug(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logInfo(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logTrace(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logWarn(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def run(): DataFrame

    Runs the algorithm.

  30. def setAlgorithm(value: String): ConnectedComponents.this.type

    Sets the connected components algorithm to use (default: "graphframes").

    Sets the connected components algorithm to use (default: "graphframes"). Supported algorithms are:

    • "graphframes": Uses alternating large star and small star iterations proposed in Connected Components in MapReduce and Beyond with skewed join optimization.
    • "graphx": Converts the graph to a GraphX graph and then uses the connected components implementation in GraphX.
    See also

    org.graphframes.lib.ConnectedComponents.supportedAlgorithms

  31. def setBroadcastThreshold(value: Int): ConnectedComponents.this.type

    Sets broadcast threshold in propagating component assignments (default: 1000000).

    Sets broadcast threshold in propagating component assignments (default: 1000000). If a node degree is greater than this threshold at some iteration, its component assignment will be collected and then broadcasted back to propagate the assignment to its neighbors. Otherwise, the assignment propagation is done by a normal Spark join. This parameter is only used when the algorithm is set to "graphframes".

  32. def setCheckpointInterval(value: Int): ConnectedComponents.this.type

    Sets checkpoint interval in terms of number of iterations (default: 2).

    Sets checkpoint interval in terms of number of iterations (default: 2). Checkpointing regularly helps recover from failures, clean shuffle files, shorten the lineage of the computation graph, and reduce the complexity of plan optimization. As of Spark 2.0, the complexity of plan optimization would grow exponentially without checkpointing. Hence disabling or setting longer-than-default checkpoint intervals are not recommended. Checkpoint data is saved under org.apache.spark.SparkContext.getCheckpointDir with prefix "connected-components". If the checkpoint directory is not set, this throws a java.io.IOException. Set a nonpositive value to disable checkpointing. This parameter is only used when the algorithm is set to "graphframes". Its default value might change in the future.

    See also

    org.apache.spark.SparkContext.setCheckpointDir in Spark API doc

  33. def setIntermediateStorageLevel(value: StorageLevel): ConnectedComponents.this.type

    Sets storage level for intermediate datasets that require multiple passes (default: MEMORY_AND_DISK).

  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  39. def →[B](y: B): (ConnectedComponents, B)
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to ArrowAssoc[ConnectedComponents] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ConnectedComponents to StringFormat[ConnectedComponents] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from Logging

Inherited from Arguments

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConnectedComponents to any2stringadd[ConnectedComponents]

Inherited by implicit conversion StringFormat from ConnectedComponents to StringFormat[ConnectedComponents]

Inherited by implicit conversion Ensuring from ConnectedComponents to Ensuring[ConnectedComponents]

Inherited by implicit conversion ArrowAssoc from ConnectedComponents to ArrowAssoc[ConnectedComponents]

Ungrouped