Serialized Form

Package org.flag4j.algebraic_structures

Record Class org.flag4j.arrays.Pair

class Pair extends Record implements Serializable

Serialized Fields

first

T first

The field for the first record component.

second

T second

The field for the second record component.

Package org.flag4j.arrays

Class org.flag4j.arrays.Shape

class Shape extends Object implements Serializable

Serialized Fields

dims

int[] dims

An array containing the size of each dimension of this shape.

strides

int[] strides

An array containing the strides of all dimensions within this shape.

totalEntries

BigInteger totalEntries

Total entries of this shape. This is only computed on demand by Shape.totalEntries()

totalEntriesIntExact

int totalEntriesIntExact

Stores the total number of entries as exact integer if possible. This is only computed on demand by Shape.totalEntriesIntValueExact().

Package org.flag4j.arrays.backend

Class org.flag4j.arrays.backend.AbstractTensor

class AbstractTensor extends Object implements Serializable

Serialized Fields

entries

U entries

Entry data of this tensor. If this tensor is dense, then this specifies all entries within this tensor. If this tensor is sparse, this specifies only the non-zero entries of this tensor.

rank

int rank

The rank of this tensor. That is, the number of indices required to uniquely specify an element in the tensor (the number of axes within this tensor).

shape

Shape shape

The shape of this tensor.

Class org.flag4j.arrays.backend.CooFieldMatrixBase

class CooFieldMatrixBase extends FieldTensorBase<T extends CooFieldMatrixBase<T,U,V,W,Y>,U extends DenseFieldMatrixBase<U,T,?,W,Y>,Y extends Field<Y>> implements Serializable

Serialized Fields

colIndices

int[] colIndices

column indices for non-zero value of this sparse COO matrix.

nnz

int nnz

Number of non-zero entries in this COO matrix.

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

rowIndices

int[] rowIndices

Row indices for non-zero value of this sparse COO matrix.

sparsity

double sparsity

The sparsity of this matrix.

Class org.flag4j.arrays.backend.CooFieldTensorBase

class CooFieldTensorBase extends FieldTensorBase<T extends CooFieldTensorBase<T,U,V>,U extends DenseFieldTensorBase<U,T,V>,V extends Field<V>> implements Serializable

Serialized Fields

indices

int[][] indices

The non-zero indices of this sparse tensor.

Has shape (nnz, rank) where nnz is the number of non-zero entries in this sparse tensor.

nnz

int nnz

The number of non-zero entries in this sparse tensor.

sparsity

double sparsity

Stores the sparsity of this matrix.

Class org.flag4j.arrays.backend.CooFieldVectorBase

class CooFieldVectorBase extends FieldTensorBase<T extends CooFieldVectorBase<T,U,V,W,Y>,V extends DenseFieldVectorBase<V,W,T,Y>,Y extends Field<Y>> implements Serializable

Serialized Fields

indices

int[] indices

Indices of the non-zero values of this sparse COO vector.

nnz

int nnz

The number of non-zero entries in this sparse COO vector.

size

int size

The total size of this sparse COO vector (including zero values).

Class org.flag4j.arrays.backend.CsrFieldMatrixBase

class CsrFieldMatrixBase extends FieldTensorBase<T extends CsrFieldMatrixBase<T,U,V,W,Y>,U extends DenseFieldMatrixBase<U,?,T,W,Y>,Y extends Field<Y>> implements Serializable

Serialized Fields

colIndices

int[] colIndices

Column indices for non-zero values of this sparse CSR matrix.

nnz

int nnz

Number of non-zero entries in this CSR matrix.

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

rowPointers

int[] rowPointers

Pointers indicating starting index of each row within the CsrFieldMatrixBase.colIndices and AbstractTensor.entries arrays. Has length numRows + 1.

The range [entries[rowPointers[i]], entries[rowPointers[i+1]]) contains all non-zero entries within row i.

Similarly, [colIndices[rowPointers[i]], colIndices[rowPointers[i+1]]) contains all column indices for the entries in row i.

