org.apache.spark

AccumulableParam

trait AccumulableParam[R, T] extends Serializable

Helper object defining how to accumulate values of a particular type. An implicit AccumulableParam needs to be available when you create Accumulables of a specific type.

R

the full accumulated data (result type)

T

partial data that can be added in

Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. AccumulableParam
  2. Serializable
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addAccumulator(r: R, t: T): R

    Add additional data to the accumulator value.

    Add additional data to the accumulator value. Is allowed to modify and return r for efficiency (to avoid allocating objects).

    r

    the current value of the accumulator

    t

    the data to be added to the accumulator

    returns

    the new value of the accumulator

  2. abstract def addInPlace(r1: R, r2: R): R

    Merge two accumulated values together.

    Merge two accumulated values together. Is allowed to modify and return the first value for efficiency (to avoid allocating objects).

    r1

    one set of accumulated data

    r2

    another set of accumulated data

    returns

    both data sets merged together

  3. abstract def zero(initialValue: R): R

    Return the "zero" (identity) value for an accumulator type, given its initial value.

    Return the "zero" (identity) value for an accumulator type, given its initial value. For example, if R was a vector of N dimensions, this would return a vector of N zeroes.