Package org.flag4j.core

Interface TensorOperationsMixin<T,U,W,Z,Y,X extends Number>

Type Parameters:

T - Tensor type.

U - Dense tensor type.

W - Complex tensor type.

Z - Dense complex tensor type.

Y - Real tensor type.

X - Tensor entry type.

All Known Implementing Classes:

CMatrix, ComplexDenseTensorBase, ComplexSparseTensorBase, CooCMatrix, CooCTensor, CooCVector, CooMatrix, CooTensor, CooVector, CsrCMatrix, CsrMatrix, CTensor, CVector, DenseTensorBase, Matrix, RealDenseTensorBase, RealSparseTensorBase, SparseTensorBase, Tensor, TensorBase, Vector

interface TensorOperationsMixin<T,U,W,Z,Y,X extends Number>

This interface specifies operations which all tensors (i.e. matrices and vectors) should implement.

Method Summary

Modifier and Type	Method	Description
Y	abs()	Computes the element-wise absolute value/magnitude of a tensor.
U	add(double a)	Adds specified value to all entries of this tensor.
Z	add(CNumber a)	Adds specified value to all entries of this tensor.
T	add(T B)	Computes the element-wise addition between two tensors of the same rank.
T	copy()	Creates a copy of this tensor.
T	div(double divisor)	Computes the scalar division of a tensor.
W	div(CNumber divisor)	Computes the scalar division of a tensor.
T	elemDiv(U B)	Computes the element-wise division between two tensors.
T	elemMult(T B)	Computes the element-wise multiplication between two tensors.
X	get(int... indices)	Gets the element in this tensor at the specified indices.
T	mult(double factor)	Computes scalar multiplication of a tensor.
W	mult(CNumber factor)	Computes scalar multiplication of a tensor.
T	recip()	Computes the reciprocals, element-wise, of a tensor.
T	sqrt()	Computes the element-wise square root of a tensor.
U	sub(double a)	Adds specified value to all entries of this tensor.
Z	sub(CNumber a)	Subtracts a specified value from all entries of this tensor.
T	sub(T B)	Computes the element-wise subtraction between two tensors of the same rank.
X	sum()	Sums together all entries in the tensor.
T	T()	Computes the transpose of a tensor.
default T	transpose()	Computes the transpose of a tensor.

Method Details

add

T add(T 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(double a)

Adds specified value to all entries of this tensor.

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

add

Z add(CNumber a)

Adds specified value to all entries of this tensor.

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

sub

T sub(T 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

U sub(double a)

Adds specified value to all entries of this tensor.

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

sub

Z sub(CNumber a)

Subtracts a specified value from all entries of this tensor.

Parameters:

a - Value to subtract from all entries of this tensor.

Returns:

The result of subtracting the specified value from each entry of this tensor.

mult

T mult(double factor)

Computes scalar multiplication of a tensor.

Parameters:

factor - Scalar value to multiply with tensor.

Returns:

The result of multiplying this tensor by the specified scalar.

mult

W mult(CNumber factor)

Computes scalar multiplication of a tensor.

Parameters:

factor - Scalar value to multiply with tensor.

Returns:

The result of multiplying this tensor by the specified scalar.

div

T div(double divisor)

Computes the scalar division of a tensor.

Parameters:

divisor - The scalar value to divide tensor by.

Returns:

The result of dividing this tensor by the specified scalar.

Throws:

ArithmeticException - If divisor is zero.

div

W div(CNumber divisor)

Computes the scalar division of a tensor.

Parameters:

divisor - The scalar value to divide tensor by.

Returns:

The result of dividing this tensor by the specified scalar.

Throws:

ArithmeticException - If divisor is zero.

sum

X sum()

Sums together all entries in the tensor.

Returns:

The sum of all entries in this tensor.

sqrt

T sqrt()

Computes the element-wise square root of a tensor.

Returns:

The result of applying an element-wise square root to this tensor. Note, this method will compute the principle square root i.e. the square root with positive real part.

abs

Y abs()

Computes the element-wise absolute value/magnitude of a tensor. If the tensor contains complex values, the magnitude will be computed.

Returns:

The result of applying an element-wise absolute value/magnitude to this tensor.

transpose

default T transpose()

Computes the transpose of a tensor. Same as T().

Returns:

The transpose of this tensor.

T

T T()

Computes the transpose of a tensor. Same as transpose().

Returns:

The transpose of this tensor.

recip

T recip()

Computes the reciprocals, element-wise, of a tensor.

Returns:

A tensor containing the reciprocal elements of this tensor.

Throws:

ArithmeticException - If this tensor contains any zeros.

get

X get(int... indices)

Gets the element in this tensor at the specified indices.

Parameters:

indices - Indices of element.

Returns:

The element at the specified indices.

Throws:

IllegalArgumentException - If the number of indices does not match the rank of this tensor.

copy

T copy()

Creates a copy of this tensor.

Returns:

A copy of this tensor.

elemMult

T elemMult(T 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 this tensor and B do not have the same shape.

elemDiv

T elemDiv(U 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 multiplication.

Throws:

IllegalArgumentException - If this tensor and B do not have the same shape.