Package org.flag4j.core

Interface TensorExclusiveMixin<T extends TensorBase<T,U,W,?,?,?,?>,U,V,W>

Type Parameters:

T - Tensor type.

U - Dense tensor type.

V - Sparse tensor type.

W - Complex tensor type.

All Known Subinterfaces:

ComplexTensorExclusiveMixin<T>

All Known Implementing Classes:

CooCTensor, CooTensor, CTensor, Tensor

public interface TensorExclusiveMixin<T extends TensorBase<T,U,W,?,?,?,?>,U,V,W>

This interface contains several methods which should be implemented by all tensors which are NOT a matrix or vector.

Method Summary

Modifier and Type	Method	Description
CTensor	add(CTensor B)	Computes the element-wise addition between two tensors of the same rank.
U	add(Tensor B)	Computes the element-wise addition between two tensors of the same rank.
W	add(CooCTensor B)	Computes the element-wise addition between two tensors of the same rank.
T	add(CooTensor B)	Computes the element-wise addition between two tensors of the same rank.
W	elemDiv(CTensor B)	Computes the element-wise division between two tensors.
T	elemDiv(Tensor B)	Computes the element-wise division between two tensors.
CTensor	elemMult(CTensor B)	Computes the element-wise multiplication between two tensors.
T	elemMult(Tensor B)	Computes the element-wise multiplication between two tensors.
CooCTensor	elemMult(CooCTensor B)	Computes the element-wise multiplication between two tensors.
V	elemMult(CooTensor B)	Computes the element-wise multiplication between two tensors.
int	getRank()	Gets the rank of this tensor.
CTensor	sub(CTensor B)	Computes the element-wise subtraction between two tensors of the same rank.
U	sub(Tensor B)	Computes the element-wise addition between two tensors of the same rank.
W	sub(CooCTensor B)	Computes the element-wise subtraction between two tensors of the same rank.
T	sub(CooTensor B)	Computes the element-wise subtraction between two tensors of the same rank.
T	T(int... axes)	Computes the transpose of this tensor.
T	T(int axis1, int axis2)	Computes the transpose of a tensor.
default U	tensorDot(T src2)	Computes the tensor dot product of this tensor with a second tensor.
default U	tensorDot(T src2, int axes)	Computes the tensor contraction of this tensor with a specified tensor over the specified axes.
U	tensorDot(T src2, int[] aAxes, int[] bAxes)	Computes the tensor contraction of this tensor with a specified tensor over the specified set of axes.
default U	tensorDot(T src2, int aAxis, int bAxis)	Computes the tensor contraction of this tensor with a specified tensor over the specified axes.
default U	tensorInv()	Computes the 'inverse' of this tensor.
U	tensorInv(int numIndices)	Computes the 'inverse' of this tensor.
default T	transpose(int... axes)	Computes the transpose of this tensor.
default T	transpose(int axis1, int axis2)	Computes the transpose of a tensor.

Method Details

tensorDot

default U tensorDot(T src2,
 int axes)

Computes the tensor contraction of this tensor with a specified tensor over the specified axes. If axes=N, then the product sums will be computed along the last N dimensions of this tensor and the first N dimensions of the src2 tensor.

Parameters:

src2 - Tensor to contract with this tensor.

axes - Axes specifying the number of axes to compute the tensor dot product over. If axes=N, then the product sums will be computed along the last N dimensions of this tensor and the first N dimensions of.

Returns:

The tensor dot product over the specified axes.

Throws:

IllegalArgumentException - If the two tensors shapes do not match along the specified axes aAxis and bAxis.

IllegalArgumentException - If either axis is out of bounds of the corresponding tensor.

tensorDot

default U tensorDot(T src2,
 int aAxis,
 int bAxis)

Computes the tensor contraction of this tensor with a specified tensor over the specified axes. That is, computes the sum of products between the two tensors along the specified axes.

Parameters:

src2 - Tensor to contract with this tensor.

aAxis - Axis along which to compute products for this tensor.

bAxis - Axis along which to compute products for src2 tensor.

Returns:

The tensor dot product over the specified axes.

Throws:

IllegalArgumentException - If the two tensors shapes do not match along the specified axes aAxis and bAxis.

IllegalArgumentException - If either axis is out of bounds of the corresponding tensor.

tensorDot

U tensorDot(T src2,
 int[] aAxes,
 int[] bAxes)

Computes the tensor contraction of this tensor with a specified tensor over the specified set of axes. That is, computes the sum of products between the two tensors along the specified set of axes.

Parameters:

src2 - Tensor to contract with this tensor.

aAxes - Axes along which to compute products for this tensor.

bAxes - Axes along which to compute products for src2 tensor.

Returns:

The tensor dot product over the specified axes.

Throws:

IllegalArgumentException - If the two tensors shapes do not match along the specified axes pairwise in aAxes and bAxes.

IllegalArgumentException - If aAxes and bAxes do not match in length, or if any of the axes are out of bounds for the corresponding tensor.

tensorDot

default U tensorDot(T src2)

Computes the tensor dot product of this tensor with a second tensor. That is, sums the product of two tensor elements over the last axis of this tensor and the second-to-last axis of src2. If both tensors are rank 2, this is equivalent to matrix multiplication.

