etomica.data
Class AccumulatorRatioAverage

java.lang.Object
  etomica.data.DataProcessor
      etomica.data.DataProcessorForked
          etomica.data.DataAccumulator
              etomica.data.AccumulatorAverage
                  etomica.data.AccumulatorAverageFixed
                      etomica.data.AccumulatorRatioAverage

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource, IEtomicaDataSource, Serializable

public class AccumulatorRatioAverage
extends AccumulatorAverageFixed

Accumulator for calculating ratio between two sums

See Also:

Serialized Form

Nested Class Summary

static class

AccumulatorRatioAverage.StatType

Field Summary

protected IData	ratio
protected IData	ratioError
protected IData	ratioStandardDeviation

Fields inherited from class etomica.data.AccumulatorAverageFixed

correlationSum, currentBlockSum, firstBlock, mostRecentBlock, negativeChop, sum, sumBlockSquare, sumSquare, work

Fields inherited from class etomica.data.AccumulatorAverage

average, blockCorrelation, blockCountDown, blockSize, count, dataGroup, error, mostRecent, standardDeviation

Fields inherited from class etomica.data.DataAccumulator

active, putCount

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag, trueDataSink

Constructor Summary

AccumulatorRatioAverage()

AccumulatorRatioAverage(long blockSize)

Method Summary

IData	getData() Returns a DataGroup with Data instances holding the statistics kept by this accumulator (as described in general comments for this class).
Object	getTag(AccumulatorRatioAverage.StatType statType)
IEtomicaDataInfo	processDataInfo(IEtomicaDataInfo incomingDataInfo) Prepares the accumulator for input data.
void	reset() Resets all sums to zero.

Methods inherited from class etomica.data.AccumulatorAverageFixed

addData, doBlockSum, getDataCaster

Methods inherited from class etomica.data.AccumulatorAverage

addDataSink, getBlockCount, getBlockSize, getTag, setBlockSize

Methods inherited from class etomica.data.DataAccumulator

getPushInterval, isActive, processData, setActive, setPushInterval, toString

Methods inherited from class etomica.data.DataProcessorForked

addDataSink, getDataSink, getDataSinks, removeDataSink, setDataSink, setDataSinks

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getTag, insertTransformerIfNeeded, putData, putDataInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface etomica.data.IEtomicaDataSource

getDataInfo, getTag

Methods inherited from interface etomica.data.DataPipe

getTag

Methods inherited from interface etomica.data.IDataSink

putData, putDataInfo

Field Detail

ratio

protected IData ratio

ratioStandardDeviation

protected IData ratioStandardDeviation

ratioError

protected IData ratioError

Constructor Detail

AccumulatorRatioAverage

public AccumulatorRatioAverage()

AccumulatorRatioAverage

public AccumulatorRatioAverage(long blockSize)

Method Detail

getTag

public Object getTag(AccumulatorRatioAverage.StatType statType)

getData

public IData getData()

Description copied from class: AccumulatorAverageFixed

Returns a DataGroup with Data instances holding the statistics kept by this accumulator (as described in general comments for this class).

Specified by:

getData in interface IDataSource

Overrides:

getData in class AccumulatorAverageFixed

Returns:

the data given by this source

reset

public void reset()

Description copied from class: AccumulatorAverageFixed

Resets all sums to zero. All statistics are cleared.

Overrides:

reset in class AccumulatorAverageFixed

processDataInfo

public IEtomicaDataInfo processDataInfo(IEtomicaDataInfo incomingDataInfo)

Description copied from class: AccumulatorAverageFixed

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

Overrides:

processDataInfo in class AccumulatorAverageFixed

Parameters:

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

Returns:

the DataInfo of the Data that will be output by this DataProcessor