Package etomica.data

Class AccumulatorAverageFixed

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorAverage

etomica.data.AccumulatorAverageFixed

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

Direct Known Subclasses:

AccumulatorAverageCovariance, AccumulatorMimicMu

public class AccumulatorAverageFixed
extends AccumulatorAverage

AccumulatorAverage that maintains a fixed block size. This is standard accumulator for collecting averages in production runs.

This accumulator accepts any type of Data

The average value is based on block averages -- it does not include samples that are not part of blocks. Average and error are computed using a formulation that reduces numeric roundoff.

The standard deviation does include samples not included in a complete block and uses a simpler formulation that is more vulnerable to roundoff.

Nested Class Summary

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

AccumulatorAverage.StatType

Field Summary

Fields

Modifier and Type	Field	Description
protected IDataSink	blockDataSink
protected java.lang.String	blockFilename
protected IData	blockVarSum
protected IData	correlationSum
protected IData	currentBlockAvg
protected IData	firstBlock
protected IData	mostRecentBlock
protected IFunction	negativeChop
protected int	numSavedBlockData
protected IFunction	sanityCheckBC
protected double[][]	savedBlockData
protected IData	sumSquare
protected IData	work
protected IData	work2

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.DataAccumulator

active, hasUnpushedData, pushInterval, putCount

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
AccumulatorAverageFixed()	Default constructor sets block size to 1000 and sets the interval for pushing the output data (pushInterval) to 100.
AccumulatorAverageFixed(long blockSize)	Constructs with interval for pushing the output data set to 100.

Method Summary

Modifier and Type	Method	Description
boolean	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.
IDataSink	getBlockDataSink()
IData	getData()
boolean	getDoStrictBlockData()
IDataInfo	processDataInfo(IDataInfo incomingDataInfo)	Prepares the accumulator for input data.
void	putDataInfo(IDataInfo inputDataInfo)	Invokes processDataInfo on the given DataInfo, and passes the returned DataInfo to the dataSink (if not null).
void	readBlockData(java.lang.String filename)	Reads block data from the given file.
void	reset()	Resets all sums to zero.
void	setBlockDataSink(IDataSink blockDataSink)	Allows individual block data to be passed to a data sink.
void	setWriteBlocks(java.lang.String filename)	Configures the accumulator to write block data to the given file.
void	writeBlockData()

Methods inherited from class etomica.data.AccumulatorAverage

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

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

negativeChop

protected final IFunction negativeChop

sanityCheckBC

protected final IFunction sanityCheckBC

blockVarSum

protected IData blockVarSum

currentBlockAvg

protected IData currentBlockAvg

sumSquare

protected IData sumSquare

mostRecentBlock

protected IData mostRecentBlock

correlationSum

protected IData correlationSum

firstBlock

protected IData firstBlock

work

protected IData work

work2

protected IData work2

blockDataSink

protected IDataSink blockDataSink

blockFilename

protected java.lang.String blockFilename

savedBlockData

protected double[][] savedBlockData

numSavedBlockData

protected int numSavedBlockData

Constructor Detail

AccumulatorAverageFixed

public AccumulatorAverageFixed()

Default constructor sets block size to 1000 and sets the interval for pushing the output data (pushInterval) to 100.

AccumulatorAverageFixed

public AccumulatorAverageFixed(long blockSize)

Constructs with interval for pushing the output data set to 100.

Parameters:

blockSize - size of the block.

Method Detail

getDoStrictBlockData

public boolean getDoStrictBlockData()

Returns:

value of DoStrictBlockData

getBlockDataSink

public IDataSink getBlockDataSink()

Returns:

the data sink where block data are passed.

setWriteBlocks

public void setWriteBlocks(java.lang.String filename)

Configures the accumulator to write block data to the given file. The data can be read back in later so long as the underlying data is DataDoubleArray.

readBlockData

public void readBlockData(java.lang.String filename)

Reads block data from the given file. The accumulator's state (for block data) will match that when the file was last written to.

writeBlockData

public void writeBlockData()

setBlockDataSink

public void setBlockDataSink(IDataSink blockDataSink)

Allows individual block data to be passed to a data sink. Each block is pushed to the sink after it is complete (as determined by block size).

Parameters:

blockDataSink - the sink where the blocks are to be passed. For multiple streams, this could be a DataFork.

addData

public boolean addData(IData data)

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.

Specified by:

addData in class DataAccumulator

Parameters:

data - data to be added.

Returns:

true if data are not NaN.

putDataInfo

public void putDataInfo(IDataInfo inputDataInfo)

Description copied from class: DataProcessor

Invokes processDataInfo on the given DataInfo, and passes the returned DataInfo to the dataSink (if not null). Will insert a data caster before the DataSink if appropriate.

Specified by:

putDataInfo in interface IDataSink

Overrides:

putDataInfo in class DataProcessor

doBlockSum

protected void doBlockSum()

Performs the block sum after blockSize calls to addData.

getData

public IData getData()

Specified by:

getData in interface IDataSource

Specified by:

getData in class DataAccumulator

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 AccumulatorAverage

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 AccumulatorAverage

Parameters:

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

Returns:

dataInfo object for the output of this accumulator.