com.kontakt.sdk.android.ble.math

Class Sum

java.lang.Object

com.kontakt.sdk.android.ble.math.Sum

All Implemented Interfaces:

java.io.Serializable

public final class Sum
extends java.lang.Object
implements java.io.Serializable

Returns the sum of the available values.

If there are no values in the dataset, then 0 is returned. If any of the values are NaN, then NaN is returned.

Note that this implementation is not synchronized. If multiple threads access an instance of this class concurrently, and at least one of the threads invokes the increment() or clear() method, it must be synchronized externally.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Sum() Create a Sum instance

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the internal state of the Statistic
static boolean	equals(double x, double y, int maxUlps) Returns true if both arguments are equal or within the range of allowed error (inclusive).
boolean	equals(java.lang.Object object) Returns true iff object is an AbstractStorelessUnivariateStatistic returning the same values as this for getResult() and getN()
double	evaluate() Returns the result of evaluating the statistic over the stored data.
double	evaluate(double[] values) This default implementation calls clear(), then invokes increment(double) in a loop over the the input array, and then uses getResult() to compute the return value.
double	evaluate(double[] values, double[] weights) The weighted sum of the entries in the the input array.
double	evaluate(double[] values, double[] weights, int begin, int length) The weighted sum of the entries in the specified portion of the input array, or 0 if the designated subarray is empty.
double	evaluate(double[] values, int begin, int length) The sum of the entries in the specified portion of the input array, or 0 if the designated subarray is empty.
double[]	getData() Get a copy of the stored data array.
protected double[]	getDataRef() Get a reference to the stored data array.
long	getN()
double	getResult() Returns the current value of the Statistic.
int	hashCode() Returns hash code based on getResult() and getN()
void	increment(double d) Updates the internal state of the statistic to reflect the addition of the new value.
void	incrementAll(double[] values) This default implementation just calls increment(double) in a loop over the input array.
void	incrementAll(double[] values, int begin, int length) This default implementation just calls increment(double) in a loop over the specified portion of the input array.
void	setData(double[] values) Set the data array.
void	setData(double[] values, int begin, int length) Set the data array.
protected boolean	test(double[] values, double[] weights, int begin, int length) This method is used by evaluate(double[], double[], int, int) methods to verify that the begin and length parameters designate a subarray of positive length and the weights are all non-negative, non-NaN, finite, and not all zero.
protected boolean	test(double[] values, double[] weights, int begin, int length, boolean allowEmpty) This method is used by evaluate(double[], double[], int, int) methods to verify that the begin and length parameters designate a subarray of positive length and the weights are all non-negative, non-NaN, finite, and not all zero.
protected boolean	test(double[] values, int begin, int length) This method is used by evaluate(double[], int, int) methods to verify that the input parameters designate a subarray of positive length.
protected boolean	test(double[] values, int begin, int length, boolean allowEmpty) This method is used by evaluate(double[], int, int) methods to verify that the input parameters designate a subarray of positive length.
static boolean	verifyValues(double[] values, double[] weights, int begin, int length, boolean allowEmpty) This method is used to verify that the begin and length parameters designate a subarray of positive length and the weights are all non-negative, non-NaN, finite, and not all zero.
static boolean	verifyValues(double[] values, int begin, int length, boolean allowEmpty)

Methods inherited from class java.lang.Object

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

Constructor Detail

Sum

public Sum()

Create a Sum instance

Method Detail

increment

public void increment(double d)

Updates the internal state of the statistic to reflect the addition of the new value.

Parameters:

d - the new value.

getResult

public double getResult()

Returns the current value of the Statistic.

Returns:

value of the statistic, Double.NaN if it has been cleared or just instantiated.

getN

public long getN()

clear

public void clear()

Clears the internal state of the Statistic

evaluate

public double evaluate(double[] values,
                       int begin,
                       int length)

The sum of the entries in the specified portion of the input array, or 0 if the designated subarray is empty.

Throws MathIllegalArgumentException if the array is null.

Parameters:

values - the input array

begin - index of the first array element to include

length - the number of elements to include

Returns:

the sum of the values or 0 if length = 0

Throws:

java.lang.NullPointerException - if the array is null

java.lang.IllegalStateException - if the array index parameters are not valid

evaluate

public double evaluate(double[] values,
                       double[] weights,
                       int begin,
                       int length)

The weighted sum of the entries in the specified portion of the input array, or 0 if the designated subarray is empty.

