Package etomica.data.history

Class HistoryComplete

java.lang.Object

etomica.data.history.HistoryComplete

All Implemented Interfaces:

History

public class HistoryComplete
extends java.lang.Object
implements History

History that records a data from a simulation. When existing space is insufficient to hold new data, the array to hold the data is doubled in length.

Constructor Summary

Constructors

Constructor	Description
HistoryComplete()
HistoryComplete(int n)

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 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.
boolean	isCollapseOnReset()	Returns true if the history is collapsed (to 100 data points) when reset is called.
void	reset()	Removes entire history, setting all values to NaN.
void	setCollapseOnReset(boolean flag)	Sets a flag that determines if the history is collapsed (to 100 data points) when reset is called.
void	setHistoryLength(int n)	Sets the number of values kept in the history.
boolean	willDiscardNextData()

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryComplete

public HistoryComplete()

HistoryComplete

public HistoryComplete(int n)

Method Detail

setHistoryLength

public void setHistoryLength(int n)

Sets the number of values kept in the history.

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

reset

public void reset()

Removes entire history, setting all values to NaN.

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

addValue

public boolean addValue(double x,
                        double y)

Description copied from interface: History

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

Specified by:

addValue in interface History

getHistory

public double[] getHistory()

Returns an the history

Specified by:

getHistory in interface History

setCollapseOnReset

public void setCollapseOnReset(boolean flag)

Sets a flag that determines if the history is collapsed (to 100 data points) when reset is called. If the current history length is less than 100, the history length is unchanged.

isCollapseOnReset

public boolean isCollapseOnReset()

Returns true if the history is collapsed (to 100 data points) when reset is called. If the current history length is less than 100, the history length is unchanged.

willDiscardNextData

public boolean willDiscardNextData()