sparsity

double sparsity

The sparsity of this matrix.

Class org.flag4j.arrays.backend.DenseFieldMatrixBase

class DenseFieldMatrixBase extends FieldTensorBase<T extends DenseFieldMatrixBase<T,U,V,W,Y>,T extends DenseFieldMatrixBase<T,U,V,W,Y>,Y extends Field<Y>> implements Serializable

Serialized Fields

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

Class org.flag4j.arrays.backend.DenseFieldTensorBase

class DenseFieldTensorBase extends FieldTensorBase<T extends DenseFieldTensorBase<T,U,V>,T extends DenseFieldTensorBase<T,U,V>,V extends Field<V>> implements Serializable

Class org.flag4j.arrays.backend.DenseFieldVectorBase

class DenseFieldVectorBase extends FieldTensorBase<T extends DenseFieldVectorBase<T,U,V,W>,T extends DenseFieldVectorBase<T,U,V,W>,W extends Field<W>> implements Serializable

Serialized Fields

size

int size

The size of this vector.

Class org.flag4j.arrays.backend.DenseDoubleTensorBase

class DensePrimitiveDoubleTensorBase extends PrimitiveDoubleTensorBase<T extends DensePrimitiveDoubleTensorBase<T,U>,T extends DensePrimitiveDoubleTensorBase<T,U>> implements Serializable

Class org.flag4j.arrays.backend.FieldTensorBase

class FieldTensorBase extends TensorOverField<T extends FieldTensorBase<T,U,V>,U extends FieldTensorBase<U,U,V>,Field<V extends Field<V>>[],V extends Field<V>> implements Serializable

Serialized Fields

zeroElement

V extends Field<V> zeroElement

Stores the zero element of the field for this tensor.

Class org.flag4j.arrays.backend.DoubleTensorBase

class PrimitiveDoubleTensorBase extends TensorOverField<T extends PrimitiveDoubleTensorBase<T,U>,U extends PrimitiveDoubleTensorBase<U,U>,double[],Double> implements Serializable

Class org.flag4j.arrays.backend.TensorOverField

class TensorOverField extends TensorOverRing<T extends TensorOverField<T,U,V,W>,U extends TensorOverField<U,U,V,W>,V,W> implements Serializable

Class org.flag4j.arrays.backend.TensorOverRing

class TensorOverRing extends TensorOverSemiRing<T extends TensorOverRing<T,U,V,W>,U extends TensorOverRing<U,U,V,W>,V,W> implements Serializable

Class org.flag4j.arrays.backend.TensorOverSemiRing

class TensorOverSemiRing extends AbstractTensor<T extends TensorOverSemiRing<T,U,V,W>,V,W> implements Serializable

Package org.flag4j.arrays.backend.field_arrays

Class org.flag4j.arrays.backend.field_arrays.AbstractDenseFieldTensor

class AbstractDenseFieldTensor extends AbstractTensor<T extends AbstractDenseFieldTensor<T,V>,Field<V extends Field<V>>[],V extends Field<V>> implements Serializable

Serialized Fields

ZERO_ELEMENT

Field<V extends Field<V>> ZERO_ELEMENT

The zero element for the field that this tensor's elements belong to.

Package org.flag4j.arrays.backend.ring_arrays

Class org.flag4j.arrays.backend.ring_arrays.AbstractDenseRingTensor

class AbstractDenseRingTensor extends AbstractTensor<T extends AbstractDenseRingTensor<T,V>,Ring<V extends Ring<V>>[],V extends Ring<V>> implements Serializable

Serialized Fields

ZERO_ELEMENT

Ring<V extends Ring<V>> ZERO_ELEMENT

The zero element for the ring that this tensor's elements belong to.

Package org.flag4j.arrays.backend.semiring_arrays

Class org.flag4j.arrays.backend.semiring_arrays.AbstractCooSemiringMatrix

