ikr.simlib.statistics.distribution.trace

Class DistributionStatisticBase

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.distribution.DistributionStatistic

ikr.simlib.statistics.distribution.trace.DistributionStatisticBase

All Implemented Interfaces:

BatchExportable, Printable, ResultTaggable, UnweightedSampleCollector<java.lang.Double>, WeightedSampleCollector<java.lang.Double,java.lang.Double>

Direct Known Subclasses:

MemoryDistributionStatistic, TracingDistributionStatistic

public abstract class DistributionStatisticBase
extends DistributionStatistic
implements BatchExportable

Similar to the simlib StdDistributionStatistic, but buckets are determined automatically. All samples are collected during the simulation. At the end, the values are sorted and the quantiles are caluclated.

Output: This statistic is based on quantiles, so the size of "buckets" varies (different to the StdDistributionStatistic). The main output is the distribution over all drops. In addition, the distribution of each drop is written to the result file separately. To have an approximation of the estimation accuracy, the minimum and maximum value (over all drops) for each quantile is calculated. Be careful: With few drops, this can become narrow, although it might be inaccurate!

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
DistributionStatisticBase(SimNode ownNode, int numberOfQuantiles)
DistributionStatisticBase(SimNode ownNode, int numberOfQuantiles, boolean writeDropDistributions)
DistributionStatisticBase(SimNode ownNode, QuantileDescription quantiles, boolean writeDropDistributions)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
protected abstract DataStorage	createNewDataStorage(int batchNumber)
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
int	getArraySize() distribution statistic interface
double	getBatchDistribution(int bucketIndex)
double	getBatchOverflowProb()
double	getBatchProbability(int bucketIndex)
double	getBatchUnderflowProb()
double	getDistribution(int bucketIndex)
double	getDistributionConfInterval(int bucketIndex)
double	getLowerBound(int bucketIndex)
double	getOverflowConfInterval()
double	getOverflowProbability()
double	getProbability(int bucketIndex)
double	getProbabilityConfInterval(int bucketIndex)
double	getUnderflowConfInterval()
double	getUnderflowProbability()
double	getUpperBound(int bucketIndex)
void	handleStartBatch(int batchNumber)
void	handleStartTransientPhase()
void	handleStopBatch(int batchNumber)
void	handleStopTransientPhase()
void	importBatch(ResultReader reader) Imports the state of a batch from the result reader.
void	printResults(ResultType type, PrintResultWriter writer)
void	resetBatchStatistic() only between batches
void	resetStatistic() reset complete statistic
void	update(double sample, double weight)

Methods inherited from class ikr.simlib.statistics.distribution.DistributionStatistic

update, update, update

Methods inherited from class ikr.simlib.statistics.Statistic

addResultTag, addResultTag, disableTracing, enableTracing, handleInitSimulation, printComments, update, writeTraceEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionStatisticBase

public DistributionStatisticBase(SimNode ownNode,
                         int numberOfQuantiles)

DistributionStatisticBase

public DistributionStatisticBase(SimNode ownNode,
                         int numberOfQuantiles,
                         boolean writeDropDistributions)

DistributionStatisticBase

public DistributionStatisticBase(SimNode ownNode,
                         QuantileDescription quantiles,
                         boolean writeDropDistributions)

Method Detail

update

public void update(double sample,
          double weight)

Specified by:

update in class DistributionStatistic

createNewDataStorage

protected abstract DataStorage createNewDataStorage(int batchNumber)

handleStartBatch

public void handleStartBatch(int batchNumber)

Overrides:

handleStartBatch in class Statistic

handleStartTransientPhase

public void handleStartTransientPhase()

Overrides:

handleStartTransientPhase in class Statistic

handleStopTransientPhase

public void handleStopTransientPhase()

Overrides:

handleStopTransientPhase in class Statistic

handleStopBatch

public void handleStopBatch(int batchNumber)

Overrides:

handleStopBatch in class Statistic

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

printResults

public void printResults(ResultType type,
                PrintResultWriter writer)
                  throws PrintException

Specified by:

printResults in interface Printable

Overrides:

printResults in class DistributionStatistic

Throws:

PrintException

exportBatch

public void exportBatch(ResultWriter writer)
                 throws PrintException

Description copied from interface: BatchExportable

Exports the batch state to a result writer. Everything written to the result writer has to be read in the same order in importBatch despite the keywords.

Specified by:

exportBatch in interface BatchExportable

Parameters:

writer - the result writer which preserves the state

Throws:

PrintException - if any exception occurs while writing a result to the writer

importBatch

public void importBatch(ResultReader reader)
                 throws ImportException

Description copied from interface: BatchExportable

Imports the state of a batch from the result reader. The exported results have to read in the same order as written in exportBatch despite the keywords.

Specified by:

importBatch in interface BatchExportable

Parameters:

reader - the result reader which contains the batch state

Throws:

ImportException - if any exception occurs while reading a result from the reader

getArraySize

public int getArraySize()

distribution statistic interface

Specified by:

getArraySize in class DistributionStatistic

getLowerBound

public double getLowerBound(int bucketIndex)

Specified by:

getLowerBound in class DistributionStatistic

getUpperBound

public double getUpperBound(int bucketIndex)

Specified by:

getUpperBound in class DistributionStatistic

getUnderflowProbability

public double getUnderflowProbability()

Specified by:

getUnderflowProbability in class DistributionStatistic

getUnderflowConfInterval

public double getUnderflowConfInterval()

Specified by:

getUnderflowConfInterval in class DistributionStatistic

getOverflowProbability

public double getOverflowProbability()

Specified by:

getOverflowProbability in class DistributionStatistic

getOverflowConfInterval

public double getOverflowConfInterval()

Specified by:

getOverflowConfInterval in class DistributionStatistic

getProbability

public double getProbability(int bucketIndex)

Specified by:

getProbability in class DistributionStatistic

getProbabilityConfInterval

public double getProbabilityConfInterval(int bucketIndex)

Specified by:

getProbabilityConfInterval in class DistributionStatistic

getDistribution

public double getDistribution(int bucketIndex)

Specified by:

getDistribution in class DistributionStatistic

getDistributionConfInterval

public double getDistributionConfInterval(int bucketIndex)

Specified by:

getDistributionConfInterval in class DistributionStatistic

getBatchUnderflowProb

public double getBatchUnderflowProb()

Specified by:

getBatchUnderflowProb in class DistributionStatistic

getBatchOverflowProb

public double getBatchOverflowProb()

Specified by:

getBatchOverflowProb in class DistributionStatistic

getBatchProbability

public double getBatchProbability(int bucketIndex)

Specified by:

getBatchProbability in class DistributionStatistic

getBatchDistribution

public double getBatchDistribution(int bucketIndex)

Specified by:

getBatchDistribution in class DistributionStatistic