Class NativeMPFRSparseLinearAlgebraBackend<E>

java.lang.Object

org.episteme.nativ.mathematics.linearalgebra.backends.NativeMPFRSparseLinearAlgebraBackend<E>

All Implemented Interfaces:

AutoCloseable, LinearAlgebraProvider<E>, SparseLinearAlgebraProvider<E>, AlgorithmProvider, Backend, ComputeBackend, CPUBackend, NativeBackend

@AutoService({Backend.class,ComputeBackend.class,NativeBackend.class,LinearAlgebraProvider.class,SparseLinearAlgebraProvider.class,CPUBackend.class,AlgorithmProvider.class})
public class NativeMPFRSparseLinearAlgebraBackend<E>
extends Object
implements SparseLinearAlgebraProvider<E>, NativeBackend, CPUBackend

Arbitrary-precision Sparse Linear Algebra backend using MPFR (via Panama). Optimized for CSR storage.

Constructor Summary

Constructors

Constructor	Description
NativeMPFRSparseLinearAlgebraBackend()

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> v1, Vector<E> v2)
E	angle(Vector<E> a, Vector<E> b)	Returns the angle between two vectors in radians.
Matrix<E>	applyTranscendental(Matrix<E> a, String op, Object... args)
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)
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).
ExecutionContext	createContext()	Creates an execution context for running operations.
Vector<E>	cross(Vector<E> a, Vector<E> b)	Returns the cross product of two 3D vectors.
E	determinant(Matrix<E> a)
E	dot(Vector<E> v1, Vector<E> v2)
Matrix<E>	exp(Matrix<E> a)	Computes the matrix exponential e^A.
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getDescription()	Returns a description of the backend.
String	getId()	Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").
Map<String,String>	getMetadata()	Returns metadata about the provider's performance and capabilities.
String	getName()	Returns the display name for UI presentation.
String	getNativeLibraryName()	Returns the name of the native library this backend depends on.
int	getPriority()	Priority of this provider (higher means more preferred).
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	isAlive()
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.
boolean	isExplicitlyDisabled()	Checks if this backend is specifically disabled via a system property: "episteme.backend.disable." + getId().
boolean	isLoaded()	Checks if the native library is loaded and available.
Matrix<E>	log(Matrix<E> a)
Matrix<E>	log10(Matrix<E> a)
Matrix<E>	multiply(Matrix<E> a, Matrix<E> b)
Vector<E>	multiply(Matrix<E> a, Vector<E> b)
Vector<E>	multiply(Vector<E> a, E scalar)
E	norm(Vector<E> a)
Vector<E>	normalize(Vector<E> a)	Returns the normalized vector (unit vector).
Vector<E>	projection(Vector<E> a, Vector<E> b)	Returns the projection of vector a onto vector b.
Matrix<E>	scale(E scalar, Matrix<E> a)
double	score(OperationContext context)	Scores this provider for a specific operation context.
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(SparseMatrix<E> a, Vector<E> b, E tolerance, int maxIterations)
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> v1, Vector<E> v2)
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

Methods inherited from interface Backend

getAlgorithmProviders, getStatusMessage

Methods inherited from interface CPUBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface LinearAlgebraProvider

cholesky, close, configure, conjugateTranspose, eigen, getEnvironmentInfo, lu, pow, qr, solve, solve, solve, svd

Methods inherited from interface SparseLinearAlgebraProvider

conditionNumber, fromDense, getAlgorithmType, rank, toDense

Constructor Details

NativeMPFRSparseLinearAlgebraBackend

public NativeMPFRSparseLinearAlgebraBackend()

Method Details

isAlive

public boolean isAlive()

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

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

Specified by:

getId in interface ComputeBackend

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>

getDescription

public String getDescription()

Description copied from interface: Backend

Returns a description of the backend.

Specified by:

getDescription in interface Backend

Specified by:

getDescription in interface ComputeBackend

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

Specified by:

getType in interface ComputeBackend

Specified by:

getType in interface CPUBackend

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>

getAcceleratorType

public HardwareAccelerator getAcceleratorType()

Description copied from interface: ComputeBackend

Returns the type of hardware accelerator used by this backend.

Specified by:

getAcceleratorType in interface ComputeBackend

Specified by:

getAcceleratorType in interface CPUBackend