class AbstractCooSemiringMatrix extends AbstractTensor<T extends AbstractCooSemiringMatrix<T,U,V,W>,Semiring<W extends Semiring<W>>[],W extends Semiring<W>> implements Serializable

Serialized Fields

colIndices

int[] colIndices

column indices for non-zero value of this sparse COO matrix.

nnz

int nnz

Number of non-zero entries in this COO matrix.

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

rowIndices

int[] rowIndices

Row indices for non-zero value of this sparse COO matrix.

sparsity

double sparsity

The sparsity of this matrix.

zeroElement

Semiring<W extends Semiring<W>> zeroElement

The zero element for the semiring that this tensor's elements belong to.

Class org.flag4j.arrays.backend.semiring_arrays.AbstractCooSemiringTensor

class AbstractCooSemiringTensor extends AbstractTensor<T extends AbstractCooSemiringTensor<T,U,V>,Semiring<V extends Semiring<V>>[],V extends Semiring<V>> implements Serializable

Serialized Fields

indices

int[][] indices

The non-zero indices of this sparse tensor.

Has shape (nnz, rank) where nnz is the number of non-zero entries in this sparse tensor.

nnz

int nnz

The number of non-zero entries in this sparse tensor.

sparsity

double sparsity

Stores the sparsity of this matrix.

zeroElement

Semiring<V extends Semiring<V>> zeroElement

The zero element for the semiring that this tensor's elements belong to.

Class org.flag4j.arrays.backend.semiring_arrays.AbstractCooSemiringVector

class AbstractCooSemiringVector extends AbstractTensor<T extends AbstractCooSemiringVector<T,U,V,W,Y>,Semiring<Y extends Semiring<Y>>[],Y extends Semiring<Y>> implements Serializable

Serialized Fields

indices

int[] indices

Indices of the non-zero values of this sparse COO vector.

nnz

int nnz

The number of non-zero entries in this sparse COO vector.

size

int size

The total size of this sparse COO vector (including zero values).

sparsity

double sparsity

The sparsity of this matrix.

zeroElement

Semiring<Y extends Semiring<Y>> zeroElement

The zero element for the semiring that this tensor's elements belong to.

Class org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringMatrix

class AbstractDenseSemiringMatrix extends AbstractDenseSemiringTensor<T extends AbstractDenseSemiringMatrix<T,U,V>,V extends Semiring<V>> implements Serializable

Serialized Fields

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

Class org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringTensor

class AbstractDenseSemiringTensor extends AbstractTensor<T extends AbstractDenseSemiringTensor<T,V>,Semiring<V extends Semiring<V>>[],V extends Semiring<V>> implements Serializable

Serialized Fields

ZERO_ELEMENT

Semiring<V extends Semiring<V>> ZERO_ELEMENT

The zero element for the semi-ring that this tensor's elements belong to.

Class org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringVector

class AbstractDenseSemiringVector extends AbstractDenseSemiringTensor<T extends AbstractDenseSemiringVector<T,U,V>,V extends Semiring<V>> implements Serializable

Serialized Fields

size

int size

The size of this vector. This is the total number of entries stored in this vector.

Class org.flag4j.arrays.backend.semiring_arrays.AbstractCsrSemiringMatrix

class CsrSemiRingMatrixBase extends AbstractTensor<T extends CsrSemiRingMatrixBase<T,U,V,W>,Semiring<W extends Semiring<W>>[],W extends Semiring<W>> implements Serializable

Serialized Fields

colIndices

int[] colIndices

Column indices for non-zero values of this sparse CSR matrix.

nnz

int nnz

Number of non-zero entries in this CSR matrix.

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

rowPointers

int[] rowPointers

Pointers indicating starting index of each row within the CsrSemiRingMatrixBase.colIndices and AbstractTensor.entries arrays. Has length numRows + 1.

The range [entries[rowPointers[i]], entries[rowPointers[i+1]]) contains all non-zero entries within row i.

Similarly, [colIndices[rowPointers[i]], colIndices[rowPointers[i+1]]) contains all column indices for the entries in row i.

