ikr.simlib.statistics.sample

Class MeanStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.sample.MeanStatistic

All Implemented Interfaces:

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

public class MeanStatistic
extends Statistic
implements Printable, BatchExportable, UnweightedSampleCollector<java.lang.Double>

Similar to SampleStatistic, but ignores batches. It therefore does not calculate confidence intervals. The calculated mean is the true mean over all samples, independent of the number of values per batch. For simplicity, only the mean and the number of events is written to the result file.

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
MeanStatistic(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.
long	getEvents()
double	getMean()
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(java.lang.Double value)

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

MeanStatistic

public MeanStatistic(SimNode ownNode)

Method Detail

update

public void update(java.lang.Double value)

Specified by:

update in interface UnweightedSampleCollector<java.lang.Double>

printResults

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

Specified by:

printResults in interface Printable

Throws:

PrintException

resetStatistic

public void resetStatistic()

Description copied from class: Statistic

reset complete statistic

Specified by:

resetStatistic in class Statistic

resetBatchStatistic

public void resetBatchStatistic()

Description copied from class: Statistic

only between batches

Specified by:

resetBatchStatistic in class Statistic

computeMeasures

public void computeMeasures(int batchNumber)

Specified by:

computeMeasures 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

getMean

public double getMean()

getEvents

public long getEvents()