ikr.simlib.statistics.distribution

Class StdDistributionStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.distribution.DistributionStatistic

ikr.simlib.statistics.distribution.StdDistributionStatistic

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>, BatchExportable, Printable, ResultTaggable, UnweightedSampleCollector<java.lang.Double>, WeightedSampleCollector<java.lang.Double,java.lang.Double>

public class StdDistributionStatistic
extends DistributionStatistic
implements BatchExportable, ReflectionConstructable2<SimNode,Parameters>

StdDistributionStatistic extends DistributionStatistic and provides an implementation for a distribution statistic.

Field Summary

Fields

Modifier and Type	Field and Description
int	arraySize
double	classWidth
Summation[]	cumulativeDist
static java.lang.String	EXPORT_BINS
static java.lang.String	EXPORT_OVERFLOWS
static java.lang.String	EXPORT_SUMOFWEIGHTS
static java.lang.String	EXPORT_UNDERFLOWS
static java.lang.String	EXPORT_WEIGHT
double	lowerLimit
Summation[]	marginalDist
Summation	overflowProb
Summation	underflowProb
double	upperLimit

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
StdDistributionStatistic(int arraySize, double lowerLimit, double upperLimit, SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
static StdDistributionStatistic	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
int	getArraySize()
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	importBatch(ResultReader reader) Imports the state of a batch from the result reader.
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

printResults, update, update, update

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

EXPORT_UNDERFLOWS

public static final java.lang.String EXPORT_UNDERFLOWS

EXPORT_OVERFLOWS

public static final java.lang.String EXPORT_OVERFLOWS

EXPORT_SUMOFWEIGHTS

public static final java.lang.String EXPORT_SUMOFWEIGHTS

EXPORT_WEIGHT

public static final java.lang.String EXPORT_WEIGHT

EXPORT_BINS

public static final java.lang.String EXPORT_BINS

arraySize

public final int arraySize

classWidth

public final double classWidth

lowerLimit

public final double lowerLimit

upperLimit

public final double upperLimit

underflowProb

public final Summation underflowProb

overflowProb

public final Summation overflowProb

marginalDist

public final Summation[] marginalDist

cumulativeDist

public final Summation[] cumulativeDist

Constructor Detail

StdDistributionStatistic

public StdDistributionStatistic(int arraySize,
                        double lowerLimit,
                        double upperLimit,
                        SimNode ownNode)

Method Detail

createInstance

public static StdDistributionStatistic createInstance(SimNode ownNode,
                                      Parameters pars)

as required by ReflectionConstructable

getArraySize

public int getArraySize()

Specified by:

getArraySize in class DistributionStatistic

getBatchDistribution

public double getBatchDistribution(int bucketIndex)

Specified by:

getBatchDistribution 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

getBatchUnderflowProb

public double getBatchUnderflowProb()

Specified by:

getBatchUnderflowProb 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

getLowerBound

public double getLowerBound(int bucketIndex)

Specified by:

getLowerBound in class DistributionStatistic

getOverflowConfInterval

public double getOverflowConfInterval()

Specified by:

getOverflowConfInterval in class DistributionStatistic

getOverflowProbability

public double getOverflowProbability()

Specified by:

getOverflowProbability 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

getUnderflowConfInterval

public double getUnderflowConfInterval()

Specified by:

getUnderflowConfInterval in class DistributionStatistic

getUnderflowProbability

public double getUnderflowProbability()

Specified by:

getUnderflowProbability in class DistributionStatistic

getUpperBound

public double getUpperBound(int bucketIndex)

Specified by:

getUpperBound in class DistributionStatistic

update

public void update(double sample,
          double weight)

Specified by:

update in class DistributionStatistic

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

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