Package org.flag4j.core.dense_base

Class ComplexDenseTensorBase<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

java.lang.Object

org.flag4j.core.TensorBase<T,T,T,T,Y,CNumber[],CNumber>

org.flag4j.core.dense_base.DenseTensorBase<T,T,Y,CNumber[],CNumber>

org.flag4j.core.dense_base.ComplexDenseTensorBase<T,Y>

Type Parameters:

T - Type of this tensor.

Y - Real Tensor type.

All Implemented Interfaces:

Serializable, ComplexTensorMixin<T,Y>, DenseMixin<CNumber>, TensorComparisonsMixin, TensorManipulationsMixin<T>, TensorOperationsMixin<T,T,T,T,Y,CNumber>, TensorPropertiesMixin

Direct Known Subclasses:

CMatrix, CTensor, CVector

public abstract class ComplexDenseTensorBase<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>
extends DenseTensorBase<T,T,Y,CNumber[],CNumber>
implements ComplexTensorMixin<T,Y>

The base class for all complex dense tensors. This includes complex dense matrices and vectors.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.flag4j.core.TensorBase

DEFAULT_ROUND_TO_ZERO_THRESHOLD, entries, shape

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ComplexDenseTensorBase(Shape shape, CNumber[] entries)	Creates a complex dense tensor with specified entries and shape.

Method Summary

