Package etomica.data.history

Class HistoryCollapsingAverage

java.lang.Object

etomica.data.history.HistoryCollapsing

etomica.data.history.HistoryCollapsingDiscard

etomica.data.history.HistoryCollapsingAverage

All Implemented Interfaces:

History

public class HistoryCollapsingAverage
extends HistoryCollapsingDiscard

History that records a number of values. When existing space is insufficient to hold new data, the existing data is "collapsed" such that all existing data is stored in the first half of existing storage by averaging each consecutive pair of data points. After that point, data will be stored as average block data.

Field Summary

Fields inherited from class etomica.data.history.HistoryCollapsing

cursor, history, interval, intervalCount, numCollapseBins, xValues

Constructor Summary

Constructors

Constructor	Description
HistoryCollapsingAverage()
HistoryCollapsingAverage(int n)

Method Summary

Modifier and Type	Method	Description
boolean	addValue(double x, double y)	adds data to the history.
protected void	collapseData()
void	reset()	Removes entire history, setting all values to NaN.

Methods inherited from class etomica.data.history.HistoryCollapsing

getHistory, getHistoryLength, getNumCollapseBins, getSampleCount, getXValues, setHistoryLength, setNumCollapseBins

Methods inherited from class etomica.data.history.HistoryCollapsingDiscard

willDiscardNextData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoryCollapsingAverage

public HistoryCollapsingAverage()

HistoryCollapsingAverage

public HistoryCollapsingAverage(int n)

Method Detail

addValue

public boolean addValue(double x,
                        double y)

adds data to the history. If insufficient space exists to store the data, existing data is collapsed by 1/2 and future data is taken half as much.

Specified by:

addValue in interface History

Overrides:

addValue in class HistoryCollapsingDiscard

reset

public void reset()

Description copied from class: HistoryCollapsing

Removes entire history, setting all values to NaN. After calling reset, data will be recorded at every interval.

Specified by:

reset in interface History

Overrides:

reset in class HistoryCollapsing

collapseData

protected void collapseData()

Overrides:

collapseData in class HistoryCollapsingDiscard