com.xj.anylogic.engine.analysis
Class StatisticsDiscrete

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

All Implemented Interfaces:

java.io.Serializable

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

Statistics on a series of data samples of type double. Compared to StatisticsContinuous, data samples here have no relation to time (like e.g. products cost or patients LOS).

Author:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Serialized Form

Constructor Summary

StatisticsDiscrete()
Creates a discrete statistics.

StatisticsDiscrete(DataUpdater updater)
Creates a discrete statistics.

Method Summary

void	add(double value) Adds a sample value to the statistics.
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 standard deviation of the statistics.
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, or 0 if no samples have been added.
double	meanConfidence() Returns the mean confidence interval of the statistics, or 0 if no samples have been added.
double	min() Returns the minimum sample value, or Double.POSITIVE_INFINITY if no samples have been added.
void	reset() Discards all statistics accumulated.
double	sum() The method returns sum of the samples added to the statistics, or 0 if no samples have been added.
java.lang.String	toString() Returns the tab-separated multiline textual representation of the statistics.
void	update() Should be overridden and call add( val ) if the user has specified the value.
double	variance() Returns the variance of the statistics, or 0 if less than 2 samples have been added.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticsDiscrete

public StatisticsDiscrete()

Creates a discrete statistics.

StatisticsDiscrete

public StatisticsDiscrete(DataUpdater updater)

Creates a discrete 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, or 0 if no samples have been added.

Returns:

the mean of the statistics, or 0

variance

public double variance()

Returns the variance of the statistics, or 0 if less than 2 samples have been added.

Returns:

the variance of the statistics, or 0

deviation

public double deviation()

Returns the standard deviation of the statistics.

Returns:

the standard deviation of the statistics

meanConfidence

public double meanConfidence()

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

Returns:

the mean confidence interval of the statistics, or 0

sum

public double sum()

The method returns sum of the samples added to the statistics, or 0 if no samples have been added.

Returns:

sum of the samples add to the statistics, or 0

reset

public void reset()

Discards all statistics accumulated.

add

public void add(double value)

Adds a sample value to the statistics.

Parameters:

value - the value being added

update

public void update()

Should be overridden and call add( val ) 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.

Overrides:

toString in class java.lang.Object

Returns:

the tab-separated textual representation of the statistics