Package org.flag4j.arrays.dense

Class CTensor

java.lang.Object

org.flag4j.core.TensorBase<CTensor,CTensor,CTensor,CTensor,Tensor,CNumber[],CNumber>

org.flag4j.core.dense_base.DenseTensorBase<CTensor,CTensor,Tensor,CNumber[],CNumber>

org.flag4j.core.dense_base.ComplexDenseTensorBase<CTensor,Tensor>

org.flag4j.arrays.dense.CTensor

All Implemented Interfaces:

Serializable, ComplexTensorExclusiveMixin<CTensor>, ComplexTensorMixin<CTensor,Tensor>, DenseMixin<CNumber>, TensorComparisonsMixin, TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>, TensorManipulationsMixin<CTensor>, TensorOperationsMixin<CTensor,CTensor,CTensor,CTensor,Tensor,CNumber>, TensorPropertiesMixin

public class CTensor
extends ComplexDenseTensorBase<CTensor,Tensor>
implements ComplexTensorExclusiveMixin<CTensor>

Complex dense tensor.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.flag4j.core.TensorBase

DEFAULT_ROUND_TO_ZERO_THRESHOLD, entries, shape

Constructor Summary

Constructors

Constructor	Description
CTensor(CTensor A)	Creates a complex tensor whose shape and entries are specified by another tensor.
CTensor(Tensor A)	Creates a complex tensor whose shape and entries are specified by another tensor.
CTensor(Shape shape)	Constructs a tensor with given shape filled with zeros.
CTensor(Shape shape, double fillValue)	Constructs a tensor with given shape filled with specified values.
CTensor(Shape shape, double[] entries)	Constructs a tensor with given shape filled with specified values.
CTensor(Shape shape, int[] entries)	Constructs a tensor with given shape filled with specified values.
CTensor(Shape shape, CNumber fillValue)	Constructs a tensor with given shape filled with specified values.
CTensor(Shape shape, CNumber[] entries)	Constructs a tensor with given shape filled with specified values.

Method Summary