Returns:

the accelerator type

isLoaded

public boolean isLoaded()

Description copied from interface: NativeBackend

Checks if the native library is loaded and available.

Specified by:

isLoaded in interface NativeBackend

Returns:

true if the native library has been successfully loaded

getNativeLibraryName

public String getNativeLibraryName()

Description copied from interface: NativeBackend

Returns the name of the native library this backend depends on.

Specified by:

getNativeLibraryName in interface NativeBackend

Returns:

library name (e.g., "openblas", "cuda", "fftw3")

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

Specified by:

createBackend in interface ComputeBackend

Returns:

The backend implementation object

createContext

public ExecutionContext createContext()

Description copied from interface: ComputeBackend

Creates an execution context for running operations.

The context should be used within a try-with-resources block to ensure proper cleanup of resources.

Specified by:

createContext in interface ComputeBackend

Returns:

new execution context

isExplicitlyDisabled

public boolean isExplicitlyDisabled()

Description copied from interface: Backend

Checks if this backend is specifically disabled via a system property: "episteme.backend.disable." + getId().

It also checks specialized properties like "episteme.linearalgebra.disable." + getId().

Specified by:

isExplicitlyDisabled in interface Backend

Returns:

true if explicitly disabled

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

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: AlgorithmProvider

Returns metadata about the provider's performance and capabilities. This can be used for advanced matching in the ProviderSelector.

Specified by:

getMetadata in interface AlgorithmProvider

Returns:

a map of metadata keys and values

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>

score

public double score(OperationContext context)

Description copied from interface: AlgorithmProvider

Scores this provider for a specific operation context.

Higher scores indicate better suitability. Used by ProviderSelector for context-aware selection.

Default implementation returns AlgorithmProvider.getPriority(), so existing providers behave identically without changes.

Specified by:

score in interface AlgorithmProvider

Specified by:

score in interface LinearAlgebraProvider<E>

Parameters:

context - the operation context (data size, hints, etc.)

Returns:

suitability score (higher = better)

trace

public E trace(Matrix<E> a)

Specified by:

trace in interface LinearAlgebraProvider<E>

multiply

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

Specified by:

multiply in interface LinearAlgebraProvider<E>

scale

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

Specified by:

scale in interface LinearAlgebraProvider<E>

multiply

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

Specified by:

multiply in interface LinearAlgebraProvider<E>

add

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

Specified by:

add in interface LinearAlgebraProvider<E>

add

public Vector<E> add(Vector<E> v1,
 Vector<E> v2)

Specified by:

add in interface LinearAlgebraProvider<E>

subtract

public Vector<E> subtract(Vector<E> v1,
 Vector<E> v2)

Specified by:

subtract 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>

dot

public E dot(Vector<E> v1,
 Vector<E> v2)

Specified by:

dot in interface LinearAlgebraProvider<E>

norm

public E norm(Vector<E> a)

Specified by:

norm in interface LinearAlgebraProvider<E>

solve

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

Specified by:

solve 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)

solve

public Vector<E> solve(SparseMatrix<E> a,
 Vector<E> b,
 E tolerance,
 int maxIterations)

transpose

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

Specified by:

transpose 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>

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>

applyTranscendental

public Matrix<E> applyTranscendental(Matrix<E> a,
 String op,
 Object... args)

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>

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>

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>

determinant

public E determinant(Matrix<E> a)

Specified by:

determinant in interface LinearAlgebraProvider<E>

inverse

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

Specified by:

inverse in interface LinearAlgebraProvider<E>

normalize

public Vector<E> normalize(Vector<E> a)

Description copied from interface: LinearAlgebraProvider

Returns the normalized vector (unit vector).

Specified by:

normalize in interface LinearAlgebraProvider<E>

cross

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

Description copied from interface: LinearAlgebraProvider

Returns the cross product of two 3D vectors.

Specified by:

cross in interface LinearAlgebraProvider<E>

angle

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

Description copied from interface: LinearAlgebraProvider

Returns the angle between two vectors in radians.

Specified by:

angle in interface LinearAlgebraProvider<E>

projection

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

Description copied from interface: LinearAlgebraProvider

Returns the projection of vector a onto vector b.

Specified by:

projection in interface LinearAlgebraProvider<E>