cc.redberry.core.tensor

Class TensorField

java.lang.Object

cc.redberry.core.tensor.Tensor

cc.redberry.core.tensor.SimpleTensor

cc.redberry.core.tensor.TensorField

All Implemented Interfaces:

Comparable<Tensor>, Iterable<Tensor>

public final class TensorField
extends SimpleTensor

Representation of tensor field.

Since:

1.0

Author:

Dmitry Bolotin, Stanislav Poslavsky

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleIndices[]	argIndices
protected Tensor[]	args

Fields inherited from class cc.redberry.core.tensor.SimpleTensor

indices, name

Method Summary

Methods

Modifier and Type	Method and Description
SimpleIndices[][]	calcIndicesPartition() Calculates and returns partition of derivative indices.
Tensor	get(int i) Returns element at i-th position.
SimpleIndices[]	getArgIndices()
SimpleIndices	getArgIndices(int i)
Tensor[]	getArguments()
TensorBuilder	getBuilder() Creates a builder for this tensor.
TensorFactory	getFactory() Returns a factory for this tensor.
NameDescriptorForTensorField	getNameDescriptor()
Tensor[]	getRange(int from, int to) Retrieves several sub-tensors from current tensor.
boolean	isDerivative()
Iterator<Tensor>	iterator() Return read-only iterator over tensor elements.
int	size() Returns the number of elements in this tensor.
String	toString(OutputFormat mode) Returns a string representation of a tensor according to the specified OutputFormat.

Methods inherited from class cc.redberry.core.tensor.SimpleTensor

equals, getIndices, getName, getStringName, hash

Methods inherited from class cc.redberry.core.tensor.Tensor

compareTo, hashCode, set, toArray, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

args

protected Tensor[] args

argIndices

protected SimpleIndices[] argIndices

Method Detail

getArguments

public Tensor[] getArguments()

getArgIndices

public SimpleIndices[] getArgIndices()

getArgIndices

public SimpleIndices getArgIndices(int i)

isDerivative

public boolean isDerivative()

get

public Tensor get(int i)

Description copied from class: Tensor

Returns element at i-th position.

Overrides:

get in class SimpleTensor

Parameters:

i - position

Returns:

element at i-th position

size

public int size()

Description copied from class: Tensor

Returns the number of elements in this tensor.

Overrides:

size in class SimpleTensor

Returns:

the number of elements in this tensor

iterator

public Iterator<Tensor> iterator()

Description copied from class: Tensor

Return read-only iterator over tensor elements.

Specified by:

iterator in interface Iterable<Tensor>

Overrides:

iterator in class SimpleTensor

Returns:

read-only iterator over tensor elements

getRange

public Tensor[] getRange(int from,
                int to)

Description copied from class: Tensor

Retrieves several sub-tensors from current tensor. This function is faster than sequential invocations of Tensor.get(int) method.

Overrides:

getRange in class Tensor

Parameters:

from - index of first sub-tensor to be retrieved (inclusive)

to - next index after last sub-tensor to be retrieved (exclusive)

Returns:

array with retrieved tensors

getNameDescriptor

public NameDescriptorForTensorField getNameDescriptor()

Overrides:

getNameDescriptor in class SimpleTensor

calcIndicesPartition

public SimpleIndices[][] calcIndicesPartition()

Calculates and returns partition of derivative indices. The resulting array organized as follows: result[0][0] --- contains pure field indices (result[0].length == 1), result[i][j] --- are indices formed by j-th derivative with respect to i-th field argument

Returns:

partition of derivative indices

toString

public String toString(OutputFormat mode)

Description copied from class: Tensor

Returns a string representation of a tensor according to the specified OutputFormat.

Overrides:

toString in class SimpleTensor

Parameters:

mode - output format

Returns:

a string representation of a tensor

getBuilder

public TensorBuilder getBuilder()

Description copied from class: Tensor

Creates a builder for this tensor. See TensorBuilder for more information.

Overrides:

getBuilder in class SimpleTensor

Returns:

builder for this tensor

getFactory

public TensorFactory getFactory()

Description copied from class: Tensor

Returns a factory for this tensor. See TensorFactory for more information.

Overrides:

getFactory in class SimpleTensor

Returns:

builder for this tensor