IData

All Known Implementing Classes:

DataDouble, DataDoubleArray, DataDoubleBDArray, DataFunction, DataGroup, DataTable, DataTensor, DataVector, LatticeSumCrystal.DataGroupLSC, LatticeSumCrystalMolecular.DataGroupLSC
```
public interface IData
```
Abstract container of simulation data and information describing it. Data objects may encapsulate any type of data (such as one or more double values), and are transmitted from a DataSource to a DataSink, perhaps passing through a series of data processing elements along the way. The abstract Data class provides methods to obtain descriptive information about the data (its DataInfo), a method to copy the data to another existing data object instance, and a method to make a copy of the data to a new data object instance. Different subclasses of Data are generally not interchangable, and objects processing or receiving Data instances often expect a specific subclass.
The data held by a Data instance is mutable, but the structure of a Data instance is not. The "structure" of a Data instance refers to the number and type of data it holds. A DataDoubleArray, for example, holds an array of double; the values in the array may be changed, but the length of the array (the structure) cannot. Thus any object holding a reference to a Data instance can be assured that the number and type of data it holds will not be changed by something else that also references the instance.
Information about the data is encapsulated in a DataInfo instance that is held by the Data instance. The DataInfo holds a descriptive label, a Dimension instance that describes the physical dimensions (e.g., mass, time) of the data, and a DataFactory that will make new independent instances of the same Data type and with the same structure. The DataInfo instance is, like the Data structure, completely immutable.

See Also:

DataInfo

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`assignTo(double[] array)`	Fills the given array with the values held by this Data instance.
`void`	`DE(double y)`	Divide-equals (*=) operation, dividing all values in data by given value.
`void`	`DE(IData y)`	Divide-equals (/=) operation.
`void`	`E(double y)`	Equals (=) operation, sets all values in data equal to the given value.
`void`	`E(IData data)`	Deep-copies the data from the given object to this one.
`int`	`getLength()`	Returns the number of values held by the data instance.
`double`	`getValue(int i)`	Returns the i-th data value.
`boolean`	`isNaN()`	Returns true if any data value is true for Double.isNaN
`void`	`map(IFunction function)`	Maps the function on all data values, replace each with the value given by the function applied to it.
`void`	`ME(IData y)`	Minus-equals (-=) operation.
`void`	`PE(double y)`	Plus-equals (+=) operation, adding given value to all values in data.
`void`	`PE(IData y)`	Plus-equals (+=) operation.
`void`	`TE(double y)`	Times-equals (*=) operation, multiplying all values in data by given value.
`void`	`TE(IData y)`	Times-equals (*=) operation.

- Method Detail
  - E
```
void E(IData data)
```
    Deep-copies the data from the given object to this one.
    
    Throws:
    
    java.lang.ClassCastException - if the given data object is not of a type that can be copied to this one.
  - PE
```
void PE(IData y)
```
    Plus-equals (+=) operation.
  - ME
```
void ME(IData y)
```
    Minus-equals (-=) operation.
  - TE
```
void TE(IData y)
```
    Times-equals (*=) operation.
  - DE
```
void DE(IData y)
```
    Divide-equals (/=) operation.
  - E
```
void E(double y)
```
    Equals (=) operation, sets all values in data equal to the given value.
  - PE
```
void PE(double y)
```
    Plus-equals (+=) operation, adding given value to all values in data.
  - TE
```
void TE(double y)
```
    Times-equals (*=) operation, multiplying all values in data by given value.
  - DE
```
void DE(double y)
```
    Divide-equals (*=) operation, dividing all values in data by given value.
  - map
```
void map(IFunction function)
```
    Maps the function on all data values, replace each with the value given by the function applied to it.
  - getLength
```
int getLength()
```
    Returns the number of values held by the data instance.
  - getValue
```
double getValue(int i)
```
    Returns the i-th data value.
    
    Parameters:
    
    i - index of the desired data value
    
    Returns:
    
    the data value
    
    Throws:
    
    java.lang.IllegalArgumentException - if i >= getLength()
  - assignTo
```
void assignTo(double[] array)
```
    Fills the given array with the values held by this Data instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the length of the array is not equal to getLength
  - isNaN
```
boolean isNaN()
```
    Returns true if any data value is true for Double.isNaN

Interface IData

Method Summary

Method Detail

E

PE

ME

TE

DE

E

PE

TE

DE

map

getLength

getValue

assignTo

isNaN