ikr.simlib.statistics.median

Class StdMedianStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.median.MedianStatistic

ikr.simlib.statistics.median.StdMedianStatistic

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>, BatchExportable, Printable

public class StdMedianStatistic
extends MedianStatistic
implements BatchExportable, ReflectionConstructable2<SimNode,Parameters>

StdMedianStatistic provides an implementation for a median statistic. If the parameter maxBufferSize is set to zero, all samples will be stored internally and the median will be calculated at the end of the simulation. Since this is very memory consuming, maxBufferSize can be set to a number > 0, which determines the maximum number of samples the statistic should hold in memory. The median is then calculated at the end of the simulation as an approximation that is based on all samples. Often, 10000 samples are sufficient for a good approximation.

See Also:

MedianTimeMeter

Field Summary

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
StdMedianStatistic(SimNode ownNode)
StdMedianStatistic(SimNode ownNode, int maxBufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
protected double	computeMedian() Returns the value for the median calculated from fSamples.
static StdMedianStatistic	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
long	getBatchEvents()
double	getBatchMedian()
long	getEvents()
double	getMaximum()
double	getMedian()
double	getMedianConfidenceInterval()
double	getMinimum()
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.median.MedianStatistic

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

StdMedianStatistic

public StdMedianStatistic(SimNode ownNode,
                  int maxBufferSize)

StdMedianStatistic

public StdMedianStatistic(SimNode ownNode)

Method Detail

createInstance

public static StdMedianStatistic createInstance(SimNode ownNode,
                                Parameters pars)

as required by ReflectionConstructable

computeMedian

protected double computeMedian()

Returns the value for the median calculated from fSamples.

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

getBatchEvents

public long getBatchEvents()

Specified by:

getBatchEvents in class MedianStatistic

getBatchMedian

public double getBatchMedian()

Specified by:

getBatchMedian in class MedianStatistic

getEvents

public long getEvents()

Specified by:

getEvents in class MedianStatistic

getMaximum

public double getMaximum()

Specified by:

getMaximum in class MedianStatistic

getMedian

public double getMedian()

Specified by:

getMedian in class MedianStatistic

getMedianConfidenceInterval

public double getMedianConfidenceInterval()

Specified by:

getMedianConfidenceInterval in class MedianStatistic

getMinimum

public double getMinimum()

Specified by:

getMinimum in class MedianStatistic

update

public void update(double sample)

Specified by:

update in class MedianStatistic

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