class ConnectedComponents extends Arguments with Logging with WithAlgorithmChoice with WithCheckpointInterval with WithBroadcastThreshold with WithIntermediateStorageLevel with WithMaxIter

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
WithMaxIter, WithIntermediateStorageLevel, WithBroadcastThreshold, WithCheckpointInterval, WithAlgorithmChoice, Logging, Arguments, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConnectedComponents
  2. WithMaxIter
  3. WithIntermediateStorageLevel
  4. WithBroadcastThreshold
  5. WithCheckpointInterval
  6. WithAlgorithmChoice
  7. Logging
  8. Arguments
  9. AnyRef
  10. 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. val ALGO_GRAPHFRAMES: String
    Attributes
    protected
    Definition Classes
    WithAlgorithmChoice
  7. val ALGO_GRAPHX: String
    Attributes
    protected
    Definition Classes
    WithAlgorithmChoice
  8. val algorithm: String
    Attributes
    protected
    Definition Classes
    WithAlgorithmChoice
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val broadcastThreshold: Int
    Attributes
    protected
    Definition Classes
    WithBroadcastThreshold
  11. val checkpointInterval: Int
    Attributes
    protected
    Definition Classes
    WithCheckpointInterval
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  13. 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
  14. 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
  15. 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
  16. 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
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def getAlgorithm: String
    Definition Classes
    WithAlgorithmChoice
  20. def getBroadcastThreshold: Int

    Gets broadcast threshold in propagating component assignment.

    Gets broadcast threshold in propagating component assignment.

    Definition Classes
    WithBroadcastThreshold
    See also

    org.graphframes.lib.ConnectedComponents.setBroadcastThreshold

  21. def getCheckpointInterval: Int

    Gets checkpoint interval.

    Gets checkpoint interval.

    Definition Classes
    WithCheckpointInterval
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def getIntermediateStorageLevel: StorageLevel

    Gets storage level for intermediate datasets that require multiple passes.

    Gets storage level for intermediate datasets that require multiple passes.

    Definition Classes
    WithIntermediateStorageLevel
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val intermediateStorageLevel: StorageLevel
    Attributes
    protected
    Definition Classes
    WithIntermediateStorageLevel
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def logDebug(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logInfo(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarn(s: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def maxIter(value: Int): ConnectedComponents.this.type

    The max number of iterations of algorithm to be performed.

    The max number of iterations of algorithm to be performed.

    Definition Classes
    WithMaxIter
  32. val maxIter: Option[Int]
    Attributes
    protected
    Definition Classes
    WithMaxIter
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. def run(): DataFrame

    Runs the algorithm.

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

    Set an algorithm to use.

    Set an algorithm to use. Supported algorithms are "graphx" and "graphframes".

    Definition Classes
    WithAlgorithmChoice
  38. 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".

    Definition Classes
    WithBroadcastThreshold
  39. 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 of the algorithm name. 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.

    Definition Classes
    WithCheckpointInterval
    See also

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

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

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

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

    Definition Classes
    WithIntermediateStorageLevel
  41. val supportedAlgorithms: Array[String]
    Definition Classes
    WithAlgorithmChoice
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. 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 finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. 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 WithMaxIter

Inherited from WithIntermediateStorageLevel

Inherited from WithBroadcastThreshold

Inherited from WithCheckpointInterval

Inherited from WithAlgorithmChoice

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