org.apache.spark.util

Class DoubleAccumulator

Object

org.apache.spark.util.AccumulatorV2<Double,Double>

org.apache.spark.util.DoubleAccumulator

All Implemented Interfaces:

java.io.Serializable

public class DoubleAccumulator
extends AccumulatorV2<Double,Double>

An accumulator for computing sum, count, and averages for double precision floating numbers.

Since:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DoubleAccumulator()

Method Summary

Modifier and Type	Method and Description
void	add(double v) Adds v to the accumulator, i.e.
void	add(Double v) Adds v to the accumulator, i.e.
double	avg() Returns the average of elements added to the accumulator.
DoubleAccumulator	copy() Creates a new copy of this accumulator.
long	count() Returns the number of elements added to the accumulator.
boolean	isZero() Returns if this accumulator is zero value or not.
void	merge(AccumulatorV2<Double,Double> other) Merges another same-type accumulator into this one and update its state, i.e.
void	reset() Resets this accumulator, which is zero value.
double	sum() Returns the sum of elements added to the accumulator.
Double	value() Defines the current value of this accumulator

Methods inherited from class org.apache.spark.util.AccumulatorV2

copyAndReset, id, isRegistered, name, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DoubleAccumulator

public DoubleAccumulator()

Method Detail

isZero

public boolean isZero()

Description copied from class: AccumulatorV2

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.

Specified by:

isZero in class AccumulatorV2<Double,Double>

Returns:

(undocumented)

copy

public DoubleAccumulator copy()

Description copied from class: AccumulatorV2

Creates a new copy of this accumulator.

Specified by:

copy in class AccumulatorV2<Double,Double>

Returns:

(undocumented)

reset

public void reset()

Description copied from class: AccumulatorV2

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

Specified by:

reset in class AccumulatorV2<Double,Double>

add

public void add(Double v)

Adds v to the accumulator, i.e. increment sum by v and count by 1.

Specified by:

add in class AccumulatorV2<Double,Double>

Parameters:

v - (undocumented)

Since:

2.0.0

add

public void add(double v)

Adds v to the accumulator, i.e. increment sum by v and count by 1.

Parameters:

v - (undocumented)

Since:

2.0.0

count

public long count()

Returns the number of elements added to the accumulator.

Returns:

(undocumented)

Since:

2.0.0

sum

public double sum()

Returns the sum of elements added to the accumulator.

Returns:

(undocumented)

Since:

2.0.0

avg

public double avg()

Returns the average of elements added to the accumulator.

Returns:

(undocumented)

Since:

2.0.0

merge

public void merge(AccumulatorV2<Double,Double> other)

Description copied from class: AccumulatorV2

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

Specified by:

merge in class AccumulatorV2<Double,Double>

Parameters:

other - (undocumented)

value

public Double value()

Description copied from class: AccumulatorV2

Defines the current value of this accumulator

Specified by:

value in class AccumulatorV2<Double,Double>

Returns:

(undocumented)