Package org.flag4j.core.dense_base

Class DenseTensorBase<T,W,Y,D extends Serializable,X extends Number>

java.lang.Object

org.flag4j.core.TensorBase<T,T,W,W,Y,D,X>

org.flag4j.core.dense_base.DenseTensorBase<T,W,Y,D,X>

Type Parameters:

T - Type of this tensor.

W - Complex Tensor type.

Y - Real Tensor type.

D - Type of the storage data structure for the tensor. The common use case will be an array or list-like data structure.

X - The type of individual entry within the D data structure

All Implemented Interfaces:

Serializable, DenseMixin<X>, TensorComparisonsMixin, TensorManipulationsMixin<T>, TensorOperationsMixin<T,T,W,W,Y,X>, TensorPropertiesMixin

Direct Known Subclasses:

ComplexDenseTensorBase, RealDenseTensorBase

public abstract class DenseTensorBase<T,W,Y,D extends Serializable,X extends Number>
extends TensorBase<T,T,W,W,Y,D,X>
implements DenseMixin<X>

This is the base class for all dense tensors.

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	DenseTensorBase(Shape shape, D entries)	Creates a dense tensor with specified entries and shape.

Method Summary

Modifier and Type	Method	Description
abstract void	addEq(T B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
protected abstract T	makeTensor(Shape shape, D entries)	Factory to create a tensor with the specified shape and size.
abstract void	subEq(T B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.
abstract SparseTensorBase<?,?,?,?,?,?,?>	toCoo()	Converts this dense tensor to an equivalent sparse COO tensor.

Methods inherited from class org.flag4j.core.TensorBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flag4j.core.dense_base.DenseMixin

addEq, addEq, subEq, subEq

Methods inherited from interface org.flag4j.core.TensorComparisonsMixin

equals, isOnes, isZeros

Methods inherited from interface org.flag4j.core.TensorManipulationsMixin

flatten, flatten, reshape, reshape, round, round, roundToZero, roundToZero, set

Methods inherited from interface org.flag4j.core.TensorOperationsMixin

abs, add, add, add, copy, div, div, elemDiv, elemMult, get, mult, mult, recip, sqrt, sub, sub, sub, sum, T, transpose

Methods inherited from interface org.flag4j.core.TensorPropertiesMixin

argMax, argMin, max, maxAbs, min, minAbs

Constructor Details

DenseTensorBase

protected DenseTensorBase(Shape shape,
 D entries)

Creates a 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. Warning: this is not enforced.

Method Details

makeTensor

protected abstract T makeTensor(Shape shape,
 D entries)

Factory to create a 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.

addEq

public abstract void addEq(T 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 abstract void subEq(T 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.

toCoo

public abstract SparseTensorBase<?,?,?,?,?,?,?> toCoo()

Converts this dense tensor to an equivalent sparse COO tensor.

Returns:

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