Modifier and Type	Method	Description
CTensor	add(Tensor B)	Computes the element-wise addition between two tensors of the same rank.
CTensor	add(CooCTensor B)	Computes the element-wise addition between two tensors of the same rank.
CTensor	add(CooTensor B)	Computes the element-wise addition between two tensors of the same rank.
void	addEq(Tensor B)	Computes the element-wise addition of two tensors of the same rank and stores the result in this tensor.
void	addEq(CooCTensor B)	Computes the element-wise addition of two tensors of the same rank and stores the result in this tensor.
void	addEq(CooTensor B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
CTensor	elemDiv(Tensor B)	Computes the element-wise division between two tensors.
CTensor	elemMult(Tensor B)	Computes the element-wise multiplication between two tensors.
CooCTensor	elemMult(CooCTensor B)	Computes the element-wise multiplication between two tensors.
CooCTensor	elemMult(CooTensor B)	Computes the element-wise multiplication between two tensors.
boolean	equals(Object object)	Checks if an object is equal to this tensor object.
CTensor	flatten()	Flattens tensor to single dimension.
CTensor	flatten(int axis)	Flattens a tensor along the specified axis.
protected CTensor	getSelf()	Simply returns a reference of this tensor.
CTensor	H()	Computes the conjugate transpose of this tensor.
CTensor	H(int... axes)	Computes the conjugate transpose of this tensor.
CTensor	H(int axis1, int axis2)	Computes the transpose of a tensor.
protected Tensor	makeRealTensor(Shape shape, double[] entries)	Factory to create a real tensor with the specified shape and size.
protected CTensor	makeTensor(Shape shape, CNumber[] entries)	Factory to create a tensor with the specified shape and size.
CTensor	sub(Tensor B)	Computes the element-wise addition between two tensors of the same rank.
CTensor	sub(CooCTensor B)	Computes the element-wise subtraction between two tensors of the same rank.
CTensor	sub(CooTensor B)	Computes the element-wise subtraction between two tensors of the same rank.
void	subEq(Tensor B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
void	subEq(CooCTensor B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
void	subEq(CooTensor B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
CTensor	T()	Computes the transpose of a tensor.
CTensor	T(int... axes)	Computes the transpose of this tensor.
CTensor	T(int axis1, int axis2)	Computes the transpose of a tensor.
CTensor	tensorDot(CTensor src2)	Computes the tensor dot product of this tensor with a second tensor.
CTensor	tensorDot(CTensor src2, int[] aAxes, int[] bAxes)	Computes the tensor contraction of this tensor with a specified tensor over the specified set of axes.
CTensor	tensorInv(int numIndices)	Computes the 'inverse' of this tensor.
CooCTensor	toCoo()	Converts this dense tensor to an equivalent sparse COO tensor.
CMatrix	toMatrix()	Converts this tensor to an equivalent matrix.
CMatrix	toMatrix(Shape matShape)	Converts this tensor to a matrix with the specified shape.
String	toString()	Formats this tensor as a human-readable string.
CVector	toVector()	Converts this tensor to an equivalent vector.

Methods inherited from class org.flag4j.core.dense_base.ComplexDenseTensorBase

abs, add, add, add, addEq, addEq, addEq, allClose, argMax, argMin, conj, copy, div, div, elemDiv, elemMult, get, hashCode, isComplex, isOnes, isReal, isZeros, max, maxAbs, min, minAbs, mult, mult, recip, reshape, reshape, round, round, roundToZero, roundToZero, set, set, sqrt, sub, sub, sub, subEq, subEq, subEq, sum, toReal, toRealSafe

Methods inherited from class org.flag4j.core.TensorBase

allClose, getEntries, getRank, getShape, sameLength, sameShape, tensorEquals, totalEntries

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flag4j.core.ComplexTensorExclusiveMixin

hermTranspose, hermTranspose

Methods inherited from interface org.flag4j.core.ComplexTensorMixin

hermTranspose

Methods inherited from interface org.flag4j.core.TensorExclusiveMixin

add, elemDiv, elemMult, getRank, sub, tensorDot, tensorDot, tensorInv, transpose, transpose

Methods inherited from interface org.flag4j.core.TensorOperationsMixin

transpose

Constructor Details

CTensor

public CTensor(Shape shape)

Constructs a tensor with given shape filled with zeros.

Parameters:

shape - Shape of the tensor.

CTensor

public CTensor(Shape shape,
 double fillValue)

Constructs a tensor with given shape filled with specified values.

Parameters:

shape - Shape of the tensor.

fillValue - Value to fill tensor with.

CTensor

public CTensor(Shape shape,
 CNumber fillValue)

Constructs a tensor with given shape filled with specified values.

Parameters:

shape - Shape of the tensor.

fillValue - Value to fill tensor with.

CTensor

public CTensor(Shape shape,
 double[] entries)

Constructs a tensor with given shape filled with specified values.

Parameters:

shape - Shape of the tensor.

entries - Entries of the vector.

Throws:

IllegalArgumentException - If the shape does not match the number of entries.

CTensor

public CTensor(Shape shape,
 int[] entries)

Constructs a tensor with given shape filled with specified values.

Parameters:

shape - Shape of the tensor.

entries - Entries of the vector.

Throws:

IllegalArgumentException - If the shape does not match the number of entries.

CTensor

public CTensor(Shape shape,
 CNumber[] entries)

Constructs a tensor with given shape filled with specified values. Note, unlike other constructors, the entries parameter is not copied.

Parameters:

shape - Shape of the tensor.

entries - Entries of the vector.

Throws:

IllegalArgumentException - If the shape does not match the number of entries.

CTensor

public CTensor(Tensor A)

Creates a complex tensor whose shape and entries are specified by another tensor.

Parameters:

A - Tensor specifying shape and entries.

CTensor

public CTensor(CTensor A)

Creates a complex tensor whose shape and entries are specified by another tensor.

Parameters:

A - Tensor specifying shape and entries.

Method Details

makeTensor

protected CTensor makeTensor(Shape shape,
 CNumber[] entries)

Factory to create a tensor with the specified shape and size.

Specified by:

makeTensor in class DenseTensorBase<CTensor,CTensor,Tensor,CNumber[],CNumber>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

toCoo

public CooCTensor toCoo()

Converts this dense tensor to an equivalent sparse COO tensor.

Specified by:

toCoo in class DenseTensorBase<CTensor,CTensor,Tensor,CNumber[],CNumber>

Returns:

A sparse COO tensor which is equivalent to this dense tensor.

getSelf

protected CTensor getSelf()

Simply returns a reference of this tensor.

Specified by:

getSelf in class TensorBase<CTensor,CTensor,CTensor,CTensor,Tensor,CNumber[],CNumber>

Returns:

A reference to this tensor.

makeRealTensor

protected Tensor makeRealTensor(Shape shape,
 double[] entries)

Factory to create a real tensor with the specified shape and size.

Specified by:

makeRealTensor in class ComplexDenseTensorBase<CTensor,Tensor>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

flatten

public CTensor flatten(int axis)

Flattens a tensor along the specified axis. The resulting tensor will have the same rank but only have values along the single specified axis.

Specified by:

flatten in interface TensorManipulationsMixin<CTensor>

Parameters:

axis - Axis along which to flatten tensor.

Throws:

ArrayIndexOutOfBoundsException - If the axis is not positive or larger than this.TensorBase.getRank()-1.

equals

public boolean equals(Object object)

Checks if an object is equal to this tensor object.

Specified by:

equals in interface TensorComparisonsMixin

Overrides:

equals in class Object

Parameters:

object - Object to check equality with this tensor.

Returns:

True if the two tensors have the same shape, are numerically equivalent, and are of type CTensor. False otherwise.

H

public CTensor H()

Computes the conjugate transpose of this tensor. In the context of a tensor, this swaps the first and last axes and takes the complex conjugate of the elements along these axes. Same as ComplexTensorMixin.hermTranspose().

Specified by:

H in interface ComplexTensorMixin<CTensor,Tensor>

Returns:

The complex transpose of this tensor.

H

public CTensor H(int axis1,
 int axis2)

Computes the transpose of a tensor. Same as ComplexTensorExclusiveMixin.hermTranspose(int, int). In the context of a tensor, this exchanges the specified axes and takes the complex conjugate of elements along those axes. Also see ComplexTensorMixin.hermTranspose() and H() to conjugate transpose first and last axes.

Specified by:

H in interface ComplexTensorExclusiveMixin<CTensor>

Parameters:

axis1 - First axis to exchange and apply complex conjugate.

axis2 - Second axis to exchange and apply complex conjugate.

Returns:

The conjugate transpose of this tensor.

H

public CTensor H(int... axes)

Computes the conjugate transpose of this tensor. That is, interchanges the axes of this tensor so that it matches the specified axes permutation and takes the complex conjugate of the elements of these axes. Same as ComplexTensorExclusiveMixin.hermTranspose(int[])}.

Specified by:

H in interface ComplexTensorExclusiveMixin<CTensor>

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 conjugate 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}.

addEq

public void addEq(Tensor B)

Computes the element-wise addition of two tensors of the same rank and stores the result in this tensor.

Specified by:

addEq in interface ComplexTensorExclusiveMixin<CTensor>

Parameters:

B - Second tensor in the addition.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

addEq

public void addEq(CooCTensor B)

Computes the element-wise addition of two tensors of the same rank and stores the result in this tensor.

Specified by:

addEq in interface ComplexTensorExclusiveMixin<CTensor>

Parameters:

B - Second tensor in the addition.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

subEq

public void subEq(Tensor B)

Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.

Specified by:

subEq in interface ComplexTensorExclusiveMixin<CTensor>

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

subEq

public void subEq(CooCTensor B)

Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.

Specified by:

subEq in interface ComplexTensorExclusiveMixin<CTensor>

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

T

public CTensor T(int axis1,
 int axis2)

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

Specified by:

T in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

Parameters:

axis1 - First axis to exchange.

axis2 - Second axis to exchange.

Returns:

The transpose of this tensor.

T

public CTensor 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 TensorExclusiveMixin.transpose(int[]).

Specified by:

T in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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}.

tensorDot

public CTensor tensorDot(CTensor 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.

Specified by:

tensorDot in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor tensorDot(CTensor 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.

Specified by:

tensorDot in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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.

add

public CTensor add(CooTensor B)

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

Specified by:

add in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor add(Tensor B)

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

Specified by:

add in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor sub(Tensor B)

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

Specified by:

sub in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor add(CooCTensor B)

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

Specified by:

add in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor sub(CooTensor B)

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

Specified by:

sub in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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.

T

public CTensor T()

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

Specified by:

T in interface TensorOperationsMixin<CTensor,CTensor,CTensor,CTensor,Tensor,CNumber>

Returns:

The transpose of this tensor.

sub

public CTensor sub(CooCTensor B)

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

Specified by:

sub in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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.

addEq

public void addEq(CooTensor B)

Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

subEq

public void subEq(CooTensor B)

Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

elemMult

public CTensor elemMult(Tensor B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CooCTensor elemMult(CooTensor B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CooCTensor elemMult(CooCTensor B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor elemDiv(Tensor B)

Computes the element-wise division between two tensors.

Specified by:

elemDiv in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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

public CTensor 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).

Specified by:

tensorInv in interface TensorExclusiveMixin<CTensor,CTensor,CooCTensor,CTensor>

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:

• TensorExclusiveMixin.tensorInv()

flatten

public CTensor flatten()

Flattens tensor to single dimension. To flatten tensor along a single axis.

Specified by:

flatten in interface TensorManipulationsMixin<CTensor>

Returns:

The flattened tensor.

toVector

public CVector toVector()

Converts this tensor to an equivalent vector. If this tensor is not rank 1, then it will be flattened.

Returns:

A vector equivalent of this tensor.

toMatrix

public CMatrix toMatrix(Shape matShape)

Converts this tensor to a matrix with the specified shape.

Parameters:

matShape - Shape of the resulting matrix. Must be broadcastable with the shape of this tensor.

Returns:

A matrix of shape matShape with the values of this tensor.

toMatrix

public CMatrix toMatrix()

Converts this tensor to an equivalent matrix.

Returns:

If this tensor is rank 2, then the equivalent matrix will be returned. If the tensor is rank 1, then a matrix with a single row will be returned. If the rank is larger than 2, it will be flattened to a single row.

toString

public String toString()

Formats this tensor as a human-readable string. Specifically, a string containing the shape and flatten entries of this tensor.

Overrides:

toString in class Object

Returns:

A human-readable string representing this tensor.