Class AbstractNativeFFMBLASBackend<E>

java.lang.Object

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

Type Parameters:

E - the element type

All Implemented Interfaces:

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

Direct Known Subclasses:

NativeFFMBLASComplexBackend, NativeFFMBLASRealBackend

public abstract class AbstractNativeFFMBLASBackend<E>
extends Object
implements LinearAlgebraProvider<E>, NativeBackend, CPUBackend

Abstract base for High-Performance Native BLAS Backend using Project Panama (FFM). Binds to OpenBLAS/MKL for Matrix Operations.

Constructor Summary

Constructors

Constructor	Description
AbstractNativeFFMBLASBackend()

Method Summary

Modifier and Type	Method	Description
Matrix<E>	acos(Matrix<E> m)
Matrix<E>	acosh(Matrix<E> m)
Matrix<E>	add(Matrix<E> a, Matrix<E> b)
Vector<E>	add(Vector<E> a, Vector<E> b)
E	angle(Vector<E> a, Vector<E> b)	Returns the angle between two vectors in radians.
Matrix<E>	asin(Matrix<E> m)
Matrix<E>	asinh(Matrix<E> m)
Matrix<E>	atan(Matrix<E> m)
Matrix<E>	atanh(Matrix<E> m)
Matrix<E>	cbrt(Matrix<E> m)
CholeskyResult<E>	cholesky(Matrix<E> a)	Computes the Cholesky decomposition of the specified matrix.
void	close()
E	conditionNumber(Matrix<E> a)	Returns the condition number of the matrix (L2 norm).
Matrix<E>	conjugateTranspose(Matrix<E> m)
Matrix<E>	cos(Matrix<E> m)
Matrix<E>	cosh(Matrix<E> m)
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.
String	description()	Returns a human-readable description of the provider.
E	determinant(Matrix<E> A)
Vector<E>	divide(Vector<E> v, E scalar)
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> m)	Computes the matrix exponential e^A.
String	getEnvironmentInfo()	Returns a string describing the execution environment (e.g., "CPU (AVX2)", "GPU (CUDA 12.0)").
String	getId()	Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").
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").
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.
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> m)
Matrix<E>	log10(Matrix<E> m)
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)
Vector<E>	normalize(Vector<E> v)	Returns the normalized vector (unit vector).
Matrix<E>	pow(Matrix<E> m, E exponent)
Vector<E>	projection(Vector<E> a, Vector<E> b)	Returns the projection of vector a onto vector b.
QRResult<E>	qr(Matrix<E> a)	Computes the QR decomposition of the specified matrix.
int	rank(Matrix<E> a)	Returns the rank of the matrix.
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> m)
Matrix<E>	sinh(Matrix<E> m)
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> m)
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> m)
Matrix<E>	tanh(Matrix<E> m)
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

getMetadata

Methods inherited from interface Backend

getAlgorithmProviders, getStatusMessage

Methods inherited from interface ComputeBackend

createBackend, getDescription

Methods inherited from interface CPUBackend

getAcceleratorType, supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface LinearAlgebraProvider

configure, getAlgorithmType

Constructor Details

AbstractNativeFFMBLASBackend

public AbstractNativeFFMBLASBackend()

Method Details

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

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

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

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

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

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(Matrix<E> A,
 Vector<E> b)

Specified by:

solve in interface LinearAlgebraProvider<E>

normalize

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

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>

transpose

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

Specified by:

transpose in interface LinearAlgebraProvider<E>

inverse

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

Specified by:

inverse in interface LinearAlgebraProvider<E>

conjugateTranspose

public Matrix<E> conjugateTranspose(Matrix<E> m)

Specified by:

conjugateTranspose in interface LinearAlgebraProvider<E>

determinant

public E determinant(Matrix<E> A)

Specified by:

determinant in interface LinearAlgebraProvider<E>

trace

public E trace(Matrix<E> a)

Specified by:

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

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)

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

getEnvironmentInfo

public String getEnvironmentInfo()

Description copied from interface: LinearAlgebraProvider

Returns a string describing the execution environment (e.g., "CPU (AVX2)", "GPU (CUDA 12.0)").

Specified by:

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

description

public String description()

Description copied from interface: AlgorithmProvider

Returns a human-readable description of the provider.

Specified by:

description in interface AlgorithmProvider

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>

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>

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>

rank

public int rank(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Returns the rank of the matrix.

Specified by:

rank in interface LinearAlgebraProvider<E>

conditionNumber

public E conditionNumber(Matrix<E> a)

Description copied from interface: LinearAlgebraProvider

Returns the condition number of the matrix (L2 norm).

Specified by:

conditionNumber in interface LinearAlgebraProvider<E>

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

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>

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

divide

public Vector<E> divide(Vector<E> v,
 E scalar)

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>

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>

scale

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

Specified by:

scale 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(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>

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>

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

exp

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

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

Specified by:

log in interface LinearAlgebraProvider<E>

log10

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

Specified by:

log10 in interface LinearAlgebraProvider<E>

sin

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

Specified by:

sin in interface LinearAlgebraProvider<E>

cos

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

Specified by:

cos in interface LinearAlgebraProvider<E>

tan

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

Specified by:

tan in interface LinearAlgebraProvider<E>

asin

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

Specified by:

asin in interface LinearAlgebraProvider<E>

acos

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

Specified by:

acos in interface LinearAlgebraProvider<E>

atan

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

Specified by:

atan in interface LinearAlgebraProvider<E>

sinh

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

Specified by:

sinh in interface LinearAlgebraProvider<E>

cosh

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

Specified by:

cosh in interface LinearAlgebraProvider<E>

tanh

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

Specified by:

tanh in interface LinearAlgebraProvider<E>

asinh

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

Specified by:

asinh in interface LinearAlgebraProvider<E>

acosh

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

Specified by:

acosh in interface LinearAlgebraProvider<E>

atanh

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

Specified by:

atanh in interface LinearAlgebraProvider<E>

sqrt

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

Specified by:

sqrt in interface LinearAlgebraProvider<E>

cbrt

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

Specified by:

cbrt in interface LinearAlgebraProvider<E>

pow

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

Specified by:

pow in interface LinearAlgebraProvider<E>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LinearAlgebraProvider<E>