Package etomica.data.types

Class DataFunction

java.lang.Object

etomica.data.types.DataDoubleArray

etomica.data.types.DataFunction

All Implemented Interfaces:

IData

public class DataFunction
extends DataDoubleArray

Collects two or more DataDoubleArray instances, and organizes them into "dependent" and "independent" subgroups. Normally these data represent a functional dependence, in which the dependent data were calculated at each point in the domain of the independent data. However, nothing about this class enforces the dependence, it merely classifies the data into the two groups.

Multidimensional functions hold the independent data as an array of one-dimensional DataDoubleArrays, and the dependent data is represented by a single DataDoubleArray that is formed with a corresponding number of dimensions.

All arithmetic operations apply only to the dependent data. Independent data values are unaffected by them.

Note that all instances created by the same factory will hold the same instances of the independent data. Thus if the independent data is changed in any instance, it will be reflected in all instances that were constructed by the factory.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataFunction.DataInfoFunction
static class	DataFunction.DataInfoFunctionFactory

Nested classes/interfaces inherited from class etomica.data.types.DataDoubleArray

DataDoubleArray.DataInfoDoubleArray, DataDoubleArray.DataInfoDoubleArrayFactory

Constructor Summary

Constructors

Constructor	Description
DataFunction(int[] arrayShape)	Forms a DataFunction with the given array shape.
DataFunction(int[] arrayShape, double[] yData)	Forms a DataFunction using the given independent and dependent data instances.

Method Summary

Methods inherited from class etomica.data.types.DataDoubleArray

assignColumnFrom, assignColumnTo, assignSubsectionFrom, assignTo, DE, DE, E, E, E, getArrayDimension, getArrayShape, getData, getLength, getValue, getValue, isNaN, map, ME, PE, PE, TE, TE, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFunction

public DataFunction(int[] arrayShape,
                    double[] yData)

Forms a DataFunction using the given independent and dependent data instances.

Parameters:

yData - the data defined on the space of independent data; a double[] with getDimension equal to independentData.length

Throws:

java.lang.IllegalArgumentException - if length of independentData array does not equal dependentData.getArrayDimension(), or if any of the independent data have array dimension not equal to 1

DataFunction

public DataFunction(int[] arrayShape)

Forms a DataFunction with the given array shape.