ikr.simlib.statistics.boundary

Class StdBoundaryStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.boundary.BoundaryStatistic

ikr.simlib.statistics.boundary.StdBoundaryStatistic

All Implemented Interfaces:

BatchExportable, Printable

public class StdBoundaryStatistic
extends BoundaryStatistic
implements BatchExportable

StdBoundaryStatistic provides an implementation of BoundaryStatistic to calculate quantiles for a given number of samples and percentage. Note that the percentage-parameter in the constructor must be between 0 and 1.

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
StdBoundaryStatistic(int expectedNoOfSamples, double percentage, 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	getNoOfSamples()
double	getPercentage()
double	getQuantile()
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)

Methods inherited from class ikr.simlib.statistics.boundary.BoundaryStatistic

getResultTypeName, printResults

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

StdBoundaryStatistic

public StdBoundaryStatistic(int expectedNoOfSamples,
                    double percentage,
                    SimNode ownNode)

Method Detail

getNoOfSamples

public int getNoOfSamples()

Specified by:

getNoOfSamples in class BoundaryStatistic

getPercentage

public double getPercentage()

Specified by:

getPercentage in class BoundaryStatistic

getQuantile

public double getQuantile()

Specified by:

getQuantile in class BoundaryStatistic

update

public void update(double sample)

Specified by:

update in class BoundaryStatistic

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 ResultException

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:

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

importBatch

public void importBatch(ResultReader reader)
                 throws ResultException

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:

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