sparsity

double sparsity

The sparsity of this matrix.

zeroElement

Semiring<W extends Semiring<W>> zeroElement

The zero element for the semiring that this tensor's elements belong to.

Package org.flag4j.arrays.dense

Class org.flag4j.arrays.dense.CMatrixOld

class CMatrix extends DenseFieldMatrixBase<CMatrix,CooCMatrix,CsrCMatrix,CVector,Complex128> implements Serializable

Class org.flag4j.arrays.dense.CTensor

class CTensor extends DenseFieldTensorBase<CTensor,CooCTensor,Complex128> implements Serializable

Class org.flag4j.arrays.dense.CTensor64

class CTensor64 extends DenseFieldTensorBase<CTensor64,CooCTensor64,Complex64> implements Serializable

Class org.flag4j.arrays.dense.CVectorOld

class CVector extends DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128> implements Serializable

Class org.flag4j.arrays.dense.FieldMatrix

class FieldMatrix extends DenseFieldMatrixBase<FieldMatrix<T extends Field<T>>,CooFieldMatrix<T extends Field<T>>,CsrFieldMatrix<T extends Field<T>>,FieldVector<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.dense.FieldTensor

class FieldTensor extends DenseFieldTensorBase<FieldTensor<T extends Field<T>>,CooFieldTensor<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.dense.FieldVector

class FieldVector extends DenseFieldVectorBase<FieldVector<T extends Field<T>>,FieldMatrix<T extends Field<T>>,CooFieldVector<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.dense.Matrix

class Matrix extends DensePrimitiveDoubleTensorBase<Matrix,CooMatrix> implements Serializable

Serialized Fields

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

Class org.flag4j.arrays.dense.Tensor

class Tensor extends DensePrimitiveDoubleTensorBase<Tensor,CooTensor> implements Serializable

Class org.flag4j.arrays.dense.Vector

class Vector extends DensePrimitiveDoubleTensorBase<Vector,CooVector> implements Serializable

Serialized Fields

size

int size

The size of this vector. That is, the number of entries in this vector.

Package org.flag4j.arrays.sparse

Class org.flag4j.arrays.sparse.CooCMatrixOld

class CooCMatrix extends CooFieldMatrixBase<CooCMatrix,CMatrix,CooCVector,CVector,Complex128> implements Serializable

Class org.flag4j.arrays.sparse.CooCTensor

class CooCTensor extends CooFieldTensorBase<CooCTensor,CTensor,Complex128> implements Serializable

Class org.flag4j.arrays.sparse.CooCTensor64

class CooCTensor64 extends CooFieldTensorBase<CooCTensor64,CTensor64,Complex64> implements Serializable

Class org.flag4j.arrays.sparse.CooCVector

class CooCVector extends CooFieldVectorBase<CooCVector,CooCMatrix,CVector,CMatrix,Complex128> implements Serializable

Class org.flag4j.arrays.sparse.CooFieldMatrix

class CooFieldMatrix extends CooFieldMatrixBase<CooFieldMatrix<T extends Field<T>>,FieldMatrix<T extends Field<T>>,CooFieldVector<T extends Field<T>>,FieldVector<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.sparse.CooFieldTensor

class CooFieldTensor extends CooFieldTensorBase<CooFieldTensor<T extends Field<T>>,FieldTensor<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.sparse.CooFieldVector

class CooFieldVector extends CooFieldVectorBase<CooFieldVector<T extends Field<T>>,CooFieldMatrix<T extends Field<T>>,FieldVector<T extends Field<T>>,FieldMatrix<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.sparse.CooMatrix

class CooMatrix extends PrimitiveDoubleTensorBase<CooMatrix,Matrix> implements Serializable

Serialized Fields

colIndices

int[] colIndices

column indices for non-zero value of this sparse COO matrix.

nnz

int nnz

Number of non-zero entries in this COO matrix.

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

rowIndices

int[] rowIndices

Row indices for non-zero value of this sparse COO matrix.

sparsity

