Class MMapMatrix

java.lang.Object

org.episteme.core.mathematics.linearalgebra.matrices.GenericMatrix<Real>

org.episteme.core.mathematics.linearalgebra.matrices.MMapMatrix

All Implemented Interfaces:

AutoCloseable, Matrix<Real>, AbelianGroup<Matrix<Real>>, AbelianMonoid<Matrix<Real>>, Group<Matrix<Real>>, Magma<Matrix<Real>>, Monoid<Matrix<Real>>, Ring<Matrix<Real>>, Semiring<Matrix<Real>>, Set<Matrix<Real>>, Module<Matrix<Real>, Real>

public class MMapMatrix
extends GenericMatrix<Real>
implements AutoCloseable

Memory-Mapped Matrix implementation for Out-of-Core processing.

Allowed for handling matrices larger than available RAM by mapping file segments into virtual memory.

Since:

1.2

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Field Summary

Fields inherited from class GenericMatrix

provider, ring, storage

Constructor Summary

Constructors

Constructor	Description
MMapMatrix(Path path, int rows, int cols)

Method Summary

Modifier and Type	Method	Description
Matrix<Real>	add(Matrix<Real> other)	Returns the sum of this matrix and another.
void	close()
int	cols()	Returns the number of columns in this matrix.
boolean	contains(Matrix<Real> element)	Tests whether this set contains the specified element.
MMapMatrix	copy()
String	description()	Returns a human-readable description of this set.
Real	determinant()	Returns the determinant of this matrix.
void	flush()
Real	get(int i, int j)	Returns the element at the specified row and column.
Vector<Real>	getColumn(int col)	Returns the column at the specified index as a vector.
Vector<Real>	getRow(int row)	Returns the row at the specified index as a vector.
Ring<Real>	getScalarRing()	Returns the ring of scalars for this module.
MatrixStorage<Real>	getStorage()	Returns the underlying storage of this matrix.
Matrix<Real>	getSubMatrix(int rs, int re, int cs, int ce)	Returns a submatrix of this matrix.
Matrix<Real>	inverse()	Returns the multiplicative inverse of this matrix.
Matrix<Real>	multiply(Matrix<Real> other)	Returns the product of this matrix and another.
Vector<Real>	multiply(Vector<Real> vector)	Multiplies this matrix by a vector.
Matrix<Real>	negate()	Returns the negation of this matrix (-this).
Matrix<Real>	one()	Returns the multiplicative identity (one element).
int	rows()	Returns the number of rows in this matrix.
Matrix<Real>	scale(Real scalar, Matrix<Real> element)	Scalar multiplication (r × m).
void	set(int i, int j, Real value)
Real	trace()	Returns the trace of this matrix (sum of diagonal elements).
Matrix<Real>	transpose()	Returns the transpose of this matrix.
Matrix<Real>	zero()	Returns the zero matrix of the same dimensions.

Methods inherited from class GenericMatrix

cholesky, eigen, getField, getProvider, lu, qr, svd, withProvider

Methods inherited from class Object

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

Methods inherited from interface AbelianGroup

negate, subtract

Methods inherited from interface Matrix

add, identity, inverse, isCommutative, isEmpty, isMultiplicationCommutative, map, multiply, operate, scale, subtract, toTensor

Methods inherited from interface Monoid

isAssociative

Methods inherited from interface Ring

hasUnity

Methods inherited from interface Semiring

pow

Constructor Details

MMapMatrix

public MMapMatrix(Path path,
 int rows,
 int cols)
           throws IOException

Throws:

IOException

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

rows

public int rows()

Description copied from interface: Matrix

Returns the number of rows in this matrix.

Specified by:

rows in interface Matrix<Real>

Overrides:

rows in class GenericMatrix<Real>

cols

public int cols()

Description copied from interface: Matrix

Returns the number of columns in this matrix.

Specified by:

cols in interface Matrix<Real>

Overrides:

cols in class GenericMatrix<Real>

get

public Real get(int i,
 int j)

Description copied from interface: Matrix

Returns the element at the specified row and column.

Specified by:

get in interface Matrix<Real>

Overrides:

get in class GenericMatrix<Real>

set

public void set(int i,
 int j,
 Real value)

Overrides:

set in class GenericMatrix<Real>

flush

public void flush()

add

public Matrix<Real> add(Matrix<Real> other)

Description copied from interface: Matrix

Returns the sum of this matrix and another.

Specified by:

add in interface Matrix<Real>

Overrides:

add in class GenericMatrix<Real>

multiply

public Matrix<Real> multiply(Matrix<Real> other)

Description copied from interface: Matrix

Returns the product of this matrix and another.

Specified by:

multiply in interface Matrix<Real>

Overrides:

multiply in class GenericMatrix<Real>

