Package etomica.data

Class AccumulatorRatioAverageCovariance

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorAverage

etomica.data.AccumulatorAverageFixed

etomica.data.AccumulatorAverageCovariance

etomica.data.AccumulatorRatioAverageCovariance

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

Direct Known Subclasses:

AccumulatorVirialOverlapSingleAverage

public class AccumulatorRatioAverageCovariance
extends AccumulatorAverageCovariance

Accumulator for calculating ratio between sums. The ratios calculated are the ratios of each data element to the first one, so v0/v0, v1/v0, v2/v0, etc.

Nested Class Summary

Nested classes/interfaces inherited from class etomica.data.AccumulatorAverage

AccumulatorAverage.StatType

Field Summary

Fields

Modifier and Type	Field	Description
protected IData	ratio
static AccumulatorAverage.StatType	RATIO
static AccumulatorAverage.StatType	RATIO_ERROR
protected IData	ratioError

Fields inherited from class etomica.data.AccumulatorAverage

average, AVERAGE, BLOCK_CORRELATION, blockCorrelation, blockCountDown, blockSize, count, dataGroup, doIncludeACInError, error, ERROR, MOST_RECENT, mostRecent, STANDARD_DEVIATION, standardDeviation

Fields inherited from class etomica.data.AccumulatorAverageCovariance

BLOCK_COVARIANCE, blockCovariance, blockCovSum, covariance, COVARIANCE, covSum, fullCovariance

Fields inherited from class etomica.data.AccumulatorAverageFixed

blockDataSink, blockFilename, blockVarSum, correlationSum, currentBlockAvg, firstBlock, mostRecentBlock, negativeChop, numSavedBlockData, sanityCheckBC, savedBlockData, sumSquare, work, work2

Fields inherited from class etomica.data.DataAccumulator

active, hasUnpushedData, pushInterval, putCount

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
AccumulatorRatioAverageCovariance()
AccumulatorRatioAverageCovariance(long blockSize)

Method Summary

Modifier and Type	Method	Description
static AccumulatorAverage.StatType[]	choices()
IData	getData()
DataTag	getTag(AccumulatorAverage.StatType statType)
IDataInfo	processDataInfo(IDataInfo incomingDataInfo)	Prepares the accumulator for input data.
void	reset()	Resets all sums to zero.

Methods inherited from class etomica.data.AccumulatorAverage

addDataSink, doIncludeACInError, getBlockCount, getBlockSize, getData, getSampleCount, setBlockSize, setIncludeACInError

Methods inherited from class etomica.data.AccumulatorAverageCovariance

addData, doBlockSum, statChoices

Methods inherited from class etomica.data.AccumulatorAverageFixed

getBlockDataSink, getDoStrictBlockData, putDataInfo, readBlockData, setBlockDataSink, setWriteBlocks, writeBlockData

Methods inherited from class etomica.data.DataAccumulator

getPushInterval, isActive, processData, setActive, setPushInterval, toString

Methods inherited from interface etomica.data.DataPipe

getTag

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getTag, putData

Methods inherited from class etomica.data.DataProcessorForked

addDataSink, getDataSink, getDataSinks, removeDataSink, setDataSink, setDataSinks

Methods inherited from interface etomica.data.IDataSink

putData

Methods inherited from interface etomica.data.IDataSource

getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Field Detail

RATIO

public static final AccumulatorAverage.StatType RATIO

RATIO_ERROR

public static final AccumulatorAverage.StatType RATIO_ERROR

ratio

protected IData ratio

ratioError

protected IData ratioError

Constructor Detail

AccumulatorRatioAverageCovariance

public AccumulatorRatioAverageCovariance()

AccumulatorRatioAverageCovariance

public AccumulatorRatioAverageCovariance(long blockSize)

Method Detail

getTag

public DataTag getTag(AccumulatorAverage.StatType statType)

Overrides:

getTag in class AccumulatorAverage

Parameters:

statType - the statistic for which the DataTag is requested.

Returns:

the DataTag that identifies the specified statistic.

getData

public IData getData()

Specified by:

getData in interface IDataSource

Overrides:

getData in class AccumulatorAverageCovariance

Returns:

the data given by this source

reset

public void reset()

Description copied from class: AccumulatorAverage

Resets all sums to zero. All statistics are cleared.

Overrides:

reset in class AccumulatorAverageCovariance

processDataInfo

public IDataInfo processDataInfo(IDataInfo incomingDataInfo)

Description copied from class: AccumulatorAverage

Prepares the accumulator for input data. Discards any previous contributions to statistics.

Overrides:

processDataInfo in class AccumulatorAverageCovariance

Parameters:

incomingDataInfo - the DataInfo instance for the data that will be given to addData

Returns:

dataInfo object for the output of this accumulator.

choices

public static AccumulatorAverage.StatType[] choices()