Package etomica.data.history

Class HistoryCollapsingDiscard

java.lang.Object

etomica.data.history.HistoryCollapsing

etomica.data.history.HistoryCollapsingDiscard

All Implemented Interfaces:

History

Direct Known Subclasses:

HistoryCollapsingAverage

public class HistoryCollapsingDiscard
extends HistoryCollapsing

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 dropping every other data point. After that point data will be taken half as often.

Field Summary

Fields inherited from class etomica.data.history.HistoryCollapsing

cursor, history, interval, intervalCount, numCollapseBins, xValues

Constructor Summary

Constructors

Constructor	Description
HistoryCollapsingDiscard()
HistoryCollapsingDiscard(int n)
HistoryCollapsingDiscard(int nBins, int nCollapseBins)

Method Summary

Modifier and Type	Method	Description
boolean	addValue(double x, double y)	adds data to the history.
protected void	collapseData()
boolean	willDiscardNextData()

Methods inherited from class etomica.data.history.HistoryCollapsing

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryCollapsingDiscard

public HistoryCollapsingDiscard()

HistoryCollapsingDiscard

public HistoryCollapsingDiscard(int n)

HistoryCollapsingDiscard

public HistoryCollapsingDiscard(int nBins,
                                int nCollapseBins)

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

willDiscardNextData

public boolean willDiscardNextData()

collapseData

protected void collapseData()

Specified by:

collapseData in class HistoryCollapsing