transpose

public Matrix<Real> transpose()

Description copied from interface: Matrix

Returns the transpose of this matrix.

Specified by:

transpose in interface Matrix<Real>

Overrides:

transpose in class GenericMatrix<Real>

trace

public Real trace()

Description copied from interface: Matrix

Returns the trace of this matrix (sum of diagonal elements).

Specified by:

trace in interface Matrix<Real>

Overrides:

trace in class GenericMatrix<Real>

getSubMatrix

public Matrix<Real> getSubMatrix(int rs,
 int re,
 int cs,
 int ce)

Description copied from interface: Matrix

Returns a submatrix of this matrix.

Specified by:

getSubMatrix in interface Matrix<Real>

Overrides:

getSubMatrix in class GenericMatrix<Real>

getRow

public Vector<Real> getRow(int row)

Description copied from interface: Matrix

Returns the row at the specified index as a vector.

Specified by:

getRow in interface Matrix<Real>

Overrides:

getRow in class GenericMatrix<Real>

getColumn

public Vector<Real> getColumn(int col)

Description copied from interface: Matrix

Returns the column at the specified index as a vector.

Specified by:

getColumn in interface Matrix<Real>

Overrides:

getColumn in class GenericMatrix<Real>

determinant

public Real determinant()

Description copied from interface: Matrix

Returns the determinant of this matrix.

Specified by:

determinant in interface Matrix<Real>

Overrides:

determinant in class GenericMatrix<Real>

inverse

public Matrix<Real> inverse()

Description copied from interface: Matrix

Returns the multiplicative inverse of this matrix.

Specified by:

inverse in interface Matrix<Real>

Overrides:

inverse in class GenericMatrix<Real>

multiply

public Vector<Real> multiply(Vector<Real> vector)

Description copied from interface: Matrix

Multiplies this matrix by a vector.

Specified by:

multiply in interface Matrix<Real>

Overrides:

multiply in class GenericMatrix<Real>

negate

public Matrix<Real> negate()

Description copied from interface: Matrix

Returns the negation of this matrix (-this).

Specified by:

negate in interface Matrix<Real>

Overrides:

negate in class GenericMatrix<Real>

zero

public Matrix<Real> zero()

Description copied from interface: Matrix

Returns the zero matrix of the same dimensions.

Specified by:

zero in interface AbelianMonoid<Matrix<Real>>

Specified by:

zero in interface Matrix<Real>

Overrides:

zero in class GenericMatrix<Real>

Returns:

the zero element

one

public Matrix<Real> one()

Description copied from interface: Semiring

Returns the multiplicative identity (one element).

Satisfies: 1 × a = a × 1 = a for all elements a.

Specified by:

one in interface Semiring<Matrix<Real>>

Overrides:

one in class GenericMatrix<Real>

Returns:

the multiplicative identity

getStorage

public MatrixStorage<Real> getStorage()

Description copied from interface: Matrix

Returns the underlying storage of this matrix.

Specified by:

getStorage in interface Matrix<Real>

Overrides:

getStorage in class GenericMatrix<Real>

Returns:

the matrix storage

getScalarRing

public Ring<Real> getScalarRing()

Description copied from interface: Module

Returns the ring of scalars for this module.

Specified by:

getScalarRing in interface Matrix<Real>

Specified by:

getScalarRing in interface Module<Matrix<Real>, Real>

Overrides:

getScalarRing in class GenericMatrix<Real>

Returns:

the scalar ring

scale

public Matrix<Real> scale(Real scalar,
 Matrix<Real> element)

Description copied from interface: Module

Scalar multiplication (r × m).

Specified by:

scale in interface Matrix<Real>

Specified by:

scale in interface Module<Matrix<Real>, Real>

Overrides:

scale in class GenericMatrix<Real>

Parameters:

scalar - the scalar r ∈ R

element - the module element m ∈ M

Returns:

r × m

copy

public MMapMatrix copy()

contains

public boolean contains(Matrix<Real> element)

Description copied from interface: Set

Tests whether this set contains the specified element.

This is the fundamental operation of a set - membership testing.

Specified by:

contains in interface Set<Matrix<Real>>

Overrides:

contains in class GenericMatrix<Real>

Parameters:

element - the element to test for membership

Returns:

true if this set contains the element, false otherwise

See Also:

• Set.isEmpty()
• invalid reference

  #size()

description

public String description()

Description copied from interface: Set

Returns a human-readable description of this set.

Examples:

• "ℝ (Real Numbers)"
• "ℤ/12ℤ (Integers modulo 12)"
• "{1, 2, 3, 4, 5}"

Specified by:

description in interface Set<Matrix<Real>>

Overrides:

description in class GenericMatrix<Real>

Returns:

a description of this set