Package etomica.data

Class DataSourceFunction

java.lang.Object

etomica.data.DataSourceFunction

All Implemented Interfaces:

DataSourceIndependent, IDataSource, java.io.Serializable

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

Datasource formed as a wrapper around a function. Uses a DataSourceUniform to generate x values, and takes a Function that computes the y values from them. This DataSource returns a DataGroup with two Data components; the first (0) is x, and the second (1) is y. Useful for displaying a fixed function on a plot.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
DataSourceFunction()
DataSourceFunction(IFunction function)
DataSourceFunction(java.lang.String label, Dimension dimension, IFunction function, int nValues)
DataSourceFunction(java.lang.String label, Dimension dimension, IFunction function, int nValues, java.lang.String xLabel, Dimension xDimension)

Method Summary

Modifier and Type	Method	Description
IData	getData()	Returns the DataFunction made by this source.
IDataInfo	getDataInfo()
IFunction	getFunction()
int	getIndependentArrayDimension()	Returns the number of independent data dimensions
DataDoubleArray	getIndependentData(int i)	Returns the X data for the given dimension
DataDoubleArray.DataInfoDoubleArray	getIndependentDataInfo(int i)	Returns the DataInfo for the given dimension
DataTag	getIndependentTag()	Returns the tag associated with this DataSource.
DataTag	getTag()
DataSourceUniform	getXSource()	Returns the DataSourceUniform instance that generates the x values.
void	setFunction(IFunction function)
protected void	setupData(java.lang.String label, Dimension dimension)	Recalculates the y values from the current x values.
void	update()	Updates the wrapped Data and DataInfo for change to the xDataSource
void	updateF()

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

Constructor Detail

DataSourceFunction

public DataSourceFunction()

DataSourceFunction

public DataSourceFunction(IFunction function)

DataSourceFunction

public DataSourceFunction(java.lang.String label,
                          Dimension dimension,
                          IFunction function,
                          int nValues)

DataSourceFunction

public DataSourceFunction(java.lang.String label,
                          Dimension dimension,
                          IFunction function,
                          int nValues,
                          java.lang.String xLabel,
                          Dimension xDimension)

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

getXSource

public DataSourceUniform getXSource()

Returns the DataSourceUniform instance that generates the x values. The range and spacing of the x values can be adjusted through the methods of the returned instance.

getData

public IData getData()

Returns the DataFunction made by this source.

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

getFunction

public IFunction getFunction()

Returns:

Returns the function.

setFunction

public void setFunction(IFunction function)

Parameters:

function - The function to set.

setupData

protected void setupData(java.lang.String label,
                         Dimension dimension)

Recalculates the y values from the current x values. This must be invoked if the methods of the DataSourceUniform given by getXSource are used to change the x values.

getIndependentData

public DataDoubleArray getIndependentData(int i)

Description copied from interface: DataSourceIndependent

Returns the X data for the given dimension

Specified by:

getIndependentData in interface DataSourceIndependent

getIndependentDataInfo

public DataDoubleArray.DataInfoDoubleArray getIndependentDataInfo(int i)

Description copied from interface: DataSourceIndependent

Returns the DataInfo for the given dimension

Specified by:

getIndependentDataInfo in interface DataSourceIndependent

getIndependentArrayDimension

public int getIndependentArrayDimension()

Description copied from interface: DataSourceIndependent

Returns the number of independent data dimensions

Specified by:

getIndependentArrayDimension in interface DataSourceIndependent

getIndependentTag

public DataTag getIndependentTag()

Description copied from interface: DataSourceIndependent

Returns the tag associated with this DataSource.

Specified by:

getIndependentTag in interface DataSourceIndependent

update

public void update()

Updates the wrapped Data and DataInfo for change to the xDataSource

updateF

public void updateF()