etomica.data
Class AccumulatorAverageCovariance

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

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource, IEtomicaDataSource, Serializable

public class AccumulatorAverageCovariance
extends AccumulatorAverageFixed

Class that does the work of AccumulatorAverageFixed and also calculates the covariance of the incoming data values (the covariance of each value with each other value, as well as itself (which is actually its standard deviation)) as well as the covariance of the block averages of the different data quantities.

See Also:

Serialized Form

Nested Class Summary

static class

AccumulatorAverageCovariance.StatType

Field Summary

protected DataDoubleArray	blockCovariance
protected DataDoubleArray	blockCovSum
protected DataDoubleArray	covariance
protected DataDoubleArray	covSum

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

AccumulatorAverageCovariance()

AccumulatorAverageCovariance(int blockSize)

Method Summary

void	addData(IData data) Add the given values to the sums and block sums.
protected void	doBlockSum() Performs the block sum after blockSize calls to addData.
IData	getData() Returns a DataGroup with Data instances holding the statistics kept by this accumulator (as described in general comments for this class).
IEtomicaDataInfo	processDataInfo(IEtomicaDataInfo incomingDataInfo) Prepares the accumulator for input data.
void	reset() Resets all sums to zero.

Methods inherited from class etomica.data.AccumulatorAverageFixed

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

covSum

protected DataDoubleArray covSum

blockCovSum

protected DataDoubleArray blockCovSum

covariance

protected DataDoubleArray covariance

blockCovariance

protected DataDoubleArray blockCovariance

Constructor Detail

AccumulatorAverageCovariance

public AccumulatorAverageCovariance()

AccumulatorAverageCovariance

public AccumulatorAverageCovariance(int blockSize)

Method Detail

addData

public void addData(IData data)

Description copied from class: AccumulatorAverageFixed

Add the given values to the sums and block sums. If any of the given data values is NaN, method returns with no effect on accumulation sums.

Overrides:

addData in class AccumulatorAverageFixed

doBlockSum

protected void doBlockSum()

Description copied from class: AccumulatorAverageFixed

Performs the block sum after blockSize calls to addData.

Overrides:

doBlockSum in class AccumulatorAverageFixed

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