cc.redberry.core.tensor

Class Tensor

java.lang.Object

cc.redberry.core.tensor.Tensor

All Implemented Interfaces:

Comparable<Tensor>, Iterable<Tensor>

Direct Known Subclasses:

Complex, Expression, MultiTensor, Power, ScalarFunction, SimpleTensor, TensorWrapper

public abstract class Tensor
extends Object
implements Comparable<Tensor>, Iterable<Tensor>

Abstract class which defines common tensor properties and methods. All tensors are immutable. This class dos not implements equals() method, and in order to compare tensors one should use TensorUtils.equals(Tensor, Tensor).

Since:

1.0

Author:

Dmitry Bolotin, Stanislav Poslavsky

See Also:

Indices, TensorUtils.equals(Tensor, Tensor)

Constructor Summary

Constructors

Constructor and Description
Tensor()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Tensor t) Compares tensors by their hash codes.
abstract Tensor	get(int i) Returns element at i-th position.
abstract TensorBuilder	getBuilder() Creates a builder for this tensor.
abstract TensorFactory	getFactory() Returns a factory for this tensor.
abstract Indices	getIndices() Returns indices of this tensor.
Tensor[]	getRange(int from, int to) Retrieves several sub-tensors from current tensor.
protected abstract int	hash() Hash code of this tensor.
int	hashCode()
Iterator<Tensor>	iterator() Return read-only iterator over tensor elements.
Tensor	set(int i, Tensor tensor) Returns new tensor instance with i-th sub-tensor replaced by provided tensor.
abstract int	size() Returns the number of elements in this tensor.
Tensor[]	toArray()
String	toString() Returns a string representation of a tensor according to the default OutputFormat defined in CC.getDefaultOutputFormat().
abstract String	toString(OutputFormat outputFormat) Returns a string representation of a tensor according to the specified OutputFormat.
protected String	toString(OutputFormat mode, Class<? extends Tensor> clazz) For internal use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tensor

public Tensor()

Method Detail

hash

protected abstract int hash()

Hash code of this tensor.

Returns:

hash code of this tensor

getIndices

public abstract Indices getIndices()

Returns indices of this tensor.

Returns:

indices of this tensor

iterator

public Iterator<Tensor> iterator()

Return read-only iterator over tensor elements.

Specified by:

iterator in interface Iterable<Tensor>

Returns:

read-only iterator over tensor elements

get

public abstract Tensor get(int i)

Returns element at i-th position.

Parameters:

i - position

Returns:

element at i-th position

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size()

size

public abstract int size()

Returns the number of elements in this tensor.

Returns:

the number of elements in this tensor

set

public Tensor set(int i,
         Tensor tensor)

Returns new tensor instance with i-th sub-tensor replaced by provided tensor.

Parameters:

i - index of sub-tensor to be replaced

tensor - tensor to replace i-th sub-tensor

Returns:

new instance of tensor

getRange

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

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

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

toArray

public Tensor[] toArray()

toString

public abstract String toString(OutputFormat outputFormat)

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

Parameters:

outputFormat - output format

Returns:

a string representation of a tensor

toString

public final String toString()

Returns a string representation of a tensor according to the default OutputFormat defined in CC.getDefaultOutputFormat().

Overrides:

toString in class Object

Returns:

a string representation of a tensor

toString

protected String toString(OutputFormat mode,
              Class<? extends Tensor> clazz)

For internal use.

compareTo

public final int compareTo(Tensor t)

Compares tensors by their hash codes.

Specified by:

compareTo in interface Comparable<Tensor>

Parameters:

t - tensor

Returns:

0 if hashes are equals, 1 if hash code of this greater the hash code of specified tensor and -1 otherwise

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getBuilder

public abstract TensorBuilder getBuilder()

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

Returns:

builder for this tensor

getFactory

public abstract TensorFactory getFactory()

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

Returns:

builder for this tensor