double sparsity

The sparsity of this matrix.

Class org.flag4j.arrays.sparse.CooTensor

class CooTensor extends PrimitiveDoubleTensorBase<CooTensor,Tensor> implements Serializable

Serialized Fields

indices

int[][] indices

The non-zero indices of this tensor. Must have shape (nnz, rank).

nnz

int nnz

The number of non-zero entries in this tensor.

sparsity

double sparsity

The sparsity of this matrix.

Class org.flag4j.arrays.sparse.CooVector

class CooVector extends PrimitiveDoubleTensorBase<CooVector,Vector> implements Serializable

Serialized Fields

indices

int[] indices

The indices of the non-zero entries in this sparse COO vector.

nnz

int nnz

The number of non-zero values in this sparse COO vector.

size

int size

The full size of this sparse COO vector (including the zeros.).

Class org.flag4j.arrays.sparse.CsrCMatrix

class CsrCMatrix extends CsrFieldMatrixBase<CsrCMatrix,CMatrix,CooCVector,CVector,Complex128> implements Serializable

Class org.flag4j.arrays.sparse.CsrFieldMatrix

class CsrFieldMatrix extends CsrFieldMatrixBase<CsrFieldMatrix<T extends Field<T>>,FieldMatrix<T extends Field<T>>,CooFieldVector<T extends Field<T>>,FieldVector<T extends Field<T>>,T extends Field<T>> implements Serializable

Class org.flag4j.arrays.sparse.CsrMatrix

class CsrMatrix extends PrimitiveDoubleTensorBase<CsrMatrix,Matrix> implements Serializable

Serialized Fields

colIndices

int[] colIndices

Column indices for non-zero values of this sparse CSR matrix.

nnz

int nnz

Number of non-zero entries in this CSR matrix.

numCols

int numCols

The number of columns in this matrix.

numRows

int numRows

The number of rows in this matrix.

rowPointers

int[] rowPointers

Pointers indicating starting index of each row within the CsrMatrix.colIndices and AbstractTensor.entries arrays. Has length numRows + 1.

The range [entries[rowPointers[i]], entries[rowPointers[i+1]]) contains all non-zero entries within row i.

Similarly, [colIndices[rowPointers[i]], colIndices[rowPointers[i+1]]) contains all column indices for the entries in row i.

sparsity

double sparsity

The sparsity of this matrix.

Class org.flag4j.arrays.sparse.PermutationMatrix

class PermutationMatrix extends Object implements Serializable

Serialized Fields

size

int size

Size of this permutation matrix.

swapPointers

int[] swapPointers

Tracks row/column swaps within the permutation matrix. For an n-by-n permutation matrix, this array will have size n. Each entry of the array represents a 1 in the permutation matrix. The index of an entry corresponds to the row index of the 1, and the value of this array corresponds to the column index of the 1.

Class org.flag4j.arrays.sparse.SymmTriDiag

class SymmTriDiag extends Object implements Serializable

Serialized Fields

diag

double[] diag

Stores the diagonal entries of this symmetric tri-diagonal matrix.

offDiag

double[] offDiag

Stores the first sub/super diagonal entries of this symmetric tri-diagonal matrix.

size

int size

The size (i.e. number of rows and columns) of this symmetric tri-diagonal matrix.

Package org.flag4j.rng

Class org.flag4j.rng.RandomComplex

class RandomComplex extends Random implements Serializable

Package org.flag4j.util.exceptions

Exception Class org.flag4j.util.exceptions.ComplexNumberParsingException

class ComplexNumberParsingException extends RuntimeException implements Serializable

Exception Class org.flag4j.util.exceptions.LinearAlgebraException

class LinearAlgebraException extends RuntimeException implements Serializable

Exception Class org.flag4j.util.exceptions.SingularMatrixException

class SingularMatrixException extends LinearAlgebraException implements Serializable

Exception Class org.flag4j.util.exceptions.TensorShapeException

class TensorShapeException extends LinearAlgebraException implements Serializable