org.geotoolkit.math
Class Statistics.Delta

Object
  Statistics
      Statistics.Delta

All Implemented Interfaces:

Serializable, Cloneable

Enclosing class:

Statistics

public static class Statistics.Delta
extends Statistics

Holds some statistics about a series of sample values and the difference between them. Given a series of sample values s₀, s₁, s₂, s₃..., this class computes statistics in the same way than Statistics and additionally computes statistics for s₁-s₀, s₂-s₁, s₃-s₂..., which are stored in a delta statistics object.

Since:

1.0

Version:

3.00

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Statistics

Statistics.Delta

Constructor Summary

Statistics.Delta()
Constructs an initially empty set of statistics.

Statistics.Delta(Statistics delta)
Constructs an initially empty set of statistics using the specified object for delta statistics.

Method Summary

void	add(double sample) Updates statistics for the specified sample.
void	add(long sample) Updates statistics for the specified sample.
void	add(Statistics stats) Update statistics with all samples from the specified stats.
Statistics.Delta	clone() Returns a clone of this statistics.
boolean	equals(Object obj) Tests this statistics with the specified object for equality.
Statistics	getDeltaStatistics() Returns the statistics about difference between consecutives values.
int	hashCode() Returns a hash code value for this statistics.
void	reset() Resets the statistics to their initial NaN values.

Methods inherited from class Statistics

configure, count, countNaN, getNumberFormat, maximum, mean, minimum, printTable, range, rms, standardDeviation, sum, toString, toString, writeTable

Methods inherited from class Object

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

Constructor Detail

Statistics.Delta

public Statistics.Delta()

Constructs an initially empty set of statistics. All statistical values are initialized to Double.NaN.

Statistics.Delta

public Statistics.Delta(Statistics delta)

Constructs an initially empty set of statistics using the specified object for delta statistics. This method allows chaining different kind of statistics objects. For example, one could write:

new Statistics.Delta(new Statistics.Delta());

Which would compute statistics of sample values, statistics of difference between consecutive sample values, and statistics of difference of difference between consecutive sample values. Other kinds of Statistics object could be chained as well.

Parameters:

delta - The object where to stores delta statistics.

Method Detail

getDeltaStatistics

public Statistics getDeltaStatistics()

Returns the statistics about difference between consecutives values. Given a series of sample values s₀, s₁, s₂, s₃..., this is statistics for s₁-s₀, s₂-s₁, s₃-s₂...,

Returns:

The object where delta statistics are stored.

reset

public void reset()

Resets the statistics to their initial NaN values. This method reset this object state as if it was just created.

Overrides:

reset in class Statistics

add

public void add(double sample)

Updates statistics for the specified sample. The delta statistics are updated with sample - samplelast value, where samplelast is the last value given to the previous call of an add(...) method.

Overrides:

add in class Statistics

Parameters:

sample - The sample value. NaN values are ignored.

See Also:

Statistics.add(long), Statistics.add(Statistics)

add

public void add(long sample)

Updates statistics for the specified sample. The delta statistics are updated with sample - samplelast value, where samplelast is the last value given to the previous call of an add(...) method.

Overrides:

add in class Statistics

Parameters:

sample - The sample value.

See Also:

Statistics.add(double), Statistics.add(Statistics)

add

public void add(Statistics stats)
         throws ClassCastException

Update statistics with all samples from the specified stats. Invoking this method is equivalent (except for rounding errors) to invoking add for all samples that were added to stats. The stats argument must be an instance of Statistics.Delta.

Overrides:

add in class Statistics

Parameters:

stats - The statistics to be added to this, or null if none.

Throws:

ClassCastException - If stats is not an instance of Statistics.Delta.

clone

public Statistics.Delta clone()

Returns a clone of this statistics.

Overrides:

clone in class Statistics

Returns:

A clone of this statistics.

See Also:

Object.clone()

equals

public boolean equals(Object obj)

Tests this statistics with the specified object for equality.

Overrides:

equals in class Statistics

Parameters:

obj - The object to compare with.

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Returns a hash code value for this statistics.

Overrides:

hashCode in class Statistics