Package microsim.statistics.functions

Class AbstractArrayFunction

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.functions.AbstractArrayFunction

All Implemented Interfaces:

EventListener, UpdatableSource

Direct Known Subclasses:

CountArrayFunction, MaxArrayFunction, MeanArrayFunction, MeanVarianceArrayFunction, MinArrayFunction, MovingAverageArrayFunction, PercentileArrayFunction, SumArrayFunction

public abstract class AbstractArrayFunction
extends AbstractFunction

This class represents the skeleton for all the function which operate on array of native data type values. Each inheriting class automatically implements the UpdatableSource and the EventListener which are managed by the AbstractArrayFunction.

Field Summary

Fields

Modifier and Type	Field	Description
protected DoubleArraySource	dblSource
protected IntArraySource	intSource
protected LongArraySource	lngSource
protected int	type
protected static final int	TYPE_DBL
protected static final int	TYPE_INT
protected static final int	TYPE_LNG

Fields inherited from class microsim.statistics.functions.AbstractFunction

timeChecker

Constructor Summary

Constructors

Constructor	Description
AbstractArrayFunction(@NonNull DoubleArraySource source)	Creates a function on a double array source.
AbstractArrayFunction(@NonNull IntArraySource source)	Creates a function on an integer array source.
AbstractArrayFunction(@NonNull LongArraySource source)	Creates a function on a long array source.

Method Summary

Modifier and Type	Method	Description
void	apply(double[] data)	Applies the function to the given array of double values.
void	apply(int[] data)	Applies the function to the given array of integer values.
void	apply(long[] data)	Applies the function to the given array of long values.
void	applyFunction()	Forces the function to update itself.

Methods inherited from class microsim.statistics.functions.AbstractFunction

isCheckingTime, onEvent, setCheckingTime, updateSource

Methods inherited from class java.lang.Object

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

Field Details

TYPE_DBL

protected static final int TYPE_DBL

See Also:

• Constant Field Values

TYPE_INT

protected static final int TYPE_INT

See Also:

• Constant Field Values

TYPE_LNG

protected static final int TYPE_LNG

See Also:

• Constant Field Values

dblSource

protected DoubleArraySource dblSource

intSource

protected IntArraySource intSource

lngSource

protected LongArraySource lngSource

type

protected int type

Constructor Details

AbstractArrayFunction

public AbstractArrayFunction(@NonNull
 @NonNull DoubleArraySource source)

Creates a function on a double array source.

Parameters:

source - The data source.

Throws:

NullPointerException - when source is null.

AbstractArrayFunction

public AbstractArrayFunction(@NonNull
 @NonNull IntArraySource source)

Creates a function on an integer array source.

Parameters:

source - The data source.

Throws:

NullPointerException - when source is null.

AbstractArrayFunction

public AbstractArrayFunction(@NonNull
 @NonNull LongArraySource source)

Creates a function on a long array source.

Parameters:

source - The data source.

Throws:

NullPointerException - when source is null.

Method Details

applyFunction

public void applyFunction()

Forces the function to update itself. If the data source implements the UpdatableSource interface it is updated before reading data.

Specified by:

applyFunction in class AbstractFunction

apply

public void apply(double[] data)

Applies the function to the given array of double values.

Parameters:

data - A source array of values.

Throws:

UnsupportedOperationException - If the function is not able to work on double data type.

apply

public void apply(int[] data)

Applies the function to the given array of integer values.

Parameters:

data - A source array of values.

Throws:

UnsupportedOperationException - If the function is not able to work on double data type.

apply

public void apply(long[] data)

Applies the function to the given array of long values.

Parameters:

data - A source array of values.

Throws:

UnsupportedOperationException - If the function is not able to work on double data type.