com.xj.anylogic.engine.analysis
Class StatisticsContinuous

java.lang.Object
  com.xj.anylogic.engine.internal.CSVDataProvider
      com.xj.anylogic.engine.analysis.StatisticsContinuous

All Implemented Interfaces:

java.io.Serializable

public class StatisticsContinuous
extends com.xj.anylogic.engine.internal.CSVDataProvider
implements java.io.Serializable

Statistics on a value that persists in continuous time but changes only at discrete time moments (like e.g. queue length). The samples must be added to this statistics with ascending time stamps. The mean, variance, etc. methods assume the last value adde holds until the time of call.

Author:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Serialized Form

Constructor Summary

StatisticsContinuous()
Creates a continuous statistics.

StatisticsContinuous(DataUpdater updater)
Creates a continuous statistics.

Method Summary

void	add(double value, double time) Adds a new data sample to the statistics, i.e. notifies the statistics about the value change at the given time.
int	count() Returns the number of samples added to the statistics.
void	destroyUpdater() This method is used to 'disconnect' this data class from the active object/experiment this object was defined in.
double	deviation() Returns the deviation of the statistics at the time of last update.
double	deviation(double time) Returns the standard deviation of the statistics at the given time assuming the last value added holds until the given time.
double	integral() Returns the mean integral of the statistics at the time of last update, or 0 if no samples have been added.
double	integral(double time) Returns the integral of the statistics at the given time assuming the last value added holds until the given time, or 0 if no samples have been added.
double	max() Returns the maximum sample value, or Double.NEGATIVE_INFINITY if no samples have been added.
double	mean() Returns the mean of the statistics at the time of last update, or 0 if no samples have been added.
double	mean(double time) Returns the mean of the statistics at the given time assuming the last value added holds until the given time, or 0 if no samples have been added.
double	meanConfidence() Returns the mean confidence of the statistics at the time of last update, or 0 if no samples have been added.
double	meanConfidence(double time) Returns the mean confidence interval of the statistics at the given time assuming the last value added holds until the given time, or Double.POSITIVE_INFINITY if less than 2 samples have been added or if no time has elapsed.
double	min() Returns the minimum sample value, or Double.POSITIVE_INFINITY if no samples have been added.
void	reset() Discards all statistics accumulated.
java.lang.String	toString() Returns the tab-separated multiline textual representation of the statistics corresponding to the time of last update.
void	update() Should be overridden and call add( val, time() ) if the user has specified the value.
double	variance() Returns the variance of the statistics at the time of last update, or 0 if no samples have been added.
double	variance(double time) Returns the variance of the statistics at the given time assuming the last value added holds until the given time, or 0 if no samples have been added.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StatisticsContinuous

public StatisticsContinuous()

Creates a continuous statistics.

StatisticsContinuous

public StatisticsContinuous(DataUpdater updater)

Creates a continuous statistics.

Parameters:

updater - updater which may be used instead of overriding update() method

Method Detail

destroyUpdater

public void destroyUpdater()

This method is used to 'disconnect' this data class from the active object/experiment this object was defined in.
It is usually called on active object destroy so that experiment could use this data object e.g. in its charts.

count

public int count()

Returns the number of samples added to the statistics.

Returns:

the number of samples added to the statistics.

min

public double min()

Returns the minimum sample value, or Double.POSITIVE_INFINITY if no samples have been added.

Returns:

the minimum sample value or Double.POSITIVE_INFINITY

max

public double max()

Returns the maximum sample value, or Double.NEGATIVE_INFINITY if no samples have been added.

Returns:

the maximum sample value or Double.NEGATIVE_INFINITY

mean

public double mean()

Returns the mean of the statistics at the time of last update, or 0 if no samples have been added.

Returns:

the mean of the statistics at the time of last update, or 0

mean

public double mean(double time)

Returns the mean of the statistics at the given time assuming the last value added holds until the given time, or 0 if no samples have been added.

Parameters:

time - the time

Returns:

the mean of the statistics, or 0

variance

public double variance()

Returns the variance of the statistics at the time of last update, or 0 if no samples have been added.

Returns:

the variance of the statistics at the time of last update, or 0

variance

public double variance(double time)

Returns the variance of the statistics at the given time assuming the last value added holds until the given time, or 0 if no samples have been added.

Parameters:

time - the time

Returns:

the variance of the statistics, or 0

deviation

public double deviation()

Returns the deviation of the statistics at the time of last update.

Returns:

the deviation of the statistics at the time of last update

deviation

public double deviation(double time)

Returns the standard deviation of the statistics at the given time assuming the last value added holds until the given time.

Parameters:

time - the time

Returns:

the standard deviation of the statistics

meanConfidence

public double meanConfidence()

Returns the mean confidence of the statistics at the time of last update, or 0 if no samples have been added.
Interval is calculated for the confidence level of 95%.

Returns:

the mean confidence of the statistics at the time of last update, or 0

meanConfidence

public double meanConfidence(double time)

Returns the mean confidence interval of the statistics at the given time assuming the last value added holds until the given time, or Double.POSITIVE_INFINITY if less than 2 samples have been added or if no time has elapsed.
Interval is calculated for the confidence level of 95%.

Parameters:

time - the time

Returns:

the mean confidence interval of the statistics, or 0

integral

public double integral()

Returns the mean integral of the statistics at the time of last update, or 0 if no samples have been added.

Returns:

the mean integral of the statistics at the time of last update, or 0

integral

public double integral(double time)

Returns the integral of the statistics at the given time assuming the last value added holds until the given time, or 0 if no samples have been added.

Parameters:

time - the time

Returns:

the integral of the statistics

reset

public void reset()

Discards all statistics accumulated.

add

public void add(double value,
                double time)

Adds a new data sample to the statistics, i.e. notifies the statistics about the value change at the given time.

Parameters:

value - the new value

time - the time

update

public void update()

Should be overridden and call add( val, time() ) if the user has specified the value. By default does nothing or uses updater if was created with appropriate constructor.

toString

public java.lang.String toString()

Returns the tab-separated multiline textual representation of the statistics corresponding to the time of last update.

Overrides:

toString in class java.lang.Object

Returns:

the tab-separated textual representation of the statistics