Package etomica.data.history

Class HistoryCollapsing

java.lang.Object

etomica.data.history.HistoryCollapsing

All Implemented Interfaces:

History

Direct Known Subclasses:

HistoryCollapsingDiscard

public abstract class HistoryCollapsing
extends java.lang.Object
implements History

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

Modifier and Type	Field	Description
protected int	cursor
protected double[]	history
protected int	interval
protected int	intervalCount
protected int	numCollapseBins
protected double[]	xValues

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract void	collapseData()
double[]	getHistory()	Returns the history
int	getHistoryLength()	Returns the number of data points tracked by the History.
int	getNumCollapseBins()
int	getSampleCount()	Returns the number of data samples currently held by the History.
double[]	getXValues()	Returns an array containing the x values that have been added to the History.
void	reset()	Removes entire history, setting all values to NaN.
void	setHistoryLength(int n)	Sets the number of values kept in the history.
void	setNumCollapseBins(int newNumCollapseBins)	Sets the number of "collapse" bins.

Methods inherited from interface etomica.data.history.History

addValue

Methods inherited from class java.lang.Object

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

Field Detail

history

protected double[] history

cursor

protected int cursor

xValues

protected double[] xValues

interval

protected int interval

intervalCount

protected int intervalCount

numCollapseBins

protected int numCollapseBins

Constructor Detail

HistoryCollapsing

public HistoryCollapsing()

HistoryCollapsing

public HistoryCollapsing(int n)

HistoryCollapsing

public HistoryCollapsing(int nBins,
                         int nCollapseBins)

Method Detail

setHistoryLength

public void setHistoryLength(int n)

Sets the number of values kept in the history. If more data is contained in the history than the set length, the existing data is collapsed until it fits within the new length. History length must be at least 2.

Specified by:

setHistoryLength in interface History

getHistoryLength

public int getHistoryLength()

Description copied from interface: History

Returns the number of data points tracked by the History.

Specified by:

getHistoryLength in interface History

getSampleCount

public int getSampleCount()

Description copied from interface: History

Returns the number of data samples currently held by the History.

Specified by:

getSampleCount in interface History

setNumCollapseBins

public void setNumCollapseBins(int newNumCollapseBins)

Sets the number of "collapse" bins. When the data is collapsed, one value will be taken from each consecutive n bins, where n is the number of bins set by this method. The value will be taken from the middle bin or (for an even number of bins), taken from the bin to the left of the middle.

getNumCollapseBins

public int getNumCollapseBins()

reset

public void reset()

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

Specified by:

reset in interface History

getXValues

public double[] getXValues()

Description copied from interface: History

Returns an array containing the x values that have been added to the History.

Specified by:

getXValues in interface History

collapseData

protected abstract void collapseData()

getHistory

public double[] getHistory()

Returns the history

Specified by:

getHistory in interface History