Class DistributedLinearAlgebraProvider<E>

java.lang.Object

org.episteme.core.mathematics.linearalgebra.providers.DistributedLinearAlgebraProvider<E>

All Implemented Interfaces:

AutoCloseable, LinearAlgebraProvider<E>, SparseLinearAlgebraProvider<E>, AlgorithmProvider, Backend

@AutoService({LinearAlgebraProvider.class,Backend.class})
public class DistributedLinearAlgebraProvider<E>
extends Object
implements SparseLinearAlgebraProvider<E>, Backend

Linear algebra provider that delegates to distributed algorithms when appropriate.

This provider automatically activates when a distributed context is detected and the problem size warrants the overhead of distribution.

Since:

2.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
DistributedLinearAlgebraProvider()
DistributedLinearAlgebraProvider(Ring<E> ring)

Method Summary

Modifier and Type	Method	Description
Matrix<E>	acos(Matrix<E> a)
Matrix<E>	acosh(Matrix<E> a)
Matrix<E>	add(Matrix<E> a, Matrix<E> b)
Vector<E>	add(Vector<E> a, Vector<E> b)
Matrix<E>	asin(Matrix<E> a)
Matrix<E>	asinh(Matrix<E> a)
Matrix<E>	atan(Matrix<E> a)
Matrix<E>	atanh(Matrix<E> a)
Vector<E>	bicgstab(Matrix<E> a, Vector<E> b, Vector<E> x0, E tolerance, int maxIterations)	Solves Ax = b using BiCGSTAB (BiConjugate Gradient Stabilized) method.
Matrix<E>	cbrt(Matrix<E> a)
CholeskyResult<E>	cholesky(Matrix<E> a)	Computes the Cholesky decomposition of the specified matrix.
Vector<E>	conjugateGradient(Matrix<E> a, Vector<E> b, Vector<E> x0, E tolerance, int maxIterations)	Solves Ax = b using Conjugate Gradient method.
Matrix<E>	cos(Matrix<E> a)
Matrix<E>	cosh(Matrix<E> a)
Object	createBackend()	Creates and returns the backend instance (or returns self if it is the backend).
E	determinant(Matrix<E> a)
E	dot(Vector<E> a, Vector<E> b)
EigenResult<E>	eigen(Matrix<E> a)	Computes the eigenvalue decomposition of the specified matrix.
Matrix<E>	exp(Matrix<E> a)	Computes the matrix exponential e^A.
String	getDescription()	Returns a description of the backend.
String	getId()	Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").
String	getName()	Returns the display name for UI presentation.
int	getPriority()	Priority of this provider (higher means more preferred).
String	getStatusMessage()	Returns a human-readable status message for this backend.
String	getType()	Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").
Vector<E>	gmres(Matrix<E> a, Vector<E> b, Vector<E> x0, E tolerance, int maxIterations, int restarts)	Solves Ax = b using GMRES (Generalized Minimal Residual) method.
Matrix<E>	inverse(Matrix<E> a)
boolean	isAvailable()	Checks if the provider is available in the current environment.
boolean	isCompatible(Ring<?> ring)	Checks if this provider is compatible with the given ring.
Matrix<E>	log(Matrix<E> a)
Matrix<E>	log10(Matrix<E> a)
LUResult<E>	lu(Matrix<E> a)	Computes the LU decomposition of the specified matrix.
Matrix<E>	multiply(Matrix<E> a, Matrix<E> b)
Vector<E>	multiply(Matrix<E> a, Vector<E> b)
Vector<E>	multiply(Vector<E> vector, E scalar)
E	norm(Vector<E> a)
Matrix<E>	pow(Matrix<E> a, E exponent)
QRResult<E>	qr(Matrix<E> a)	Computes the QR decomposition of the specified matrix.
Matrix<E>	scale(E scalar, Matrix<E> a)
void	shutdown()	Called when the provider is no longer needed (e.g., application shutdown).
Matrix<E>	sin(Matrix<E> a)
Matrix<E>	sinh(Matrix<E> a)
Vector<E>	solve(CholeskyResult<E> cholesky, Vector<E> b)	Solves Ax = b using a previously computed Cholesky decomposition.
Vector<E>	solve(LUResult<E> lu, Vector<E> b)	Solves Ax = b using a previously computed LU decomposition.
Vector<E>	solve(QRResult<E> qr, Vector<E> b)	Solves Ax = b using a previously computed QR decomposition.
Vector<E>	solve(Matrix<E> a, Vector<E> b)
Vector<E>	solveTriangular(Matrix<E> A, Vector<E> b, boolean upper, boolean transpose, boolean conjugate, boolean unit)	Solves the triangular system Ax = b.
Matrix<E>	sqrt(Matrix<E> a)
Matrix<E>	subtract(Matrix<E> a, Matrix<E> b)
Vector<E>	subtract(Vector<E> a, Vector<E> b)
SVDResult<E>	svd(Matrix<E> a)	Computes the Singular Value Decomposition (SVD) of the specified matrix.
Matrix<E>	tan(Matrix<E> a)
Matrix<E>	tanh(Matrix<E> a)
E	trace(Matrix<E> a)
Matrix<E>	transpose(Matrix<E> a)

