ikr.simlib.untested.statistics.correlation

Class StdCorrelationStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.untested.statistics.correlation.CorrelationStatistic

ikr.simlib.untested.statistics.correlation.StdCorrelationStatistic

All Implemented Interfaces:

BatchExportable, Printable

public class StdCorrelationStatistic
extends CorrelationStatistic
implements BatchExportable

The class StdCorrelationStatistic provides an implementation to calculate the coefficient of correlation and the covariance between 2 series of samples.

Following keywords are defined for printing the results:

coeff

coefficient of correlation

cintcoeff

confidence interval of corr. coeff.

pmcintcoeff

cintcoeff in +/- notation

cov

covariance

cintcov

confidence interval of covariance

pmcintcov

cintcov in +/- notation

Field Summary

Fields

Modifier and Type	Field and Description
protected Summation	coeffMeasures
protected Summation	covarianceMeasures
protected Summation	xSampleSummation
protected double	xySampleSummation
protected Summation	ySampleSummation

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
StdCorrelationStatistic(java.lang.String name, SimNode owner)

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	getCoefficient()
double	getCoefficientConfidenceInterval()
double	getCovariance()
double	getCovarianceConfidenceInterval()
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 xSample, double ySample)

Methods inherited from class ikr.simlib.untested.statistics.correlation.CorrelationStatistic

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

Field Detail

xySampleSummation

protected double xySampleSummation

xSampleSummation

protected final Summation xSampleSummation

ySampleSummation

protected final Summation ySampleSummation

coeffMeasures

protected final Summation coeffMeasures

covarianceMeasures

protected final Summation covarianceMeasures

Constructor Detail

StdCorrelationStatistic

public StdCorrelationStatistic(java.lang.String name,
                       SimNode owner)

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

getCoefficient

public double getCoefficient()

Specified by:

getCoefficient in class CorrelationStatistic

getCoefficientConfidenceInterval

public double getCoefficientConfidenceInterval()

Specified by:

getCoefficientConfidenceInterval in class CorrelationStatistic

getCovariance

public double getCovariance()

Specified by:

getCovariance in class CorrelationStatistic

getCovarianceConfidenceInterval

public double getCovarianceConfidenceInterval()

Specified by:

getCovarianceConfidenceInterval in class CorrelationStatistic

update

public void update(double xSample,
          double ySample)

Specified by:

update in class CorrelationStatistic

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