Package etomica.data

Class DataSourceUniform

java.lang.Object

etomica.data.DataSourceUniform

All Implemented Interfaces:

IDataSource, java.io.Serializable

public class DataSourceUniform
extends java.lang.Object
implements IDataSource, java.io.Serializable

A DataSource object that provides a set of uniformly spaced values between two limits. Number of points and range can be configured. Range can be set inclusive or exclusive of end points (independently). A physical dimension (e.g., length, time) can be associated with the data at construction (only).

Used principally to provide a set of "x" values for a function or plot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataSourceUniform.LimitType	Typed constant that indicates the way limits of the range are interpreted.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	doEnforceBounds
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
DataSourceUniform()	Default constructor.
DataSourceUniform(java.lang.String label, Dimension dimension)
DataSourceUniform(java.lang.String label, Dimension dimension, int nValues, double xMin, double xMax)	Constructs a DataSourceUniform using the indicated number of values and x range, and INCLUSIVE limits.
DataSourceUniform(java.lang.String label, Dimension dimension, int nValues, double xMin, double xMax, DataSourceUniform.LimitType typeMin, DataSourceUniform.LimitType typeMax)	Constructs a DataSourceUniform using the indicated number of values, x range, and limit types, with dataInfo indicating that the data have the given dimension.

Method Summary

Modifier and Type	Method	Description
IData	getData()	Returns the uniformly spaced values.
IDataInfo	getDataInfo()
boolean	getDoEnforceBounds()
int	getIndex(double value)	Returns the index of the x value closest to the argument.
int	getNValues()	Accessor method for number of values.
DataTag	getTag()
DataSourceUniform.LimitType	getTypeMax()	Accessor method for the type of the right limit.
DataSourceUniform.LimitType	getTypeMin()	Accessor method for the type of the left limit.
double	getXMax()	Accessor method for the right limit of the range.
double	getXMin()	Accessor method for the left limit of the range.
static void	main(java.lang.String[] args)	Main method to demonstrate and check class.
void	setDoEnforceBounds(boolean newDoEnforceBounds)
void	setNValues(int nValues)	Sets the number of uniformly spaced values.
void	setTypeMax(DataSourceUniform.LimitType typeMax)	Mutator method for the type of the right limit.
void	setTypeMin(DataSourceUniform.LimitType typeMin)	Mutator method for the type of the left limit.
void	setXMax(double xMax)	Mutator method for the right limit of the range.
void	setXMin(double xMin)	Mutator method for the left limit of the range.

Methods inherited from class java.lang.Object

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

Field Detail

tag

protected final DataTag tag

doEnforceBounds

protected boolean doEnforceBounds

Constructor Detail

DataSourceUniform

public DataSourceUniform()

Default constructor. Chooses 100 points between 0 and 1, inclusive, and sets dataInfo label to "Uniform" and dimension to Dimension.NULL (which cannot be changed after construction).

DataSourceUniform

public DataSourceUniform(java.lang.String label,
                         Dimension dimension)

DataSourceUniform

public DataSourceUniform(java.lang.String label,
                         Dimension dimension,
                         int nValues,
                         double xMin,
                         double xMax)

Constructs a DataSourceUniform using the indicated number of values and x range, and INCLUSIVE limits.

DataSourceUniform

public DataSourceUniform(java.lang.String label,
                         Dimension dimension,
                         int nValues,
                         double xMin,
                         double xMax,
                         DataSourceUniform.LimitType typeMin,
                         DataSourceUniform.LimitType typeMax)

Constructs a DataSourceUniform using the indicated number of values, x range, and limit types, with dataInfo indicating that the data have the given dimension. Dimension cannot be changed after construction.

Method Detail

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

getTag

public DataTag getTag()

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

getIndex

public int getIndex(double value)

Returns the index of the x value closest to the argument.

Parameters:

value - the double you are testing

Throws:

java.lang.IllegalArgumentException - if the argument is outside the defined range.

setNValues

public void setNValues(int nValues)

Sets the number of uniformly spaced values. Minimum allowable value is 2 (smaller values cause return with no action).

getNValues

public int getNValues()

Accessor method for number of values.

setXMin

public void setXMin(double xMin)

Mutator method for the left limit of the range.

getXMax

public double getXMax()

Accessor method for the right limit of the range.

setXMax

public void setXMax(double xMax)

Mutator method for the right limit of the range.

getXMin

public double getXMin()

Accessor method for the left limit of the range.

setTypeMin

public void setTypeMin(DataSourceUniform.LimitType typeMin)

Mutator method for the type of the left limit.

getTypeMin

public DataSourceUniform.LimitType getTypeMin()

Accessor method for the type of the left limit.

setTypeMax

public void setTypeMax(DataSourceUniform.LimitType typeMax)

Mutator method for the type of the right limit.

getTypeMax

public DataSourceUniform.LimitType getTypeMax()

Accessor method for the type of the right limit.

getData

public IData getData()

Returns the uniformly spaced values.

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

setDoEnforceBounds

public void setDoEnforceBounds(boolean newDoEnforceBounds)

getDoEnforceBounds

public boolean getDoEnforceBounds()

main

public static void main(java.lang.String[] args)

Main method to demonstrate and check class. Should output the values described in the comments for the LimitType class.