Package etomica.data

Class AccumulatorAverageBlocklessSlim

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorAverageBlocklessSlim

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

public class AccumulatorAverageBlocklessSlim
extends DataAccumulator

AccumulatorAverage that does not use blocks (best used when each sample is independent). This accumulator tracks average and standard deviation. The returned data is created on the fly in order to save on memory.

This accumulator accepts any type of Data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccumulatorAverageBlocklessSlim.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
static AccumulatorAverageBlocklessSlim.StatType	AVERAGE
protected long	count
protected IDataInfo	inDataInfo
protected static IFunction	negativeChop
static AccumulatorAverageBlocklessSlim.StatType	STANDARD_DEVIATION
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
AccumulatorAverageBlocklessSlim()

Method Summary

Modifier and Type	Method	Description
boolean	addData(IData data)	Add the given values to the sums and block sums.
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()
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	putDataInfo(IDataInfo inputDataInfo)	Prepares the accumulator for input data.
void	reset()	Resets all sums to zero.
void	setRawData(AccumulatorAverageBlockless.AllData ad)
static AccumulatorAverageBlocklessSlim.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

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

AVERAGE

public static final AccumulatorAverageBlocklessSlim.StatType AVERAGE

STANDARD_DEVIATION

public static final AccumulatorAverageBlocklessSlim.StatType STANDARD_DEVIATION

inDataInfo

protected IDataInfo inDataInfo

count

protected long count

sum

protected IData sum

sumSquare

protected IData sumSquare

work

protected IData work

negativeChop

protected static final IFunction negativeChop

Constructor Detail

AccumulatorAverageBlocklessSlim

public AccumulatorAverageBlocklessSlim()

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.

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

putDataInfo

public void putDataInfo(IDataInfo inputDataInfo)

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

Specified by:

putDataInfo in interface IDataSink

Overrides:

putDataInfo in class DataProcessor

Parameters:

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

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Description copied from class: DataProcessor

Informs this DataProcessor of the DataInfo for the Data it will be processing. Typically the subclass will use this information to make any objects or otherwise prepare for calls to processData.

Specified by:

processDataInfo in class DataProcessor

Parameters:

inputDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

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

getSampleCount

public long getSampleCount()

statChoices

public static AccumulatorAverageBlocklessSlim.StatType[] statChoices()

getRawData

public AccumulatorAverageBlockless.AllData getRawData()

setRawData

public void setRawData(AccumulatorAverageBlockless.AllData ad)