ikr.simlib.statistics.distribution

Class DistributionStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.distribution.DistributionStatistic

All Implemented Interfaces:

Printable

Direct Known Subclasses:

StdDistributionStatistic

public abstract class DistributionStatistic
extends Statistic
implements Printable

The classes DistributionStatistic or StdDistributionStatistic serve to record measured values with the goal of determining a discrete distribution (histogram). The measured values recorded with update(double, double) are qualified using a raster, that is composed of an upper limit value and a lower limit value as well as the number of partial sections in between. The parameters for the raster must be declared upon constructor call. Additional to a measured value, a weight (with default 1) that is multiplyed with the value can be passed with update(double).

The following functions are available for evaluation:

• Number of partial sections (getArraySize(), generally fixed)
• Over-flow probability in reference to all registered measured values with confidence interval (getOverflowProbability() or getOverflowConfInterval())
• Under-flow probability in reference to all registered measured values with confidence interval (getUnderflowProbability() or getUnderflowConfInterval())
• Value of discretized distribution density functions at a certain point (range index) in the form of probabilities that a measured value falls into a certain partial range (getProbability(int) or getProbabilityConfInterval(int) including a confidence interval)
• Value of discretized distribution functions at a certain point (range index) as a sum of probabilities for the areas below that point ( getDistribution(int) or getDistributionConfInterval(int) with a confidence interval)
• Over-flow probability in the current batch (getBatchOverflowProb())
• Under-flow probability in the current batch (getBatchUnderflowProb())
• Value of the discretized distribution density function at a certain point in reference to the current batch (getBatchProbability(int))
• Value of the discretized distribution function at a certain point in reference to the current batch (getBatchDistribution(int))

For printing the results it defines the following keywords:

list

prints a list of results; what exactly is printed on each line has to be specified in brackets behind %[list] using the following keywords

ubound

upper bound of current bucket

uprob

underflow probability (mean of batch results)

cintuprob

underflow probability confidence interval

oprob

overflow probability (mean of batch results)

cintoprob

overflow probability confidence interval

dist

(cumulative) distribution (cdf)

prob

probability (density) (pdf)

cintdist

confidence interval for cdf/ccdf

cintprob

confidence interval for pdf

buprob

underflow probability for the current batch

boprob

overflow probability for the current batch

bdist

cdf for the current batch

bprob

pdf for the current batch

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
DistributionStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	getArraySize()
abstract double	getBatchDistribution(int bucketIndex)
abstract double	getBatchOverflowProb()
abstract double	getBatchProbability(int bucketIndex)
abstract double	getBatchUnderflowProb()
abstract double	getDistribution(int bucketIndex)
abstract double	getDistributionConfInterval(int bucketIndex)
abstract double	getLowerBound(int bucketIndex)
abstract double	getOverflowConfInterval()
abstract double	getOverflowProbability()
abstract double	getProbability(int bucketIndex)
abstract double	getProbabilityConfInterval(int bucketIndex)
java.lang.String	getResultTypeName()
abstract double	getUnderflowConfInterval()
abstract double	getUnderflowProbability()
abstract double	getUpperBound(int bucketIndex)
void	printResults(ResultType type, PrintResultWriter writer)
void	update(double sample)
abstract void	update(double sample, double weight)

Methods inherited from class ikr.simlib.statistics.Statistic

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionStatistic

public DistributionStatistic(SimNode ownNode)

Method Detail

printResults

public void printResults(ResultType type,
                PrintResultWriter writer)

Specified by:

printResults in interface Printable

getResultTypeName

public java.lang.String getResultTypeName()

Specified by:

getResultTypeName in interface Printable

update

public abstract void update(double sample,
          double weight)

update

public final void update(double sample)

getArraySize

public abstract int getArraySize()

getLowerBound

public abstract double getLowerBound(int bucketIndex)

getUpperBound

public abstract double getUpperBound(int bucketIndex)

getUnderflowProbability

public abstract double getUnderflowProbability()

getUnderflowConfInterval

public abstract double getUnderflowConfInterval()

getOverflowProbability

public abstract double getOverflowProbability()

getOverflowConfInterval

public abstract double getOverflowConfInterval()

getProbability

public abstract double getProbability(int bucketIndex)

getProbabilityConfInterval

public abstract double getProbabilityConfInterval(int bucketIndex)

getDistribution

public abstract double getDistribution(int bucketIndex)

getDistributionConfInterval

public abstract double getDistributionConfInterval(int bucketIndex)

getBatchUnderflowProb

public abstract double getBatchUnderflowProb()

getBatchOverflowProb

public abstract double getBatchOverflowProb()

getBatchProbability

public abstract double getBatchProbability(int bucketIndex)

getBatchDistribution

public abstract double getBatchDistribution(int bucketIndex)