ikr.simlib.statistics.weighted

Class WeightedDistStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.weighted.WeightedDistStatistic

All Implemented Interfaces:

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

public class WeightedDistStatistic
extends Statistic
implements BatchExportable, Printable, WeightedSampleCollector<java.lang.Double,java.lang.Double>

WeightedDistStatistic provides an implementation for a weighted distribution statistic.

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 using the following keywords

ubound

upper bound of current bucket

lbound

lower bound of current bucket

muprob

underflow probability (mean of batch results)

cintuprob

underflow probability confidence interval

moprob

overflow probability (mean of batch results)

cintoprob

overflow probability confidence interval

dist

(cumulative) distribution (cdf)

prob

probability (density) (pdf)

compdist

complementary (cumulative) distribution (ccdf)

cintdist

confidence interval for cdf/ccdf

cintprob

confidence interval for pdf

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
WeightedDistStatistic(int arraySize, double lowerLimit, double upperLimit, SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
int	getArraySize()
double	getClassWidth()
double	getDistribution(int bucketIndex)
double	getDistributionConfInterval(int bucketIndex)
double	getLowerBound(int bucketIndex)
double	getLowerLimit()
double	getOverflowConfInterval()
double	getOverflowProbability()
double	getProbability(int bucketIndex)
double	getProbabilityConfInterval(int bucketIndex)
double	getUnderflowConfInterval()
double	getUnderflowProbability()
double	getUpperBound(int bucketIndex)
double	getUpperLimit()
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)
void	update(java.lang.Double sample)
void	update(double sample, double weight)
void	update(java.lang.Double sample, java.lang.Double weight)

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

Constructor Detail

WeightedDistStatistic

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

Method Detail

printResults

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

Specified by:

printResults in interface Printable

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

update

public void update(double sample,
          double weight)

update

public void update(java.lang.Double sample,
          java.lang.Double weight)

Specified by:

update in interface WeightedSampleCollector<java.lang.Double,java.lang.Double>

update

public final void update(double sample)

update

public void update(java.lang.Double sample)

Specified by:

update in interface UnweightedSampleCollector<java.lang.Double>

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

getArraySize

public int getArraySize()

getClassWidth

public double getClassWidth()

getLowerLimit

public double getLowerLimit()

getUpperLimit

public double getUpperLimit()

getLowerBound

public double getLowerBound(int bucketIndex)

getUpperBound

public double getUpperBound(int bucketIndex)

getUnderflowProbability

public double getUnderflowProbability()

getUnderflowConfInterval

public double getUnderflowConfInterval()

getOverflowProbability

public double getOverflowProbability()

getOverflowConfInterval

public double getOverflowConfInterval()

getProbability

public double getProbability(int bucketIndex)

getProbabilityConfInterval

public double getProbabilityConfInterval(int bucketIndex)

getDistribution

public double getDistribution(int bucketIndex)

getDistributionConfInterval

public double getDistributionConfInterval(int bucketIndex)