Methods inherited from class Object

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

Methods inherited from interface AlgorithmProvider

description, getMetadata

Methods inherited from interface Backend

getAlgorithmProviders, isExplicitlyDisabled

Methods inherited from interface LinearAlgebraProvider

angle, close, configure, conjugateTranspose, cross, getEnvironmentInfo, normalize, projection, score

Methods inherited from interface SparseLinearAlgebraProvider

conditionNumber, fromDense, getAlgorithmType, rank, toDense

Constructor Details

DistributedLinearAlgebraProvider

public DistributedLinearAlgebraProvider()

DistributedLinearAlgebraProvider

public DistributedLinearAlgebraProvider(Ring<E> ring)

Method Details

isCompatible

public boolean isCompatible(Ring<?> ring)

Description copied from interface: LinearAlgebraProvider

Checks if this provider is compatible with the given ring.

Specified by:

isCompatible in interface LinearAlgebraProvider<E>

getPriority

public int getPriority()

Description copied from interface: LinearAlgebraProvider

Priority of this provider (higher means more preferred). Used for automatic backend selection.

Specified by:

getPriority in interface AlgorithmProvider

Specified by:

getPriority in interface Backend

Specified by:

getPriority in interface LinearAlgebraProvider<E>

getName

public String getName()

Description copied from interface: Backend

Returns the display name for UI presentation.

Specified by:

getName in interface AlgorithmProvider

Specified by:

getName in interface Backend

Specified by:

getName in interface LinearAlgebraProvider<E>

add

public Vector<E> add(Vector<E> a,
 Vector<E> b)

Specified by:

add in interface LinearAlgebraProvider<E>

subtract

public Vector<E> subtract(Vector<E> a,
 Vector<E> b)

Specified by:

subtract in interface LinearAlgebraProvider<E>

multiply

public Vector<E> multiply(Vector<E> vector,
 E scalar)

Specified by:

multiply in interface LinearAlgebraProvider<E>

dot

public E dot(Vector<E> a,
 Vector<E> b)

Specified by:

dot in interface LinearAlgebraProvider<E>

norm

public E norm(Vector<E> a)

Specified by:

norm in interface LinearAlgebraProvider<E>

add

public Matrix<E> add(Matrix<E> a,
 Matrix<E> b)

Specified by:

add in interface LinearAlgebraProvider<E>

subtract

public Matrix<E> subtract(Matrix<E> a,
 Matrix<E> b)

Specified by:

subtract in interface LinearAlgebraProvider<E>

multiply

public Matrix<E> multiply(Matrix<E> a,
 Matrix<E> b)

Specified by:

multiply in interface LinearAlgebraProvider<E>

multiply

public Vector<E> multiply(Matrix<E> a,
 Vector<E> b)