Parameters:

src2 - Tensor to compute dot product with this tensor.

Returns:

The tensor dot product over the last axis of this tensor and the second to last axis of src2.

Throws:

IllegalArgumentException - If this tensors shape along the last axis does not match src2 shape along the second-to-last axis.

transpose

default T transpose(int axis1,
 int axis2)

Computes the transpose of a tensor. Same as T(int, int). In the context of a tensor, this exchanges the specified axes. Also see transpose() and T() to exchange first and last axes.

Parameters:

axis1 - First axis to exchange.

axis2 - Second axis to exchange.

Returns:

The transpose of this tensor.

T

T T(int axis1,
 int axis2)

Computes the transpose of a tensor. Same as transpose(int, int). In the context of a tensor, this exchanges the specified axes. Also see TensorOperationsMixin.transpose() and TensorOperationsMixin.T() to exchange first and last axes.

Parameters:

axis1 - First axis to exchange.

axis2 - Second axis to exchange.

Returns:

The transpose of this tensor.

transpose

default T transpose(int... axes)

Computes the transpose of this tensor. That is, interchanges the axes of this tensor so that it matches the specified axes permutation. Same as T(int[]).

Parameters:

axes - Permutation of tensor axis. If the tensor has rank N, then this must be an array of length N which is a permutation of {0, 1, 2, ..., N-1}.

Returns:

The transpose of this tensor with its axes permuted by the axes array.

Throws:

IllegalArgumentException - If axes is not a permutation of {1, 2, 3, ... N-1}.

T

T T(int... axes)

Computes the transpose of this tensor. That is, interchanges the axes of this tensor so that it matches the specified axes permutation. Same as transpose(int[]).

Parameters:

axes - Permutation of tensor axis. If the tensor has rank N, then this must be an array of length N which is a permutation of {0, 1, 2, ..., N-1}.

Returns:

The transpose of this tensor with its axes permuted by the axes array.

Throws:

IllegalArgumentException - If axes is not a permutation of {1, 2, 3, ... N-1}.

add

T add(CooTensor B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

add

U add(Tensor B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

U sub(Tensor B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

add

CTensor add(CTensor B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

add

W add(CooCTensor B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

T sub(CooTensor B)

Computes the element-wise subtraction between two tensors of the same rank.

Parameters:

B - Second tensor in element-wise subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

CTensor sub(CTensor B)

Computes the element-wise subtraction between two tensors of the same rank.

Parameters:

B - Second tensor in element-wise subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

W sub(CooCTensor B)

Computes the element-wise subtraction between two tensors of the same rank.

Parameters:

B - Second tensor in element-wise subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

elemMult

T elemMult(Tensor B)

Computes the element-wise multiplication between two tensors.

Parameters:

B - Tensor to element-wise multiply to this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If the tensors do not have the same shape.

elemMult

V elemMult(CooTensor B)

Computes the element-wise multiplication between two tensors.

Parameters:

B - Tensor to element-wise multiply to this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If the tensors do not have the same shape.

elemMult

CTensor elemMult(CTensor B)

Computes the element-wise multiplication between two tensors.

Parameters:

B - Tensor to element-wise multiply to this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If the tensors do not have the same shape.

elemMult

CooCTensor elemMult(CooCTensor B)

Computes the element-wise multiplication between two tensors.

Parameters:

B - Tensor to element-wise multiply to this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If the tensors do not have the same shape.

elemDiv

W elemDiv(CTensor B)

Computes the element-wise division between two tensors.

Parameters:

B - Tensor to element-wise divide with this tensor.

Returns:

The result of the element-wise tensor division.

Throws:

IllegalArgumentException - If the tensors do not have the same shape.

elemDiv

T elemDiv(Tensor B)

Computes the element-wise division between two tensors.

Parameters:

B - Tensor to element-wise divide from this tensor.

Returns:

The result of the element-wise tensor division.

Throws:

IllegalArgumentException - If the tensors do not have the same shape.

tensorInv

default U tensorInv()

Computes the 'inverse' of this tensor. That is, computes the tensor X=this.tensorInv() such that this.tensorDot(X, 2) is the 'identity' tensor for the tensor dot product operation. A tensor I is the identity for a tensor dot product if this.tensorDot(I, 2).equals(this).

Returns:

The 'inverse' of this tensor as defined in the above sense.

See Also:

• tensorInv(int)

tensorInv

U tensorInv(int numIndices)

Computes the 'inverse' of this tensor. That is, computes the tensor X=this.tensorInv() such that this.tensorDot(X, numIndices) is the 'identity' tensor for the tensor dot product operation. A tensor I is the identity for a tensor dot product if this.tensorDot(I, numIndices).equals(this).

Parameters:

numIndices - The number of first numIndices which are involved in the inverse sum.

Returns:

The 'inverse' of this tensor as defined in the above sense.

See Also:

• tensorInv()

getRank

int getRank()

Gets the rank of this tensor. The rank is the number of indices required to uniquely identify an element in the tensor.

Note, this differs from matrix rank.

Returns:

The rank of this tensor.