ikr.simlib.statistics.sample

Class CondMeanStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.sample.CondMeanStatistic

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

public class CondMeanStatistic
extends Statistic
implements ReflectionConstructable2<SimNode,Parameters>

CondMeanStatistic is derived from StdSampleStatistic and offers the possibility to obtain a mean value statistic conditioned on a value (conditioner). The calculation of the bucket widths and the access to the buckets is controlled by a derived class of BucketUtility. CondMeanStatistic has three constructors: one using LinBucketUtility, one using LogBucketUtility and one constructor using default and either LinBucketUtility or LogBucketUtility, depending on the value set as default for meanBucketSize. Upon construction the parameters minimum value, maximum value and number of buckets are required for the first two constructors and are passed to a derived class of BucketUtility. As LogBucketUtility additionally requires a mean value for the bucket size, this parameter is also required upon construction of CondMeanStatistic using buckets of logarithms growing size. The third constructor needs no special parameters besides name and owner.

The following functions are available for evaluation:

• Value of mean getMean(int)
• Value of standard deviation getDeviation(int)
• Value of coefficient of variation of all batches getCoefficient(int)
• Value of confidence interval to coefficient of variation getMeanConfidenceInterval(int)
• Value of confidence interval of standard deviation getDeviationConfidenceInterval(int)
• Value of confidence interval of coefficient of variance getCoefficientConfidenceInterval(int)
• Value of maximum sample of all batches getMaximum(int)
• Value of minimum sample of all batches getMinimum(int)

For printing the results it defines the following keywords:

ubound

Upper bound of the respective bucket

lbound

Lower bound of the respective bucket

bucketmean

Mean value of the respective bucket

cintbucket

Confidence interval to mean value in +/- notation

Field Summary

Fields

Modifier and Type	Field and Description
protected BucketUtility	bucketUtility
protected StdSampleStatistic	overallStatistic
protected ikr.simlib.statistics.sample.CondMeanStatistic.ConditionalBucket[]	statistics

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Fields inherited from interface ikr.simlib.parameters.reflection.ReflectionConstructable

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
CondMeanStatistic(double min, double max, int noOfBuckets, SimNode ownNode) Creates the mean value statistic using a LinBucketUtility as conditioner.
CondMeanStatistic(SimNode ownNode, BucketUtility bucketUtility) Creates the mean value statistic using a user-defined BucketUtility as conditioner.

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
static CondMeanStatistic	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
double	getCoefficient(int index)
double	getCoefficientConfidenceInterval(int index)
double	getDeviation(int index)
double	getDeviationConfidenceInterval(int index)
double	getMaximum(int index)
double	getMean(int index)
double	getMeanConfidenceInterval(int index)
double	getMinimum(int index)
void	resetBatchStatistic() only between batches
void	resetStatistic() reset complete statistic
void	update(double condentiator, double sample)

Methods inherited from class ikr.simlib.statistics.Statistic

addResultTag, addResultTag, disableTracing, enableTracing, handleInitSimulation, handleStartBatch, handleStartTransientPhase, handleStopBatch, handleStopTransientPhase, printComments, update, writeTraceEntry

Methods inherited from class java.lang.Object

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

Field Detail

overallStatistic

protected final StdSampleStatistic overallStatistic

statistics

protected final ikr.simlib.statistics.sample.CondMeanStatistic.ConditionalBucket[] statistics

bucketUtility

protected final BucketUtility bucketUtility

Constructor Detail

CondMeanStatistic

public CondMeanStatistic(SimNode ownNode,
                 BucketUtility bucketUtility)

Creates the mean value statistic using a user-defined BucketUtility as conditioner.

See Also:

LinBucketUtility, LogBucketUtility

CondMeanStatistic

public CondMeanStatistic(double min,
                 double max,
                 int noOfBuckets,
                 SimNode ownNode)

Creates the mean value statistic using a LinBucketUtility as conditioner.

Method Detail

createInstance

public static CondMeanStatistic createInstance(SimNode ownNode,
                               Parameters pars)

as required by ReflectionConstructable

computeMeasures

public void computeMeasures(int batchNumber)

Specified by:

computeMeasures in class Statistic

resetBatchStatistic

public void resetBatchStatistic()

Description copied from class: Statistic

only between batches

Specified by:

resetBatchStatistic in class Statistic

resetStatistic

public void resetStatistic()

Description copied from class: Statistic

reset complete statistic

Specified by:

resetStatistic in class Statistic

update

public void update(double condentiator,
          double sample)

getMean

public double getMean(int index)

getDeviation

public double getDeviation(int index)

getCoefficient

public double getCoefficient(int index)

getMeanConfidenceInterval

public double getMeanConfidenceInterval(int index)

getDeviationConfidenceInterval

public double getDeviationConfidenceInterval(int index)

getCoefficientConfidenceInterval

public double getCoefficientConfidenceInterval(int index)

getMaximum

public double getMaximum(int index)

getMinimum

public double getMinimum(int index)