ikr.simlib.statistics.probability

Class CondProbabilityStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.probability.CondProbabilityStatistic

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

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

CondProbabilityStatistic is derived from StdProbabilityStatistic and offers the possibility to obtain a probability 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. CondProbabilityStatistic has three constructors: one using LinBucketUtility, one using LogBucketUtility and 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 CondProbabilityStatistic 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)

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 StdProbabilityStatistic	overallStatistic
protected ikr.simlib.statistics.probability.CondProbabilityStatistic.ProbabilityBucket[]	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

Modifier	Constructor and Description
protected	CondProbabilityStatistic(BucketUtility bucketUtility, SimNode ownNode) Creates the probability statistic using a user-defined BucketUtility as conditioner.
	CondProbabilityStatistic(double min, double max, int noOfBuckets, SimNode ownNode) Creates the probability statistic using a LinBucketUtility as conditioner.

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
static CondProbabilityStatistic	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
double	getConfidenceInterval(int index)
double	getMean(int index)
void	resetBatchStatistic() only between batches
void	resetStatistic() reset complete statistic
void	update(double condentiator, int number, boolean isSpecial)

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 StdProbabilityStatistic overallStatistic

statistics

protected final ikr.simlib.statistics.probability.CondProbabilityStatistic.ProbabilityBucket[] statistics

bucketUtility

protected final BucketUtility bucketUtility

Constructor Detail

CondProbabilityStatistic

protected CondProbabilityStatistic(BucketUtility bucketUtility,
                        SimNode ownNode)

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

See Also:

LinBucketUtility, LogBucketUtility

CondProbabilityStatistic

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

Creates the probability statistic using a LinBucketUtility as conditioner.

Method Detail

createInstance

public static CondProbabilityStatistic createInstance(SimNode ownNode,
                                      Parameters pars)

as required by ReflectionConstructable

computeMeasures

public void computeMeasures(int batchNumber)

Specified by:

computeMeasures in class Statistic

update

public void update(double condentiator,
          int number,
          boolean isSpecial)

resetStatistic

public void resetStatistic()

Description copied from class: Statistic

reset complete statistic

Specified by:

resetStatistic in class Statistic

resetBatchStatistic

public void resetBatchStatistic()

Description copied from class: Statistic

only between batches

Specified by:

resetBatchStatistic in class Statistic

getMean

public double getMean(int index)

getConfidenceInterval

public double getConfidenceInterval(int index)