ikr.simlib.statistics.sample

Class SampleStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.sample.SampleStatistic

All Implemented Interfaces:

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

Direct Known Subclasses:

StdSampleStatistic

public abstract class SampleStatistic
extends Statistic
implements Printable, UnweightedSampleCollector<java.lang.Double>

The classes SampleStatistic or StdSampleStatistic serve to register single measured values (e.g. run times) of the type double with the help of the method update(double).

The following functions are available for evaluation:

• Mean value of all returned measured values (getMean()) including a confidence interval (getMeanConfidenceInterval())
• Standard deviation of all returned measured values (getDeviation()) including a confidence interval (getDeviationConfidenceInterval())
• Coefficient of variation of all returned measured values ( getCoefficient()) including a confidence interval ( getCoefficientConfidenceInterval())
• Value range (getMinimum() and getMaximum()) in reference to all measured values
• Mean value of the returned measured values from the current batch ( getBatchMean())
• Coefficient of variation of the returned measured values from the current batch (getBatchCoefficient())
• Variation of the returned measured values from the current batch ( getBatchVariance())
• Number of measured values from the batch (getBatchEvents())

For printing the results it defines the following keywords:

mean

mean of all samples in all batches

cintmean

confidence interval to mean value

deviation

standard deviation of all samples in all batches

cintdeviation

confidence interval to deviation value

cov

coefficient of std. dev. of all Batchs

cintcov

confidence interval to coefficient of variation

max

maximum sample of all batches

min

minimum sample of all batches

numberofevents

number of samples in actual Batch

bmean

mean of current batch

bcov

coefficient of variation in current batch

bvariance

variance of current Batch

bmax

maximum value in current batches

bmin

minimum value in current batches

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
SampleStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	getBatchCoefficient()
abstract long	getBatchEvents()
abstract double	getBatchMean()
abstract double	getBatchStandardDeviation()
abstract double	getBatchVariance()
abstract double	getCoefficient()
abstract double	getCoefficientConfidenceInterval()
abstract double	getDeviation()
abstract double	getDeviationConfidenceInterval()
abstract long	getEvents()
abstract double	getMaximum()
abstract double	getMean()
abstract double	getMeanConfidenceInterval()
abstract double	getMinimum()
void	printResults(ResultType type, PrintResultWriter writer)
abstract void	update(double sample)
void	update(java.lang.Double sample)

Methods inherited from class ikr.simlib.statistics.Statistic

addResultTag, addResultTag, computeMeasures, disableTracing, enableTracing, handleInitSimulation, handleStartBatch, handleStartTransientPhase, handleStopBatch, handleStopTransientPhase, printComments, resetBatchStatistic, resetStatistic, update, writeTraceEntry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SampleStatistic

public SampleStatistic(SimNode ownNode)

Method Detail

printResults

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

Specified by:

printResults in interface Printable

Throws:

PrintException

update

public abstract void update(double sample)

update

public void update(java.lang.Double sample)

Specified by:

update in interface UnweightedSampleCollector<java.lang.Double>

getMean

public abstract double getMean()

getDeviation

public abstract double getDeviation()

getCoefficient

public abstract double getCoefficient()

getEvents

public abstract long getEvents()

getBatchMean

public abstract double getBatchMean()

getBatchEvents

public abstract long getBatchEvents()

getBatchCoefficient

public abstract double getBatchCoefficient()

getBatchVariance

public abstract double getBatchVariance()

getBatchStandardDeviation

public abstract double getBatchStandardDeviation()

getMeanConfidenceInterval

public abstract double getMeanConfidenceInterval()

getDeviationConfidenceInterval

public abstract double getDeviationConfidenceInterval()

getCoefficientConfidenceInterval

public abstract double getCoefficientConfidenceInterval()

getMaximum

public abstract double getMaximum()

getMinimum

public abstract double getMinimum()