Modifier and Type	Method	Description
Y	abs()	Computes the element-wise absolute value/magnitude of a tensor.
T	add(double a)	Adds specified value to all entries of this tensor.
T	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.
void	addEq(Double b)	Subtracts a specified value from all entries of this tensor and stores the result in this tensor.
void	addEq(CNumber b)	Subtracts a specified value from all entries of this tensor and stores the result in this tensor.
void	addEq(T B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
boolean	allClose(T tensor, double relTol, double absTol)	Checks if all entries of this tensor are close to the entries of the argument tensor.
int[]	argMax()	Finds the indices of the maximum value in this tensor.
int[]	argMin()	Finds the indices of the minimum value in this tensor.
T	conj()	Computes the complex conjugate of a tensor.
T	copy()	Creates a deep copy of this tensor.
T	div(double divisor)	Computes the scalar division of a tensor.
T	div(CNumber divisor)	Computes the scalar division of a tensor.
T	elemDiv(T B)	Computes the element-wise division between two tensors.
T	elemMult(T B)	Computes the element-wise multiplication between two tensors.
CNumber	get(int... indices)	Gets the element in this tensor at the specified indices.
int	hashCode()	Creates a hashcode for this matrix.
boolean	isComplex()	Checks if this tensor contains at least one complex entry.
boolean	isOnes()	Checks if this tensor only contains ones.
boolean	isReal()	Checks if this tensor has only real valued entries.
boolean	isZeros()	Checks if this tensor only contains zeros.
protected abstract Y	makeRealTensor(Shape shape, double[] entries)	Factory to create a real tensor with the specified shape and size.
double	max()	Finds the maximum value in this tensor.
double	maxAbs()	Finds the maximum value, in absolute value, in this tensor.
double	min()	Finds the minimum value in this tensor.
double	minAbs()	Finds the minimum value, in absolute value, in this tensor.
T	mult(double factor)	Computes scalar multiplication of a tensor.
T	mult(CNumber factor)	Computes scalar multiplication of a tensor.
T	recip()	Computes the reciprocals, element-wise, of a tensor.
T	reshape(int... shape)	Copies and reshapes tensor if possible.
T	reshape(Shape shape)	Copies and reshapes tensor if possible.
T	round()	Rounds each entry of this tensor to the nearest whole number.
T	round(int precision)	Rounds each entry in this tensor to the nearest whole number.
T	roundToZero()	Rounds values in this tensor which are close to zero in absolute value to zero.
T	roundToZero(double threshold)	Rounds values which are close to zero in absolute value to zero.
T	set(double value, int... indices)	Sets an index of this tensor to a specified value.
T	set(CNumber value, int... indices)	Sets an index of this tensor to a specified value.
T	sqrt()	Computes the element-wise square root of a tensor.
T	sub(double a)	Adds specified value to all entries of this tensor.
T	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.
void	subEq(Double b)	Subtracts a specified value from all entries of this tensor and stores the result in this tensor.
void	subEq(CNumber b)	Subtracts a specified value from all entries of this tensor and stores the result in this tensor.
void	subEq(T B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
CNumber	sum()	Sums together all entries in the tensor.
Y	toReal()	Converts a complex tensor to a real matrix.
Y	toRealSafe()	Converts a complex tensor to a real matrix safely.

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

makeTensor, toCoo

Methods inherited from class org.flag4j.core.TensorBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flag4j.core.ComplexTensorMixin

H, hermTranspose

Methods inherited from interface org.flag4j.core.TensorComparisonsMixin

equals

Methods inherited from interface org.flag4j.core.TensorManipulationsMixin

flatten, flatten

Methods inherited from interface org.flag4j.core.TensorOperationsMixin

T, transpose

Constructor Details

ComplexDenseTensorBase

protected ComplexDenseTensorBase(Shape shape,
 CNumber[] entries)

Creates a complex dense tensor with specified entries and shape.

Parameters:

shape - Shape of this tensor.

entries - Entries of this tensor. The number of entries must match the product of all shape dimensions.

Throws:

IllegalArgumentException - If the number of entries does not equal the product of dimensions in the shape.

Method Details

makeRealTensor

protected abstract Y makeRealTensor(Shape shape,
 double[] entries)

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

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.

min

public double min()

Description copied from interface: TensorPropertiesMixin

Finds the minimum value in this tensor. If this tensor is complex, then this method finds the smallest value in magnitude.

Specified by:

min in interface TensorPropertiesMixin

Returns:

The minimum value (smallest in magnitude for a complex valued tensor) in this tensor.

max

public double max()

Description copied from interface: TensorPropertiesMixin

Finds the maximum value in this tensor. If this tensor is complex, then this method finds the largest value in magnitude.

Specified by:

max in interface TensorPropertiesMixin

Returns:

The maximum value (largest in magnitude for a complex valued tensor) in this tensor.

minAbs

public double minAbs()

Description copied from interface: TensorPropertiesMixin

Finds the minimum value, in absolute value, in this tensor. If this tensor is complex, then this method is equivalent to TensorPropertiesMixin.min().

Specified by:

minAbs in interface TensorPropertiesMixin

Returns:

The minimum value, in absolute value, in this tensor.

maxAbs

public double maxAbs()

Description copied from interface: TensorPropertiesMixin

Finds the maximum value, in absolute value, in this tensor. If this tensor is complex, then this method is equivalent to TensorPropertiesMixin.max().

Specified by:

maxAbs in interface TensorPropertiesMixin

Returns:

The maximum value, in absolute value, in this tensor.

argMin

public int[] argMin()

Finds the indices of the minimum value in this tensor.

Specified by:

argMin in interface TensorPropertiesMixin

Returns:

The indices of the minimum value in this tensor. If this value occurs multiple times, the indices of the first entry (in row-major ordering) are returned.

argMax

public int[] argMax()

Finds the indices of the maximum value in this tensor.

Specified by:

argMax in interface TensorPropertiesMixin

Returns:

The indices of the maximum value in this tensor. If this value occurs multiple times, the indices of the first entry (in row-major ordering) are returned.

isZeros

public boolean isZeros()

Description copied from interface: TensorComparisonsMixin

Checks if this tensor only contains zeros.

Specified by:

isZeros in interface TensorComparisonsMixin

Returns:

True if this tensor only contains zeros. Otherwise, returns false.

isOnes

public boolean isOnes()

Description copied from interface: TensorComparisonsMixin

Checks if this tensor only contains ones.

Specified by:

isOnes in interface TensorComparisonsMixin

Returns:

True if this tensor only contains ones. Otherwise, returns false.

hashCode

public int hashCode()

Creates a hashcode for this matrix. Note, method adds Arrays.hashCode(double[]) applied on the underlying data array and the underlying shape array.

Overrides:

hashCode in class Object

Returns:

The hashcode for this matrix.

isReal

public boolean isReal()

Checks if this tensor has only real valued entries.

Specified by:

isReal in interface ComplexTensorMixin<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

Returns:

True if this tensor contains NO complex entries. Otherwise, returns false.

isComplex

public boolean isComplex()

Checks if this tensor contains at least one complex entry.

Specified by:

isComplex in interface ComplexTensorMixin<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

Returns:

True if this tensor contains at least one complex entry. Otherwise, returns false.

set

public T set(double value,
 int... indices)

Sets an index of this tensor to a specified value.

Specified by:

set in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

value - Value to set.

indices - The indices of this tensor for which to set the value.

Returns:

A reference to this tensor.

set

public T set(CNumber value,
 int... indices)

Sets an index of this tensor to a specified value.

Specified by:

set in interface ComplexTensorMixin<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

Parameters:

value - Value to set.

indices - The indices of this tensor for which to set the value.

Returns:

A reference to this tensor.

get

public CNumber get(int... indices)

Gets the element in this tensor at the specified indices.

Specified by:

get in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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.

toReal

public Y toReal()

Converts a complex tensor to a real matrix. The imaginary component of any complex value will be ignored.

Specified by:

toReal in interface ComplexTensorMixin<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

Returns:

A tensor of the same size containing only the real components of this tensor.

See Also:

• toRealSafe()

toRealSafe

public Y toRealSafe()

Converts a complex tensor to a real matrix safely. That is, first checks if the tensor only contains real values and then converts to a real tensor. However, if non-real value exist, then an error is thrown.

Specified by:

toRealSafe in interface ComplexTensorMixin<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

Returns:

A tensor of the same size containing only the real components of this tensor.

Throws:

RuntimeException - If this tensor contains at least one non-real value.

See Also:

• toReal()

copy

public T copy()

Creates a deep copy of this tensor.

Specified by:

copy in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

Returns:

A deep copy of this tensor.

recip

public T recip()

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

Specified by:

recip in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

Returns:

A tensor containing the reciprocal elements of this tensor.

Throws:

ArithmeticException - If this tensor contains any zeros.

sum

public CNumber sum()

Sums together all entries in the tensor.

Specified by:

sum in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

Returns:

The sum of all entries in this tensor.

sqrt

public T sqrt()

Computes the element-wise square root of a tensor.

Specified by:

sqrt in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public Y abs()

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

Specified by:

abs in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

Returns:

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

conj

public T conj()

Computes the complex conjugate of a tensor.

Specified by:

conj in interface ComplexTensorMixin<T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>>

Returns:

The complex conjugate of this tensor.

add

public T add(T B)

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

Specified by:

add in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public T add(CNumber a)

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public T sub(T B)

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

Specified by:

sub in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public T sub(double a)

Adds specified value to all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public T sub(CNumber a)

Subtracts a specified value from all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public T mult(double factor)

Computes scalar multiplication of a tensor.

Specified by:

mult in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

Parameters:

factor - Scalar value to multiply with tensor.

Returns:

The result of multiplying this tensor by the specified scalar.

mult

public T mult(CNumber factor)

Computes scalar multiplication of a tensor.

Specified by:

mult in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

Parameters:

factor - Scalar value to multiply with tensor.

Returns:

The result of multiplying this tensor by the specified scalar.

div

public T div(double divisor)

Computes the scalar division of a tensor.

Specified by:

div in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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

public T div(CNumber divisor)

Computes the scalar division of a tensor.

Specified by:

div in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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.

elemMult

public T elemMult(T B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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 T elemDiv(T B)

Computes the element-wise division between two tensors.

Specified by:

elemDiv in interface TensorOperationsMixin<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber>

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.

addEq

public void addEq(T B)

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

Specified by:

addEq in class DenseTensorBase<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber[],CNumber>

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

addEq

public void addEq(CNumber b)

Subtracts a specified value from all entries of this tensor and stores the result in this tensor.

Specified by:

addEq in interface DenseMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

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

addEq

public void addEq(Double b)

Subtracts a specified value from all entries of this tensor and stores the result in this tensor.

Specified by:

addEq in interface DenseMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

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

subEq

public void subEq(T B)

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

Specified by:

subEq in class DenseTensorBase<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber[],CNumber>

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

subEq

public void subEq(CNumber b)

Subtracts a specified value from all entries of this tensor and stores the result in this tensor.

Specified by:

subEq in interface DenseMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

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

subEq

public void subEq(Double b)

Subtracts a specified value from all entries of this tensor and stores the result in this tensor.

Specified by:

subEq in interface DenseMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

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

reshape

public T reshape(int... shape)

Copies and reshapes tensor if possible. The total number of entries in this tensor must match the total number of entries in the reshaped tensor.

Specified by:

reshape in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

shape - Shape of the new tensor.

Returns:

A tensor which is equivalent to this tensor but with the specified shape.

Throws:

IllegalArgumentException - If this tensor cannot be reshaped to the specified dimensions.

reshape

public T reshape(Shape shape)

Copies and reshapes tensor if possible. The total number of entries in this tensor must match the total number of entries in the reshaped tensor.

Specified by:

reshape in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

shape - Shape of the new tensor.

Returns:

A tensor which is equivalent to this tensor but with the specified shape.

Throws:

IllegalArgumentException - If this tensor cannot be reshaped to the specified dimensions.

round

public T round()

Description copied from interface: TensorManipulationsMixin

Rounds each entry of this tensor to the nearest whole number.

Specified by:

round in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Returns:

A copy of this tensor with each entry rounded to the nearest whole number.

See Also:

• TensorManipulationsMixin.round(int)
• TensorManipulationsMixin.roundToZero()
• TensorManipulationsMixin.roundToZero(double)

round

public T round(int precision)

Description copied from interface: TensorManipulationsMixin

Rounds each entry in this tensor to the nearest whole number.

Specified by:

round in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

precision - The number of decimal places to round to. This value must be non-negative.

Returns:

A copy of this matrix with rounded values.

See Also:

• TensorManipulationsMixin.round()
• TensorManipulationsMixin.roundToZero()
• TensorManipulationsMixin.roundToZero(double)

roundToZero

public T roundToZero()

Description copied from interface: TensorManipulationsMixin

Rounds values in this tensor which are close to zero in absolute value to zero. If the matrix is complex, both the real and imaginary components will be rounded independently. By default, the values must be within 1.0*E^-12 of zero. To specify a threshold value see TensorManipulationsMixin.roundToZero(double).

Specified by:

roundToZero in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Returns:

A copy of this matrix with rounded values.

See Also:

• TensorManipulationsMixin.roundToZero(double)
• TensorManipulationsMixin.round()
• TensorManipulationsMixin.round(int)

roundToZero

public T roundToZero(double threshold)

Description copied from interface: TensorManipulationsMixin

Rounds values which are close to zero in absolute value to zero. If the matrix is complex, both the real and imaginary components will be rounded independently.

Specified by:

roundToZero in interface TensorManipulationsMixin<T extends ComplexDenseTensorBase<T,Y>>

Parameters:

threshold - Threshold for rounding values to zero. That is, if a value in this matrix is less than the threshold in absolute value then it will be rounded to zero. This value must be non-negative.

Returns:

A copy of this matrix with rounded values.

See Also:

• TensorManipulationsMixin.roundToZero()
• TensorManipulationsMixin.round()
• TensorManipulationsMixin.round(int)

allClose

public boolean allClose(T tensor,
 double relTol,
 double absTol)

Description copied from class: TensorBase

Checks if all entries of this tensor are close to the entries of the argument tensor.

Specified by:

allClose in class TensorBase<T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,T extends ComplexDenseTensorBase<T,Y>,Y extends RealDenseTensorBase<Y,T>,CNumber[],CNumber>

Parameters:

tensor - Tensor to compare this tensor to.

relTol - Relative tolerance.

absTol - Absolute tolerance.

Returns:

True if the argument tensor is the same shape as this tensor and all entries are 'close', i.e. elements a and b at the same positions in the two tensors respectively satisfy |a-b| <= (atol + rtol*|b|). Otherwise, returns false.

See Also:

• TensorBase.allClose(Object)