Package etomica.data.types

Class DataDoubleArray

java.lang.Object

etomica.data.types.DataDoubleArray

All Implemented Interfaces:

IData, java.io.Serializable

Direct Known Subclasses:

DataFunction

public class DataDoubleArray
extends java.lang.Object
implements IData, java.io.Serializable

Data object that wraps a mutable array of doubles. Data may be treated alternately as a simple one-dimensional array accessed via the getData() method, or as a multidimensional array with indexed elements accessed via the getData(int[]) method. Shape of multidimensional array is specified at construction and cannot be changed afterwards.

All arithmetic methods throw ClassCastException if given a Data instance that is not a DataDoubleArray, and throw an IllegalArgumentException if the given DataDoubleArray is not of the same length as this one (array shape is not considered for arithmetic operations; only total length is relevant).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataDoubleArray.DataInfoDoubleArray
static class	DataDoubleArray.DataInfoDoubleArrayFactory

Constructor Summary

Constructors

Constructor	Description
DataDoubleArray(int nValues)	Constructs a new one-dimensional array of the given length.
DataDoubleArray(int[] arrayShape)	Constructs a new multidimensional array of the given shape.
DataDoubleArray(int[] arrayShape, double[] xData)	Wraps the given array, xData in a DataDoubleArray of the given shape.

Method Summary

Modifier and Type	Method	Description
void	assignColumnFrom(int i, double[] array)	Assigns values in given array to the i-th "hypercolumn" of this data array.
void	assignColumnTo(int i, double[] array)	Assigns values in the i=th "hypercolumn" of this array to the given array.
void	assignSubsectionFrom(int[] idx, double[] array)	Assigns values in the given array to the subsection of this array beginning at the specified index.
void	assignTo(double[] array)	Returns the encapsulated array, implementing the Data interface.
void	DE(double y)	Divide-equals (*=) operation.
void	DE(IData y)	Divide-equals (/=) operation.
void	E(double y)	Equals (=) operation.
void	E(double[] y)	Copies each value in the given array to the values in the wrapped array.
void	E(IData y)	Sets the wrapped array of values to the values in the given instance.
int	getArrayDimension()	Returns the dimension of the array, which is the number of integer indices needed to access one of its elements.
int	getArrayShape(int i)	Returns the length of the array in the i-th dimension.
double[]	getData()	Returns the encapsulated array.
int	getLength()	Returns the total length of the wrapped array.
double	getValue(int i)	Returns the i-th value of the wrapped array.
double	getValue(int[] index)	Returns the element of the array indicated by the given set of indices.
boolean	isNaN()	Returns true if any element of the encapsulated array is not-a-number, as given by Double.isNaN.
void	map(IFunction function)	Replaces all values by the value of the function applied to each.
void	ME(IData y)	Minus-equals (-=) operation.
void	PE(double y)	Plus-equals (+=) operation.
void	PE(IData y)	Plus-equals (+=) operation.
void	TE(double y)	Times-equals (*=) operation.
void	TE(IData y)	Times-equals (*=) operation.
java.lang.String	toString()	Returns a string formed from the dataInfo label and the array values.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataDoubleArray

public DataDoubleArray(int nValues)

Constructs a new one-dimensional array of the given length.

Parameters:

nValues - length of the one-dimensional array

DataDoubleArray

public DataDoubleArray(int[] arrayShape)

Constructs a new multidimensional array of the given shape.

Parameters:

arrayShape - length of the array in each dimension

DataDoubleArray

public DataDoubleArray(int[] arrayShape,
                       double[] xData)

Wraps the given array, xData in a DataDoubleArray of the given shape.

Parameters:

arrayShape - length of the array in each dimension

xData - actual data to be held by this instance. The array is not cloned.

Method Detail

getArrayDimension

public int getArrayDimension()

Returns the dimension of the array, which is the number of integer indices needed to access one of its elements.

E

public void E(IData y)

Sets the wrapped array of values to the values in the given instance.

Specified by:

E in interface IData

E

public void E(double[] y)

Copies each value in the given array to the values in the wrapped array.

Throws:

java.lang.IllegalArgumentException - if the arrays are of different lengths

PE

public void PE(IData y)

Plus-equals (+=) operation. Element-by-element addition of the values in the given array to those in this one.

Specified by:

PE in interface IData

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the array in the given object is smaller than this instance's array.

ME

public void ME(IData y)

Minus-equals (-=) operation. Element-by-element subtraction of the values in the given array from those in this one.

Specified by:

ME in interface IData

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the array in the given object is smaller than this instance's array.

TE

public void TE(IData y)

Times-equals (*=) operation. Applied element-by-element.

Specified by:

TE in interface IData

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the array in the given object is smaller than this instance's array.

DE

public void DE(IData y)

Divide-equals (/=) operation. Applied element-by-element.

Specified by:

DE in interface IData

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the array in the given object is smaller than this instance's array.

E

public void E(double y)

Equals (=) operation. Sets all elements to given value.

Specified by:

E in interface IData

PE

public void PE(double y)

Plus-equals (+=) operation. Increments all elements by the given value.

Specified by:

PE in interface IData

TE

public void TE(double y)

Times-equals (*=) operation. Multiplies all elements by the given value.

Specified by:

TE in interface IData

DE

public void DE(double y)

Divide-equals (*=) operation. Divides all elements by the given value.

Specified by:

DE in interface IData

map

public void map(IFunction function)

Replaces all values by the value of the function applied to each.

Specified by:

map in interface IData

getLength

public int getLength()

Returns the total length of the wrapped array. This is the product of the lengths in each dimension, and is the length of the wrapped 1D array that stores the array values.

Specified by:

getLength in interface IData

getArrayShape

public int getArrayShape(int i)

Returns the length of the array in the i-th dimension.

getValue

public double getValue(int i)

Returns the i-th value of the wrapped array.

Specified by:

getValue in interface IData

Parameters:

i - index of the desired data value

Returns:

the data value

Throws:

java.lang.ArrayIndexOutOfBoundsException - if not (0 <= i < getLength()).

getValue

public double getValue(int[] index)

Returns the element of the array indicated by the given set of indices.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if length of given array is less than getArrayDimension (if length is greater, excess indices are ignored).

getData

public double[] getData()

Returns the encapsulated array.

isNaN

public boolean isNaN()

Returns true if any element of the encapsulated array is not-a-number, as given by Double.isNaN.

Specified by:

isNaN in interface IData

assignTo

public void assignTo(double[] array)

Returns the encapsulated array, implementing the Data interface.

Specified by:

assignTo in interface IData

assignColumnTo

public void assignColumnTo(int i,
                           double[] array)

Assigns values in the i=th "hypercolumn" of this array to the given array.

assignColumnFrom

public void assignColumnFrom(int i,
                             double[] array)

Assigns values in given array to the i-th "hypercolumn" of this data array.

assignSubsectionFrom

public void assignSubsectionFrom(int[] idx,
                                 double[] array)

Assigns values in the given array to the subsection of this array beginning at the specified index.

Parameters:

idx - index array of length less than or equal to getArrayDimension (right-padded with zeros if shorter)

array - values to be copied into this array

toString

public java.lang.String toString()

Returns a string formed from the dataInfo label and the array values.

Overrides:

toString in class java.lang.Object