Class

org.apache.spark.util

AccumulatorV2

Related Doc: package util

Permalink

abstract class AccumulatorV2[IN, OUT] extends Serializable

The base class for accumulators, that can accumulate inputs of type IN, and produce output of type OUT.

OUT should be a type that can be read atomically (e.g., Int, Long), or thread-safely (e.g., synchronized collections) because it will be read from other threads.

Source
AccumulatorV2.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AccumulatorV2
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AccumulatorV2()

    Permalink

Abstract Value Members

  1. abstract def add(v: IN): Unit

    Permalink

    Takes the inputs and accumulates.

  2. abstract def copy(): AccumulatorV2[IN, OUT]

    Permalink

    Creates a new copy of this accumulator.

  3. abstract def isZero: Boolean

    Permalink

    Returns if this accumulator is zero value or not.

    Returns if this accumulator is zero value or not. e.g. for a counter accumulator, 0 is zero value; for a list accumulator, Nil is zero value.

  4. abstract def merge(other: AccumulatorV2[IN, OUT]): Unit

    Permalink

    Merges another same-type accumulator into this one and update its state, i.e.

    Merges another same-type accumulator into this one and update its state, i.e. this should be merge-in-place.

  5. abstract def reset(): Unit

    Permalink

    Resets this accumulator, which is zero value.

    Resets this accumulator, which is zero value. i.e. call isZero must return true.

  6. abstract def value: OUT

    Permalink

    Defines the current value of this accumulator

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def copyAndReset(): AccumulatorV2[IN, OUT]

    Permalink

    Creates a new copy of this accumulator, which is zero value.

    Creates a new copy of this accumulator, which is zero value. i.e. call isZero on the copy must return true.

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def id: Long

    Permalink

    Returns the id of this accumulator, can only be called after registration.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def isRegistered: Boolean

    Permalink

    Returns true if this accumulator has been registered.

    Returns true if this accumulator has been registered.

    Note

    All accumulators must be registered before use, or it will throw exception.

  15. final def name: Option[String]

    Permalink

    Returns the name of this accumulator, can only be called after registration.

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AccumulatorV2 → AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def writeReplace(): Any

    Permalink
    Attributes
    protected

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped