Package com.gengoai.stream.local

Class LocalMDoubleAccumulator

java.lang.Object

com.gengoai.stream.local.LocalMAccumulator<Double,Double>

com.gengoai.stream.local.LocalMDoubleAccumulator

All Implemented Interfaces:

Copyable<LocalMAccumulator<Double,Double>>, MAccumulator<Double,Double>, MDoubleAccumulator, Serializable

public class LocalMDoubleAccumulator
extends LocalMAccumulator<Double,Double>
implements MDoubleAccumulator

An implementation of a MDoubleAccumulator for local streams

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LocalMDoubleAccumulator(double value, String name)	Instantiates a new Local double accumulator.

Method Summary

Modifier and Type	Method	Description
void	add(double value)	Adds a primitive double value.
LocalMAccumulator<Double,Double>	copy()	Makes a copy of this object.
boolean	isZero()	Determines if the accumulator is a zero value
void	merge(MAccumulator<Double,Double> other)	Merges another accumulator with this one
void	reset()	Resets the accumulator to its zero-value.
Double	value()	The value of the accumulator.

Methods inherited from class com.gengoai.stream.local.LocalMAccumulator

name, register, report

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.gengoai.stream.MAccumulator

name, register, report

Methods inherited from interface com.gengoai.stream.MDoubleAccumulator

add

Constructor Detail

LocalMDoubleAccumulator

public LocalMDoubleAccumulator(double value,
                               String name)

Instantiates a new Local double accumulator.

Parameters:

value - the initial value of the accumulator

name - the name of the accumulator

Method Detail

copy

public LocalMAccumulator<Double,Double> copy()

Description copied from interface: Copyable

Makes a copy of this object.

Specified by:

copy in interface Copyable<LocalMAccumulator<Double,Double>>

Returns:

A copy of this object.

value

public Double value()

Description copied from interface: MAccumulator

The value of the accumulator.

Specified by:

value in interface MAccumulator<Double,Double>

Returns:

the result of the accumulator

isZero

public boolean isZero()

Description copied from interface: MAccumulator

Determines if the accumulator is a zero value

Specified by:

isZero in interface MAccumulator<Double,Double>

Returns:

True if the accumulator is in a zero state

merge

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

Description copied from interface: MAccumulator

Merges another accumulator with this one

Specified by:

merge in interface MAccumulator<Double,Double>

Parameters:

other - the other accumulator to merge

reset

public void reset()

Description copied from interface: MAccumulator

Resets the accumulator to its zero-value.

Specified by:

reset in interface MAccumulator<Double,Double>

add

public void add(double value)

Description copied from interface: MDoubleAccumulator

Adds a primitive double value.

Specified by:

add in interface MDoubleAccumulator

Parameters:

value - the value to add