StatisticsDiscrete (AnyLogic 8 Engine API)

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

All Implemented Interfaces:

java.io.Serializable
```
public class StatisticsDiscrete
extends com.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:

AnyLogic North America, LLC https://anylogic.com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StatisticsDiscrete()
Creates a discrete statistics.

StatisticsDiscrete(DataUpdater_xjal updater)
Creates a discrete statistics.

Constructors
Constructor and Description
`StatisticsDiscrete()` Creates a discrete statistics.
`StatisticsDiscrete(DataUpdater_xjal updater)` Creates a discrete statistics.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(double value)` Adds a sample value to the statistics.
`int`	`count()` Returns the number of samples added to the statistics.
`void`	`destroyUpdater_xjal()` This method is used to 'disconnect' this data class from the agent/experiment this object was defined in.
`double`	`deviation()` Returns the standard deviation of the statistics.
`double`	`max()` Returns the maximum sample value, or `-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 `+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_xjal updater)
```
    Creates a discrete statistics.
    
    Parameters:
    
    updater - updater which may be used instead of overriding update() method
- Method Detail
  - destroyUpdater_xjal
```
@AnyLogicInternalCodegenAPI
public void destroyUpdater_xjal()
```
    This method is used to 'disconnect' this data class from the agent/experiment this object was defined in.
    It is usually called on agent 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 +infinity if no samples have been added.
    
    Returns:
    
    the minimum sample value or +infinity
  - max
```
public double max()
```
    Returns the maximum sample value, or -infinity if no samples have been added.
    
    Returns:
    
    the maximum sample value or -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. Returns +infinity if only one sample has been added so far
    Interval is calculated for the confidence level of 95%.
    
    Returns:
    
    the mean confidence interval of the statistics, or 0, or +infinity
  - 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

Class StatisticsDiscrete

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StatisticsDiscrete

StatisticsDiscrete

Method Detail

destroyUpdater_xjal

count

min

max

mean

variance

deviation

meanConfidence

sum

reset

add

update

toString