Throws MathIllegalArgumentException if any of the following are true:

• the values array is null
• the weights array is null
• the weights array does not have the same length as the values array
• the weights array contains one or more infinite values
• the weights array contains one or more NaN values
• the weights array contains negative values
• the start and length arguments do not determine a valid array

Uses the formula,

    weighted sum = Σ(values[i] * weights[i])
 

Parameters:

values - the input array

weights - the weights array

begin - index of the first array element to include

length - the number of elements to include

Returns:

the sum of the values or 0 if length = 0

Throws:

java.lang.IllegalStateException - if the parameters are not valid

evaluate

public double evaluate(double[] values,
                       double[] weights)

The weighted sum of the entries in the the input array.

Throws MathIllegalArgumentException if any of the following are true:

• the values array is null
• the weights array is null
• the weights array does not have the same length as the values array
• the weights array contains one or more infinite values
• the weights array contains one or more NaN values
• the weights array contains negative values

Uses the formula,

    weighted sum = Σ(values[i] * weights[i])
 

Parameters:

values - the input array

weights - the weights array

Returns:

the sum of the values or Double.NaN if length = 0

evaluate

public double evaluate(double[] values)

This default implementation calls clear(), then invokes increment(double) in a loop over the the input array, and then uses getResult() to compute the return value.

Note that this implementation changes the internal state of the statistic. Its side effects are the same as invoking clear() and then incrementAll(double[]).

Implementations may override this method with a more efficient and possibly more accurate implementation that works directly with the input array.

If the array is null, a MathIllegalArgumentException is thrown.

Parameters:

values - input array

Returns:

the value of the statistic applied to the input array

Throws:

java.lang.IllegalStateException - if values is null

incrementAll

public void incrementAll(double[] values)

This default implementation just calls increment(double) in a loop over the input array.

Throws IllegalArgumentException if the input values array is null.

Parameters:

values - values to add

Throws:

java.lang.NullPointerException - if values is null

incrementAll

public void incrementAll(double[] values,
                         int begin,
                         int length)

This default implementation just calls increment(double) in a loop over the specified portion of the input array.

Throws IllegalArgumentException if the input values array is null.

Parameters:

values - array holding values to add

begin - index of the first array element to add

length - number of array elements to add

Throws:

java.lang.NullPointerException - if values is null

equals

public boolean equals(java.lang.Object object)

Returns true iff object is an AbstractStorelessUnivariateStatistic returning the same values as this for getResult() and getN()

Overrides:

equals in class java.lang.Object

Parameters:

object - object to test equality against.

Returns:

true if object returns the same value as this

hashCode

public int hashCode()

Returns hash code based on getResult() and getN()

Overrides:

hashCode in class java.lang.Object

Returns:

hash code

equals

public static boolean equals(double x,
                             double y,
                             int maxUlps)

Returns true if both arguments are equal or within the range of allowed error (inclusive).

Two float numbers are considered equal if there are (maxUlps - 1) (or fewer) floating point numbers between them, i.e. two adjacent floating point numbers are considered equal.

Adapted from Bruce Dawson

Parameters:

x - first value

y - second value

maxUlps - is the number of floating point values between and .

Returns:

if there are fewer than floating point values between and .

setData

public void setData(double[] values)

Set the data array.

The stored value is a copy of the parameter array, not the array itself.

Parameters:

values - data array to store (may be null to remove stored data)

See Also:

evaluate()

getData

public double[] getData()

Get a copy of the stored data array.

Returns:

copy of the stored data array (may be null)

getDataRef

protected double[] getDataRef()

Get a reference to the stored data array.

Returns:

reference to the stored data array (may be null)

setData

public void setData(double[] values,
                    int begin,
                    int length)

Set the data array. The input array is copied, not referenced.

Parameters:

values - data array to store

begin - the index of the first element to include

length - the number of elements to include are not valid

See Also:

evaluate()

evaluate

public double evaluate()

Returns the result of evaluating the statistic over the stored data.

The stored array is the one which was set by previous calls to setData(double[]).

Returns:

the value of the statistic applied to the stored data

Throws:

java.lang.IllegalStateException - if the stored data array is null

test

protected boolean test(double[] values,
                       int begin,
                       int length)

This method is used by evaluate(double[], int, int) methods to verify that the input parameters designate a subarray of positive length.