Specified by:

multiply in interface LinearAlgebraProvider<E>

exp

public Matrix<E> exp(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Computes the matrix exponential e^A.

Specified by:

exp in interface LinearAlgebraProvider<E>

log

public Matrix<E> log(Matrix<E> a)

Specified by:

log in interface LinearAlgebraProvider<E>

log10

public Matrix<E> log10(Matrix<E> a)

Specified by:

log10 in interface LinearAlgebraProvider<E>

sin

public Matrix<E> sin(Matrix<E> a)

Specified by:

sin in interface LinearAlgebraProvider<E>

cos

public Matrix<E> cos(Matrix<E> a)

Specified by:

cos in interface LinearAlgebraProvider<E>

tan

public Matrix<E> tan(Matrix<E> a)

Specified by:

tan in interface LinearAlgebraProvider<E>

asin

public Matrix<E> asin(Matrix<E> a)

Specified by:

asin in interface LinearAlgebraProvider<E>

acos

public Matrix<E> acos(Matrix<E> a)

Specified by:

acos in interface LinearAlgebraProvider<E>

atan

public Matrix<E> atan(Matrix<E> a)

Specified by:

atan in interface LinearAlgebraProvider<E>

sinh

public Matrix<E> sinh(Matrix<E> a)

Specified by:

sinh in interface LinearAlgebraProvider<E>

cosh

public Matrix<E> cosh(Matrix<E> a)

Specified by:

cosh in interface LinearAlgebraProvider<E>

tanh

public Matrix<E> tanh(Matrix<E> a)

Specified by:

tanh in interface LinearAlgebraProvider<E>

asinh

public Matrix<E> asinh(Matrix<E> a)

Specified by:

asinh in interface LinearAlgebraProvider<E>

acosh

public Matrix<E> acosh(Matrix<E> a)

Specified by:

acosh in interface LinearAlgebraProvider<E>

atanh

public Matrix<E> atanh(Matrix<E> a)

Specified by:

atanh in interface LinearAlgebraProvider<E>

pow

public Matrix<E> pow(Matrix<E> a,
 E exponent)

Specified by:

pow in interface LinearAlgebraProvider<E>

sqrt

public Matrix<E> sqrt(Matrix<E> a)

Specified by:

sqrt in interface LinearAlgebraProvider<E>

cbrt

public Matrix<E> cbrt(Matrix<E> a)

Specified by:

cbrt in interface LinearAlgebraProvider<E>

trace

public E trace(Matrix<E> a)

Specified by:

trace in interface LinearAlgebraProvider<E>

solveTriangular

public Vector<E> solveTriangular(Matrix<E> A,
 Vector<E> b,
 boolean upper,
 boolean transpose,
 boolean conjugate,
 boolean unit)

Description copied from interface: LinearAlgebraProvider

Solves the triangular system Ax = b.

Specified by:

solveTriangular in interface LinearAlgebraProvider<E>

Parameters:

A - the triangular matrix

b - the right-hand side vector

upper - true if A is upper triangular, false if lower

transpose - true if solving A^T x = b

conjugate - true if solving A^H x = b (only if transpose is true and complex)

unit - true if A is unit triangular (diagonal is all ones)

inverse

public Matrix<E> inverse(Matrix<E> a)

Specified by:

inverse in interface LinearAlgebraProvider<E>

lu

public LUResult<E> lu(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Computes the LU decomposition of the specified matrix.

Specified by:

lu in interface LinearAlgebraProvider<E>

qr

public QRResult<E> qr(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Computes the QR decomposition of the specified matrix.

Specified by:

qr in interface LinearAlgebraProvider<E>

svd

public SVDResult<E> svd(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Computes the Singular Value Decomposition (SVD) of the specified matrix.

Specified by:

svd in interface LinearAlgebraProvider<E>

cholesky

public CholeskyResult<E> cholesky(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Computes the Cholesky decomposition of the specified matrix.

Specified by:

cholesky in interface LinearAlgebraProvider<E>

eigen

public EigenResult<E> eigen(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Computes the eigenvalue decomposition of the specified matrix.

Specified by:

eigen in interface LinearAlgebraProvider<E>

solve

public Vector<E> solve(Matrix<E> a,
 Vector<E> b)

Specified by:

solve in interface LinearAlgebraProvider<E>

solve

public Vector<E> solve(LUResult<E> lu,
 Vector<E> b)

Description copied from interface: LinearAlgebraProvider

Solves Ax = b using a previously computed LU decomposition.

Specified by:

solve in interface LinearAlgebraProvider<E>

solve

public Vector<E> solve(QRResult<E> qr,
 Vector<E> b)

Description copied from interface: LinearAlgebraProvider

Solves Ax = b using a previously computed QR decomposition.

Specified by:

solve in interface LinearAlgebraProvider<E>

solve

public Vector<E> solve(CholeskyResult<E> cholesky,
 Vector<E> b)

Description copied from interface: LinearAlgebraProvider

Solves Ax = b using a previously computed Cholesky decomposition.

Specified by:

solve in interface LinearAlgebraProvider<E>

determinant

public E determinant(Matrix<E> a)

Specified by:

determinant in interface LinearAlgebraProvider<E>

transpose

public Matrix<E> transpose(Matrix<E> a)

Specified by:

transpose in interface LinearAlgebraProvider<E>

scale

public Matrix<E> scale(E scalar,
 Matrix<E> a)

Specified by:

scale in interface LinearAlgebraProvider<E>

bicgstab

public Vector<E> bicgstab(Matrix<E> a,
 Vector<E> b,
 Vector<E> x0,
 E tolerance,
 int maxIterations)

Description copied from interface: SparseLinearAlgebraProvider

Solves Ax = b using BiCGSTAB (BiConjugate Gradient Stabilized) method.

Specified by:

bicgstab in interface SparseLinearAlgebraProvider<E>

conjugateGradient

public Vector<E> conjugateGradient(Matrix<E> a,
 Vector<E> b,
 Vector<E> x0,
 E tolerance,
 int maxIterations)

Description copied from interface: SparseLinearAlgebraProvider

Solves Ax = b using Conjugate Gradient method.

Specified by:

conjugateGradient in interface SparseLinearAlgebraProvider<E>

gmres

public Vector<E> gmres(Matrix<E> a,
 Vector<E> b,
 Vector<E> x0,
 E tolerance,
 int maxIterations,
 int restarts)

Description copied from interface: SparseLinearAlgebraProvider

Solves Ax = b using GMRES (Generalized Minimal Residual) method.

Specified by:

gmres in interface SparseLinearAlgebraProvider<E>

getStatusMessage

public String getStatusMessage()

Description copied from interface: Backend

Returns a human-readable status message for this backend. Useful for debugging "Unavailable" states.

Specified by:

getStatusMessage in interface Backend

Returns:

status message (e.g., "Ready", "Native library missing", etc.)

isAvailable

public boolean isAvailable()

Description copied from interface: AlgorithmProvider

Checks if the provider is available in the current environment.

Specified by:

isAvailable in interface AlgorithmProvider

Specified by:

isAvailable in interface Backend

getType

public String getType()

Description copied from interface: Backend

Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").

Specified by:

getType in interface Backend

getId

public String getId()

Description copied from interface: Backend

Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").

Specified by:

getId in interface Backend

getDescription

public String getDescription()

Description copied from interface: Backend

Returns a description of the backend.

Specified by:

getDescription in interface Backend

createBackend

public Object createBackend()

Description copied from interface: Backend

Creates and returns the backend instance (or returns self if it is the backend).

Specified by:

createBackend in interface Backend

Returns:

The backend implementation object

shutdown

public void shutdown()

Description copied from interface: AlgorithmProvider

Called when the provider is no longer needed (e.g., application shutdown). Use this to release local resources or close native segments.

Specified by:

shutdown in interface AlgorithmProvider

Specified by:

shutdown in interface Backend