ikr.simlib.statistics.weighted

Class WeightedMeanStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.weighted.WeightedMeanStatistic

All Implemented Interfaces:

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

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

The class WeightedMeanStatistic is similar to SampleStatistic with the difference that in the update(double, double) method not only a measured value but also a weight is passed. The default value for that weight is 1. Based on that difference, only first order statistic are calculated.

The following functions are available for evaluation:

• mean value of all measures getMean()
• mean value of all measures in a batch getBatchMean()
• confidence interval of the mean value getMeanConfidenceInterval()

Results can be printed using the following keywords within a print format:

mean

Mean value of all measured values in reference to all batches

cintmean

Confidence interval of the mean values in +/- notation

bmean

Mean value in reference to the current batch

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
WeightedMeanStatistic(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	getBatchMean()
double	getMean()
double	getMeanConfidenceInterval()
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

WeightedMeanStatistic

public WeightedMeanStatistic(SimNode ownNode)

Method Detail

printResults

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

Specified by:

printResults in interface Printable

Throws:

PrintException

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>

getMean

public double getMean()

getBatchMean

public double getBatchMean()

getMeanConfidenceInterval

public double getMeanConfidenceInterval()

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 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