Class AbstractNativeSIMDLinearAlgebraBackend<E>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NativeSIMDComplexBackend, NativeSIMDRealBackend

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

SIMD-accelerated Linear Algebra Backend for Real numbers using JDK Vector API.

Since:

1.2

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Field Summary

Fields

Modifier and Type	Field	Description
protected final Ring<E>	ring

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNativeSIMDLinearAlgebraBackend(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)
E	angle(Vector<E> a, Vector<E> b)	Returns the angle between two vectors in radians.
Matrix<E>	asin(Matrix<E> a)
Matrix<E>	asinh(Matrix<E> a)
Matrix<E>	atan(Matrix<E> a)
Matrix<E>	atanh(Matrix<E> a)
Matrix<E>	cbrt(Matrix<E> a)
CholeskyResult<E>	cholesky(Matrix<E> a)	Computes the Cholesky decomposition of the specified matrix.
Matrix<E>	cos(Matrix<E> a)
Matrix<E>	cosh(Matrix<E> a)
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> 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.
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getAlgorithmType()	Returns the unique category of the algorithm.
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	getPreferredVectorWidth()	Returns the preferred vector width in bytes for double operations.
int	getPriority()	Priority of this provider (higher means more preferred).
String	getSimdLevel()	Returns the SIMD instruction set level available.
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> 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)
Vector<E>	normalize(Vector<E> v)	Returns the normalized vector (unit vector).
Matrix<E>	pow(Matrix<E> a, 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.
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(LUResult<E> lu, Vector<E> b)	Solves Ax = b using a previously computed LU 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, getStatusMessage

Methods inherited from interface ComputeBackend

createBackend, getDescription

Methods inherited from interface CPUBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface LinearAlgebraProvider

close, conditionNumber, configure, conjugateTranspose, getEnvironmentInfo, rank, score, solve, solve

Field Details

ring

protected final Ring<E> ring

Constructor Details

AbstractNativeSIMDLinearAlgebraBackend

protected AbstractNativeSIMDLinearAlgebraBackend(Ring<E> ring)

Method Details

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

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

Specified by:

getType in interface SIMDBackend

getAlgorithmType

public String getAlgorithmType()

Description copied from interface: AlgorithmProvider

Returns the unique category of the algorithm.

Specified by:

getAlgorithmType in interface AlgorithmProvider

Specified by:

getAlgorithmType in interface LinearAlgebraProvider<E>

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

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

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

Specified by:

getAcceleratorType in interface SIMDBackend

Returns:

the accelerator type

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

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

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>

getSimdLevel

public String getSimdLevel()

Description copied from interface: SIMDBackend

Returns the SIMD instruction set level available.

Examples: "AVX2", "AVX-512", "NEON", "SVE", "GENERIC"

Specified by:

getSimdLevel in interface SIMDBackend

getPreferredVectorWidth

public int getPreferredVectorWidth()

Description copied from interface: SIMDBackend

Returns the preferred vector width in bytes for double operations.

Typical values: 32 (AVX2), 64 (AVX-512), 16 (NEON)

Specified by:

getPreferredVectorWidth in interface SIMDBackend

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

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>

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)

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>

multiply

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

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>

subtract

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

Specified by:

subtract in interface LinearAlgebraProvider<E>

scale

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

Specified by:

scale in interface LinearAlgebraProvider<E>

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>

pow

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

Specified by:

pow in interface LinearAlgebraProvider<E>

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>

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>

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>

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>