Package jasima.core.statistics

Class TimeWeightedSummaryStat

java.lang.Object

jasima.core.statistics.SummaryStat

jasima.core.statistics.TimeWeightedSummaryStat

All Implemented Interfaces:

Serializable, Cloneable

public class TimeWeightedSummaryStat
extends SummaryStat

A SummaryStat which weights values according to the time. As result statistics the values returned by SummaryStat.mean(), min(), and max() have defined values.

Author:

Torsten Hildebrandt

See Also:

Serialized Form

Field Summary

Fields inherited from class jasima.core.statistics.SummaryStat

DEF_ERROR_PROB, lastValue, lastWeight

Constructor Summary

Constructors

Constructor	Description
TimeWeightedSummaryStat()	Constructs a new instance with lastTime and lastValue initialized with 0.
TimeWeightedSummaryStat(TimeWeightedSummaryStat s)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Resets this object.
TimeWeightedSummaryStat	clone()	Clones this object.
double	lastTime()	Returns the current value of the attribute lastTime.
double	max()	Returns the maximum value seen so far.
double	min()	Returns the minimum value seen so far.
TimeWeightedSummaryStat	value(double v)	Don't use this method as it doesn't make sense for a TimeWeightedSummaryStat.
TimeWeightedSummaryStat	value(double value, double time)	Adds a new value, weighted by the difference between time and lastTime().
double	variance()	Returns the sample variance of the values.
double	variancePopulation()	Returns the population variance of the values.

Methods inherited from class jasima.core.statistics.SummaryStat

combine, combine, confidenceIntervalLower, confidenceIntervalLower, confidenceIntervalUpper, confidenceIntervalUpper, confIntRangeSingle, lastValue, lastWeight, mean, numObs, stdDev, sum, summarize, summarize, values, varCoeff, weightSum

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeWeightedSummaryStat

public TimeWeightedSummaryStat()

Constructs a new instance with lastTime and lastValue initialized with 0.

TimeWeightedSummaryStat

public TimeWeightedSummaryStat(TimeWeightedSummaryStat s)

Copy constructor.

Parameters:

s - The object to copy.

Method Detail

clear

public void clear()

Description copied from class: SummaryStat

Resets this object.

Overrides:

clear in class SummaryStat

value

public TimeWeightedSummaryStat value(double value,
                                     double time)

Adds a new value, weighted by the difference between time and lastTime(). time is then saved for the next invocation of this method.

Overrides:

value in class SummaryStat

Parameters:

value - Value of some state variable from the point in time given as the second parameter.

time - The point in time from which the current value is value

Returns:

this to allow easy chaining of calls.

value

public TimeWeightedSummaryStat value(double v)

Don't use this method as it doesn't make sense for a TimeWeightedSummaryStat. Raises an UnsupportedOperationException when called.

Overrides:

value in class SummaryStat

Parameters:

v - ignored

Returns:

TimeWeightedSummaryStat ignored

min

public double min()

Description copied from class: SummaryStat

Returns the minimum value seen so far.

Overrides:

min in class SummaryStat

Returns:

The minimum value seen so far, or NaN, if no values were given so far.

max

public double max()

Description copied from class: SummaryStat

Returns the maximum value seen so far.

Overrides:

max in class SummaryStat

Returns:

The maximum value seen so far, or NaN, if no values were given so far.

variance

public double variance()

Description copied from class: SummaryStat

Returns the sample variance of the values.

Overrides:

variance in class SummaryStat

Returns:

The (sample) variance of all values given to SummaryStat.value(double). Returns NaN, if no values were added yet.

variancePopulation

public double variancePopulation()

Description copied from class: SummaryStat

Returns the population variance of the values.

Overrides:

variancePopulation in class SummaryStat

Returns:

The (sample) variance of all values given to SummaryStat.value(double). Returns NaN, if no values were added yet.

lastTime

public double lastTime()

Returns the current value of the attribute lastTime.

Returns:

The last point in time for which value(double, double) was called.

See Also:

SummaryStat.lastValue()

clone

public TimeWeightedSummaryStat clone()

Description copied from class: SummaryStat

Clones this object. We can use the standard functionality here, as there are only primitive fields.

Overrides:

clone in class SummaryStat

Returns:

A clone of this SummaryStat.