Module io.jenetics.base

Package io.jenetics.internal.math

Class DoubleAdder

java.lang.Object

java.lang.Number

io.jenetics.internal.math.DoubleAdder

All Implemented Interfaces:

Serializable, Comparable<DoubleAdder>

public final class DoubleAdder
extends Number
implements Comparable<DoubleAdder>

This class implements the the Kahan summation algorithm, which significantly reduces the numerical error when adding double values.

Since:

3.0

Version:

3.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DoubleAdder()	Create a new adder with the initial value of 0.0.
DoubleAdder(double value)	Create a new adder with the given default value.

Method Summary

Modifier and Type	Method	Description
DoubleAdder	add(double value)	Add the given value to this adder, using the Kahan summation algorithm
DoubleAdder	add(double[] values)	Add the given values to this adder.
DoubleAdder	add(DoubleAdder value)	Add the given value to this adder, using the Kahan summation algorithm
DoubleAdder	combine(DoubleAdder other)	Add the given value to this adder, using the Kahan summation algorithm
int	compareTo(DoubleAdder other)
double	doubleValue()
boolean	equals(Object obj)
float	floatValue()
int	hashCode()
int	intValue()
long	longValue()
boolean	sameState(DoubleAdder other)	Check if this and the other DoubleAdder maintain the same internal state.
DoubleAdder	set(double value)	Set the adder to the given value.
DoubleAdder	set(DoubleAdder value)	Set the adder to the given value.
static double	sum(double[] values)	Return the sum of the given double array.
String	toString()
double	value()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DoubleAdder

public DoubleAdder(double value)

Create a new adder with the given default value.

Parameters:

value - the initial value of this adder.

DoubleAdder

public DoubleAdder()

Create a new adder with the initial value of 0.0.

Method Details

set

public DoubleAdder set(double value)

Set the adder to the given value.

Parameters:

value - the new adder value

Returns:

this adder, for command chaining

set

public DoubleAdder set(DoubleAdder value)

Set the adder to the given value.

Parameters:

value - the new adder value

Returns:

this adder, for command chaining

Throws:

NullPointerException - if the given value is null

add

public DoubleAdder add(double value)

Add the given value to this adder, using the Kahan summation algorithm

Parameters:

value - the value to add

Returns:

this adder, for command chaining

add

public DoubleAdder add(double[] values)

Add the given values to this adder.

Parameters:

values - the values to add.

Returns:

this adder, for command chaining

add

public DoubleAdder add(DoubleAdder value)

Add the given value to this adder, using the Kahan summation algorithm

Parameters:

value - the value to add

Returns:

this adder, for command chaining

Throws:

NullPointerException - if the given value is null

combine

public DoubleAdder combine(DoubleAdder other)

Add the given value to this adder, using the Kahan summation algorithm

Parameters:

other - the value to add

Returns:

this adder, for command chaining

Throws:

NullPointerException - if the given value is null

value

public double value()

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

floatValue

public float floatValue()

Specified by:

floatValue in class Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

compareTo

public int compareTo(DoubleAdder other)

Specified by:

compareTo in interface Comparable<DoubleAdder>

sameState

public boolean sameState(DoubleAdder other)

Check if this and the other DoubleAdder maintain the same internal state.

Parameters:

other - the other object

Returns:

true if this and the other adder have the same state, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

sum

public static double sum(double[] values)

Return the sum of the given double array.

Parameters:

values - the values to sum up.

Returns:

the sum of the given values.

Throws:

NullPointerException - if the given array is null.