Package microsim.statistics.weighted.functions

Class AbstractWeightedArrayFunction

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.weighted.functions.AbstractWeightedArrayFunction

All Implemented Interfaces:

EventListener, UpdatableSource

Direct Known Subclasses:

Weighted_MeanArrayFunction, Weighted_SumArrayFunction

public abstract class AbstractWeightedArrayFunction
extends AbstractFunction

This class represents the skeleton for all the function which operate on array of native data type values, appropriately weighted by weights specified in a corresponding array of doubles. Each inheriting class automatically implements the UpdatableSource and the EventListener, which are managed by the AbstractWeightedArrayFunction.

Field Summary

Fields

Modifier and Type	Field	Description
protected WeightedDoubleArraySource	dblSource
protected WeightedIntArraySource	intSource
protected WeightedLongArraySource	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
AbstractWeightedArrayFunction(@NonNull WeightedDoubleArraySource source)	Create a function on a double array source.
AbstractWeightedArrayFunction(@NonNull WeightedIntArraySource source)	Create a function on an integer array source.
AbstractWeightedArrayFunction(@NonNull WeightedLongArraySource source)	Create a function on a long array source.

Method Summary

Modifier and Type	Method	Description
void	apply(double @NonNull [] data, double @NonNull [] weights)	Apply the function to the given array of double values.
void	apply(int @NonNull [] data, double @NonNull [] weights)	Apply the function to the given array of integer values.
void	apply(long @NonNull [] data, double @NonNull [] weights)	Apply the function to the given array of long values.
void	applyFunction()	Force 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 WeightedDoubleArraySource dblSource

intSource

protected WeightedIntArraySource intSource

lngSource

protected WeightedLongArraySource lngSource

type

protected int type

Constructor Details

AbstractWeightedArrayFunction

public AbstractWeightedArrayFunction(@NonNull
 @NonNull WeightedDoubleArraySource source)

Create a function on a double array source.

Parameters:

source - The data source.

AbstractWeightedArrayFunction

public AbstractWeightedArrayFunction(@NonNull
 @NonNull WeightedIntArraySource source)

Create a function on an integer array source.

Parameters:

source - The data source.

AbstractWeightedArrayFunction

public AbstractWeightedArrayFunction(@NonNull
 @NonNull WeightedLongArraySource source)

Create a function on a long array source.

Parameters:

source - The data source.

Method Details

applyFunction

public void applyFunction()

Force 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 @NonNull [] data,
 double @NonNull [] weights)

Apply the function to the given array of double values.

Parameters:

data - A source array of values.

weights - An array of weights.

Throws:

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

apply

public void apply(int @NonNull [] data,
 double @NonNull [] weights)

Apply the function to the given array of integer values.

Parameters:

data - A source array of values.

weights - An array of weights.

Throws:

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

apply

public void apply(long @NonNull [] data,
 double @NonNull [] weights)

Apply the function to the given array of long values.

Parameters:

data - A source array of values.

weights - An array of weights.

Throws:

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