Package microsim.statistics.functions

Class MultiTraceFunction

java.lang.Object

microsim.statistics.functions.MultiTraceFunction

All Implemented Interfaces:

EventListener, DoubleSource, UpdatableSource

Direct Known Subclasses:

MultiTraceFunction.Double, MultiTraceFunction.Integer, MultiTraceFunction.Long

public abstract class MultiTraceFunction
extends Object
implements DoubleSource, UpdatableSource, EventListener

A MixFunction object is to collect data over time, computing some statistics on the fly, without storing the data in memory. It is particularly useful when the user need to compute basic statistics on data sources, without affecting the memory occupancy. The memoryless series computes automatically the statistics using accumulation variables and counters.
This statistic computer should be used when possible, particularly when the simulation model has to run for a long time, condition which implies the growth of the memory occupancy. Moreover, the Memoryless Series objects are much faster than the Series one, because they pre-compute the statistics operation step by step. Trying to compute a mean of a Series object, force the Mean function to sum all the values, every time series is updated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiTraceFunction.Double	An implementation of the Memoryless Series class, which manages double type data sources.
static class	MultiTraceFunction.Integer	An implementation of the Memoryless Series class, which manages integer type data sources.
static class	MultiTraceFunction.Long	An implementation of the Memoryless Series class, which manages long type data sources.
static enum	MultiTraceFunction.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected int	count

Constructor Summary

Constructors

Constructor	Description
MultiTraceFunction()

Method Summary

Modifier and Type	Method	Description
int	getCount()
double	getDoubleValue(@NonNull Enum<?> valueID)	Computes one of the available statistical functions on the collected data.
abstract double	getMean()
abstract double	getVariance()
void	onEvent(@NonNull Enum<?> type)	EventListener callback function.
void	updateSource()	Collects a value from the source.

Methods inherited from class java.lang.Object

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

Field Details

count

protected int count

Constructor Details

MultiTraceFunction

public MultiTraceFunction()

Method Details

updateSource

public void updateSource()

Collects a value from the source.

Specified by:

updateSource in interface UpdatableSource

getMean

public abstract double getMean()

getVariance

public abstract double getVariance()

getCount

public int getCount()

onEvent

public void onEvent(@NonNull
 @NonNull Enum<?> type)

EventListener callback function. It supports only CommonEventType.UPDATE event.

Specified by:

onEvent in interface EventListener

Parameters:

type - The action id. Only CommonEventType.UPDATE is supported.

Throws:

SimulationRuntimeException - If actionType is not supported.

NullPointerException - when type is null.

getDoubleValue

public double getDoubleValue(@NonNull
 @NonNull Enum<?> valueID)

Computes one of the available statistical functions on the collected data.

Specified by:

getDoubleValue in interface DoubleSource

Parameters:

valueID - A unique identifier for a variable.

Returns:

The current double value of the required variable.

Throws:

NullPointerException - when valueID is null.

UnsupportedOperationException - when valueID is of not supported type.