DataTensor

java.lang.Object
- etomica.data.types.DataTensor

All Implemented Interfaces:

IData
```
public class DataTensor
extends java.lang.Object
implements IData
```
Data object wrapping a single mutable value of type (Space) Tensor. Value is final public and can be accessed directly.
All arithmetic methods throw ClassCastException if given a Data instance that is not of this type.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DataTensor.DataInfoTensor

static class DataTensor.DataInfoTensorFactory

Nested Classes
Modifier and Type	Class	Description
`static class`	`DataTensor.DataInfoTensor`
`static class`	`DataTensor.DataInfoTensorFactory`

Field Summary

Fields
Modifier and Type Field Description

Tensor x
The wrapped tensor data.

Fields
Modifier and Type	Field	Description
`Tensor`	`x`	The wrapped tensor data.

Constructor Summary

Constructors
Constructor Description

DataTensor(Space space)
Constructs a new instance with the given DataInfo, wrapping a new Tensor instance from the given space.

Constructors
Constructor	Description
`DataTensor(Space space)`	Constructs a new instance with the given DataInfo, wrapping a new Tensor instance from the given space.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`assignTo(double[] array)`	Returns a new array formed by the elements of the wrapped tensor.
`void`	`DE(double y)`	Divide-equals (*=) operation.
`void`	`DE(IData y)`	Divide-equals (/=) operation.
`void`	`E(double y)`	Sets all tensor elements to the given value.
`void`	`E(IData y)`	Copies the elements of the given tensor (wrapped in the Data object) to this vector.
`int`	`getLength()`	Returns the number of elements in the wrapped tensor.
`double`	`getValue(int i)`	Returns the i-th tensor value, indexing across the first row, then the second, etc.
`boolean`	`isNaN()`	Returns true if any vector element is not-a-number, as given by Double.isNaN.
`void`	`map(IFunction function)`	Maps the function on all vector elements, replacing 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.
`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 tensor values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - x
```
public final Tensor x
```
    The wrapped tensor data.
- Constructor Detail
  - DataTensor
```
public DataTensor(Space space)
```
    Constructs a new instance with the given DataInfo, wrapping a new Tensor instance from the given space.
    
    Parameters:
    
    space - used to construct the wrapped Vector
- Method Detail
  - E
```
public void E(IData y)
```
    Copies the elements of the given tensor (wrapped in the Data object) to this vector.
    
    Specified by:
    
    E in interface IData
  - E
```
public void E(double y)
```
    Sets all tensor elements to the given value.
    
    Specified by:
    
    E in interface IData
  - ME
```
public void ME(IData y)
```
    Minus-equals (-=) operation. Performed element-by-element.
    
    Specified by:
    
    ME in interface IData
  - PE
```
public void PE(IData y)
```
    Plus-equals (+=) operation. Performed element-by-element.
    
    Specified by:
    
    PE in interface IData
  - TE
```
public void TE(IData y)
```
    Times-equals (*=) operation. Performed element-by-element.
    
    Specified by:
    
    TE in interface IData
  - DE
```
public void DE(IData y)
```
    Divide-equals (/=) operation. Performed element-by-element.
    
    Specified by:
    
    DE in interface IData
  - PE
```
public void PE(double y)
```
    Plus-equals (+=) operation. Adds given value to all elements.
    
    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
  - isNaN
```
public boolean isNaN()
```
    Returns true if any vector element is not-a-number, as given by Double.isNaN.
    
    Specified by:
    
    isNaN in interface IData
  - map
```
public void map(IFunction function)
```
    Maps the function on all vector elements, replacing each with the value given by the function applied to it.
    
    Specified by:
    
    map in interface IData
  - getLength
```
public int getLength()
```
    Returns the number of elements in the wrapped tensor.
    
    Specified by:
    
    getLength in interface IData
  - getValue
```
public double getValue(int i)
```
    Returns the i-th tensor value, indexing across the first row, then the second, etc. For example, for a 2-D tensor, the indexes correspond to 0=xx, 1=xy, 2=yx, 3=yy.
    
    Specified by:
    
    getValue in interface IData
    
    Parameters:
    
    i - index of the desired data value
    
    Returns:
    
    the data value
  - assignTo
```
public void assignTo(double[] array)
```
    Returns a new array formed by the elements of the wrapped tensor.
    
    Specified by:
    
    assignTo in interface IData
  - toString
```
public java.lang.String toString()
```
    Returns a string formed from the dataInfo label and the tensor values.
    
    Overrides:
    
    toString in class java.lang.Object

Class DataTensor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

Constructor Detail

DataTensor

Method Detail

E

E

ME

PE

TE

DE

PE

TE

DE

isNaN

map

getLength

getValue

assignTo

toString