• returns true iff the parameters designate a subarray of positive length
• throws MathIllegalArgumentException if the array is null or or the indices are invalid
• returns false if the array is non-null, but length is 0.

Parameters:

values - the input array

begin - index of the first array element to include

length - the number of elements to include

Returns:

true if the parameters are valid and designate a subarray of positive length

test

protected boolean test(double[] values,
                       int begin,
                       int length,
                       boolean allowEmpty)

This method is used by evaluate(double[], int, int) methods to verify that the input parameters designate a subarray of positive length.

• returns true iff the parameters designate a subarray of non-negative length
• throws IllegalArgumentException if the array is null or or the indices are invalid
• returns false if the array is non-null, but length is 0 unless allowEmpty is true

Parameters:

values - the input array

begin - index of the first array element to include

length - the number of elements to include

allowEmpty - if true then zero length arrays are allowed

Returns:

true if the parameters are valid

Throws:

java.lang.NullPointerException - or IllegalStateException if the indices are invalid or the array is null

test

protected boolean test(double[] values,
                       double[] weights,
                       int begin,
                       int length)

This method is used by evaluate(double[], double[], int, int) methods to verify that the begin and length parameters designate a subarray of positive length and the weights are all non-negative, non-NaN, finite, and not all zero.

• returns true iff the parameters designate a subarray of positive length and the weights array contains legitimate values.
• throws IllegalArgumentException if any of the following are true:
  • the values array is null
  • the weights array is null
  • the weights array does not have the same length as the values array
  • the weights array contains one or more infinite values
  • the weights array contains one or more NaN values
  • the weights array contains negative values
  • the start and length arguments do not determine a valid array
• returns false if the array is non-null, but length is 0.

Parameters:

values - the input array

weights - the weights array

begin - index of the first array element to include

length - the number of elements to include

Returns:

true if the parameters are valid and designate a subarray of positive length

Throws:

java.lang.NullPointerException - or java.lang.IllegalStateException if the indices are invalid or the array is null

verifyValues

public static boolean verifyValues(double[] values,
                                   double[] weights,
                                   int begin,
                                   int length,
                                   boolean allowEmpty)

This method is used to verify that the begin and length parameters designate a subarray of positive length and the weights are all non-negative, non-NaN, finite, and not all zero.

• returns true iff the parameters designate a subarray of non-negative length and the weights array contains legitimate values.
• throws MathIllegalArgumentException if any of the following are true:
  • the values array is null
  • the weights array is null
  • the weights array does not have the same length as the values array
  • the weights array contains one or more infinite values
  • the weights array contains one or more NaN values
  • the weights array contains negative values
  • the start and length arguments do not determine a valid array
• returns false if the array is non-null, but length is 0 unless allowEmpty is true.

Parameters:

values - the input array.

weights - the weights array.

begin - index of the first array element to include.

length - the number of elements to include.

allowEmpty - if true than allow zero length arrays to pass.

Returns:

true if the parameters are valid.

Throws:

java.lang.NullPointerException - if either of the arrays are null

java.lang.IllegalStateException - if the array indices are not valid, the weights array contains NaN, infinite or negative elements, or there are no positive weights.

test

protected boolean test(double[] values,
                       double[] weights,
                       int begin,
                       int length,
                       boolean allowEmpty)

This method is used by evaluate(double[], double[], int, int) methods to verify that the begin and length parameters designate a subarray of positive length and the weights are all non-negative, non-NaN, finite, and not all zero.

• returns true iff the parameters designate a subarray of non-negative length and the weights array contains legitimate values.
• throws MathIllegalArgumentException if any of the following are true:
  • the values array is null
  • the weights array is null
  • the weights array does not have the same length as the values array
  • the weights array contains one or more infinite values
  • the weights array contains one or more NaN values
  • the weights array contains negative values
  • the start and length arguments do not determine a valid array
• returns false if the array is non-null, but length is 0 unless allowEmpty is true.

Parameters:

values - the input array.

weights - the weights array.

begin - index of the first array element to include.

length - the number of elements to include.

allowEmpty - if true than allow zero length arrays to pass.

Returns:

true if the parameters are valid.

Throws:

java.lang.NullPointerException - if either of the arrays are null

java.lang.IllegalStateException - if the array indices are not valid, the weights array contains NaN, infinite or negative elements, or there are no positive weights.

verifyValues

public static boolean verifyValues(double[] values,
                                   int begin,
                                   int length,
                                   boolean allowEmpty)