Package etomica.data

Class AccumulatorAverageFixedOutputFile

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorAverage

etomica.data.AccumulatorAverageFixedOutputFile

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

public class AccumulatorAverageFixedOutputFile
extends AccumulatorAverage

AccumulatorAverage that maintains a fixed block size.

This accumulator accepts any type of Data

Nested Class Summary

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

AccumulatorAverage.StatType

Field Summary

Fields

Modifier and Type	Field	Description
protected long	blockCounter
protected IData	correlationSum
protected IData	currentBlockSum
protected java.io.FileWriter	fileWriter
protected IData	firstBlock
protected IData	mostRecentBlock
protected IFunction	negativeChop
protected IData	sum
protected IData	sumBlockSquare
protected IData	sumSquare
protected boolean	toWriteFile
protected IData	work

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
AccumulatorAverageFixedOutputFile()	Default constructor sets block size to Default value, and sets the interval for pushing the output data (pushInterval) to 100.
AccumulatorAverageFixedOutputFile(int blockSize)

Method Summary

Modifier and Type	Method	Description
boolean	addData(IData data)	Add the given values to the sums and block sums.
void	closeFile()
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).
IDataInfo	processDataInfo(IDataInfo incomingDataInfo)	Prepares the accumulator for input data.
void	reset()	Resets all sums to zero.
void	setFile(java.lang.String fname)

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, putDataInfo

Methods inherited from class etomica.data.DataProcessorForked

addDataSink, getDataSink, getDataSinks, removeDataSink, setDataSink, setDataSinks

Methods inherited from interface etomica.data.IDataSink

putData, putDataInfo

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

sum

protected IData sum

sumBlockSquare

protected IData sumBlockSquare

currentBlockSum

protected IData currentBlockSum

sumSquare

protected IData sumSquare

mostRecentBlock

protected IData mostRecentBlock

correlationSum

protected IData correlationSum

firstBlock

protected IData firstBlock

work

protected IData work

negativeChop

protected final IFunction negativeChop

fileWriter

protected java.io.FileWriter fileWriter

toWriteFile

protected boolean toWriteFile

blockCounter

protected long blockCounter

Constructor Detail

AccumulatorAverageFixedOutputFile

public AccumulatorAverageFixedOutputFile()

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

AccumulatorAverageFixedOutputFile

public AccumulatorAverageFixedOutputFile(int blockSize)

Method Detail

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 - the data to be processed

Returns:

true if the Accumulator's getData method will now return different data.

doBlockSum

protected void doBlockSum()

Performs the block sum after blockSize calls to addData.

getData

public IData getData()

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

Specified by:

getData in class DataAccumulator

Returns:

the data given by this source

reset

public void reset()

Resets all sums to zero. All statistics are cleared.

Overrides:

reset in class AccumulatorAverage

processDataInfo

public IDataInfo processDataInfo(IDataInfo incomingDataInfo)

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.

setFile

public void setFile(java.lang.String fname)

closeFile

public void closeFile()