ikr.simlib.statistics.rate

Class RateStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.rate.RateStatistic

All Implemented Interfaces:

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

Direct Known Subclasses:

StdRateStatistic

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

The class RateStatistic serves to record rates, i.e. the amount of information per time as well as the number of samples per time. The update(double) function takes a double value indicating the amount of information. Besides name and owner, an entity is required for constructor call to have access to the method getSystemTime().

The following functions are available for evaluation:

• Mean value in [samples/time] of all returned measured rates ( getSampleRate()) including a confidence interval ( getRateConfInterval()).

For printing the results it defines the following keywords:

rate

Mean of all rates [units/time] in all batches

cintrate

Confidence interval to mean rates

samplerate

Mean of all rates [samples/time] in all batches

cintsamplerate

Confidence interval to mean rates

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
RateStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	getBatchRate()
abstract double	getBatchSampleRate()
abstract double	getRate()
abstract double	getRateConfInterval()
abstract double	getSampleRate()
abstract double	getSampleRateConfInterval()
void	printResults(ResultType type, PrintResultWriter writer)
abstract void	update(double amount)
void	update(java.lang.Double amount)

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

RateStatistic

public RateStatistic(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 amount)

update

public void update(java.lang.Double amount)

Specified by:

update in interface UnweightedSampleCollector<java.lang.Double>

getRate

public abstract double getRate()

getRateConfInterval

public abstract double getRateConfInterval()

getBatchRate

public abstract double getBatchRate()

getSampleRate

public abstract double getSampleRate()

getSampleRateConfInterval

public abstract double getSampleRateConfInterval()

getBatchSampleRate

public abstract double getBatchSampleRate()