Package etomica.data.history

Interface History

All Known Implementing Classes:

HistoryCollapsing, HistoryCollapsingAverage, HistoryCollapsingDiscard, HistoryComplete, HistoryScrolling, HistoryStatistics

public interface History

Interface for an object that keeps track of x and y values and return their history when asked. Behavior when the history has more data than the set length length is determined by the subclasses.

Method Summary

Modifier and Type	Method	Description
boolean	addValue(double x, double y)	Adds the given x, y pair to the History.
double[]	getHistory()	Returns an array containing the y values that have been added to the History.
int	getHistoryLength()	Returns the number of data points tracked by the History.
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()	Resets the History.
void	setHistoryLength(int n)	Sets the number of data points to be tracked by the History.

Method Detail

setHistoryLength

void setHistoryLength(int n)

Sets the number of data points to be tracked by the History.

getHistoryLength

int getHistoryLength()

Returns the number of data points tracked by the History.

getSampleCount

int getSampleCount()

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

reset

void reset()

Resets the History. Memory of all data given via addValue is dropped.

addValue

boolean addValue(double x,
                 double y)

Adds the given x, y pair to the History. Returns true if getHistory will now return different values.

getXValues

double[] getXValues()

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

getHistory

double[] getHistory()

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