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:

java.lang.Comparable<Tensor>, java.lang.Iterable<Tensor>

public final class TensorField
extends SimpleTensor

Representation of tensor field.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
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.
int	getDeivativeOrder(int i) Returns the order of derivative with respect to argument at specified position.
TensorFactory	getFactory() Returns a factory for this tensor.
NameDescriptorForTensorField	getNameDescriptor()
TensorField	getParentField() Return tensor field from which the derivative is taken.
SimpleIndices[][]	getPartitionOfIndices() Calculates and returns partition of derivative indices.
Tensor[]	getRange(int from, int to) Retrieves several sub-tensors from current tensor.
boolean	isDerivative()
java.util.Iterator<Tensor>	iterator() Return read-only iterator over tensor elements.
int	size() Returns the number of elements in this tensor.
java.lang.String	toString0(OutputFormat mode)

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

equals, getIndices, getName, getStringName, toString, toString

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

compareTo, hashCode, set, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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 java.util.Iterator<Tensor> iterator()

Description copied from class: Tensor

Return read-only iterator over tensor elements.

Specified by:

iterator in interface java.lang.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

getParentField

public TensorField getParentField()

Return tensor field from which the derivative is taken. If this is derivative (e.g. f_m~(1)[k_a]), returns target tensor field of this (i.e. f[k_a]); otherwise, returns this.

Returns:

tensor field from which the derivative is taken

getDeivativeOrder

public int getDeivativeOrder(int i)

Returns the order of derivative with respect to argument at specified position.

Returns:

the order of derivative with respect to argument at specified position

getPartitionOfIndices

public SimpleIndices[][] getPartitionOfIndices()

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

toString0

public java.lang.String toString0(OutputFormat mode)

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