Package etomica.data

Class AccumulatorAverageBlockless

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorAverageBlockless

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

public class AccumulatorAverageBlockless
extends DataAccumulator

AccumulatorAverage that does not use blocks (best used when each sample is independent). This accumulator tracks most recent, average and standard deviation.

This accumulator accepts any type of Data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccumulatorAverageBlockless.AllData
static class	AccumulatorAverageBlockless.StatType	Enumerated type that can be used to indicated the statistic to be taken from the accumulator (e.g., average, error, current value, etc.).

Field Summary

Fields

Modifier and Type	Field	Description
protected IData	average
static AccumulatorAverageBlockless.StatType	AVERAGE
protected long	count
protected DataGroup	dataGroup
static AccumulatorAverageBlockless.StatType	MOST_RECENT
protected IData	mostRecent
protected IFunction	negativeChop
static AccumulatorAverageBlockless.StatType	STANDARD_DEVIATION
protected IData	standardDeviation
protected IData	sum
protected IData	sumSquare
protected IData	work

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

Method Summary

Modifier and Type	Method	Description
boolean	addData(IData data)	Add the given values to the sums and block sums.
void	addDataSink(IDataSink newDataSink, AccumulatorAverageBlockless.StatType[] types)	Adds a new DataSink that will receive a specific subset of the statistics generated by this accumulator.
IData	getData()	Returns a DataGroup with Data instances holding the statistics kept by this accumulator (as described in general comments for this class).
AccumulatorAverageBlockless.AllData	getRawData()
long	getSampleCount()
DataTag	getTag(AccumulatorAverageBlockless.StatType statType)
IDataInfo	processDataInfo(IDataInfo incomingDataInfo)	Prepares the accumulator for input data.
void	reset()	Resets all sums to zero.
void	setRawData(AccumulatorAverageBlockless.AllData ad)
static AccumulatorAverageBlockless.StatType[]	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

MOST_RECENT

public static final AccumulatorAverageBlockless.StatType MOST_RECENT

AVERAGE

public static final AccumulatorAverageBlockless.StatType AVERAGE

STANDARD_DEVIATION

public static final AccumulatorAverageBlockless.StatType STANDARD_DEVIATION

negativeChop

protected final IFunction negativeChop

mostRecent

protected IData mostRecent

average

protected IData average

standardDeviation

protected IData standardDeviation

dataGroup

protected DataGroup dataGroup

count

protected long count

sum

protected IData sum

sumSquare

protected IData sumSquare

work

protected IData work

Constructor Detail

AccumulatorAverageBlockless

public AccumulatorAverageBlockless()

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

Method Detail

statChoices

public static AccumulatorAverageBlockless.StatType[] statChoices()

getTag

public DataTag getTag(AccumulatorAverageBlockless.StatType statType)

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.

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.

Specified by:

reset in class DataAccumulator

processDataInfo

public IDataInfo processDataInfo(IDataInfo incomingDataInfo)

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

Specified by:

processDataInfo in class DataProcessor

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

addDataSink

public void addDataSink(IDataSink newDataSink,
                        AccumulatorAverageBlockless.StatType[] types)

Adds a new DataSink that will receive a specific subset of the statistics generated by this accumulator. The DataSink will be given a DataGroup that has only the specified statistics in it. The output of this accumulator is passed through a DataGroupFilter that removes the unwanted Data.

Parameters:

newDataSink - the new DataSink

types - array indicating the statistics to be included in the DataGroup sent to the sink.

getSampleCount

public long getSampleCount()

getRawData

public AccumulatorAverageBlockless.AllData getRawData()

setRawData

public void setRawData(AccumulatorAverageBlockless.AllData ad)