ikr.simlib.statistics.sample

Class StdSampleStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.sample.SampleStatistic

ikr.simlib.statistics.sample.StdSampleStatistic

All Implemented Interfaces:

BatchExportable, Printable

public class StdSampleStatistic
extends SampleStatistic
implements BatchExportable

StdSampleStatistic provides an implementation for a sample statistic. See SampleStatistic

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
StdSampleStatistic(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.
double	getBatchCoefficient()
long	getBatchEvents()
double	getBatchMean()
double	getBatchStandardDeviation()
double	getBatchVariance()
double	getCoefficient()
double	getCoefficientConfidenceInterval()
double	getDeviation()
double	getDeviationConfidenceInterval()
long	getEvents()
double	getMaximum()
double	getMean()
double	getMeanConfidenceInterval()
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.sample.SampleStatistic

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

StdSampleStatistic

public StdSampleStatistic(SimNode ownNode)

Method Detail

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

update

public void update(double sample)

Specified by:

update in class SampleStatistic

getBatchCoefficient

public double getBatchCoefficient()

Specified by:

getBatchCoefficient in class SampleStatistic

getBatchEvents

public long getBatchEvents()

Specified by:

getBatchEvents in class SampleStatistic

getBatchMean

public double getBatchMean()

Specified by:

getBatchMean in class SampleStatistic

getBatchVariance

public double getBatchVariance()

Specified by:

getBatchVariance in class SampleStatistic

getCoefficient

public double getCoefficient()

Specified by:

getCoefficient in class SampleStatistic

getCoefficientConfidenceInterval

public double getCoefficientConfidenceInterval()

Specified by:

getCoefficientConfidenceInterval in class SampleStatistic

getDeviation

public double getDeviation()

Specified by:

getDeviation in class SampleStatistic

getDeviationConfidenceInterval

public double getDeviationConfidenceInterval()

Specified by:

getDeviationConfidenceInterval in class SampleStatistic

getMaximum

public double getMaximum()

Specified by:

getMaximum in class SampleStatistic

getMean

public double getMean()

Specified by:

getMean in class SampleStatistic

getMeanConfidenceInterval

public double getMeanConfidenceInterval()

Specified by:

getMeanConfidenceInterval in class SampleStatistic

getMinimum

public double getMinimum()

Specified by:

getMinimum in class SampleStatistic

getBatchStandardDeviation

public double getBatchStandardDeviation()

Specified by:

getBatchStandardDeviation in class SampleStatistic

getEvents

public long getEvents()

Specified by:

getEvents in class SampleStatistic

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