Class NativeFFTBackend

java.lang.Object

org.episteme.nativ.mathematics.analysis.fft.backends.NativeFFTBackend

All Implemented Interfaces:

FFTProvider, AlgorithmProvider, Backend, ComputeBackend, CPUBackend, NativeBackend

@AutoService({FFTProvider.class,ComputeBackend.class,CPUBackend.class,Backend.class,NativeBackend.class,AlgorithmProvider.class})
public class NativeFFTBackend
extends Object
implements FFTProvider, CPUBackend, NativeBackend

FFTW3 implementation of FFTProvider using Project Panama.

Since:

1.2

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
NativeFFTBackend()

Method Summary

Modifier and Type	Method	Description
ExecutionContext	createContext()	Creates an execution context for running operations.
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getAlgorithmType()	Returns the unique category of the algorithm.
String	getName()	Returns the display name for UI presentation.
String	getNativeLibraryName()	Returns the name of the native library this backend depends on.
int	getPriority()	Returns the execution priority (higher is better).
double[][]	inverseTransform(double[] real, double[] imag)
float[][]	inverseTransform(float[] real, float[] imag)
Real[][]	inverseTransform(Real[] real, Real[] imag)
double[][][]	inverseTransform2D(double[][] real, double[][] imag)
float[][][]	inverseTransform2D(float[][] real, float[][] imag)
Real[][][]	inverseTransform2D(Real[][] real, Real[][] imag)
double[][][][]	inverseTransform3D(double[][][] real, double[][][] imag)
float[][][][]	inverseTransform3D(float[][][] real, float[][][] imag)
Real[][][][]	inverseTransform3D(Real[][][] real, Real[][][] imag)
Complex[]	inverseTransformComplex(Complex[] data)
Complex[][]	inverseTransformComplex2D(Complex[][] data)
Complex[][][]	inverseTransformComplex3D(Complex[][][] data)
boolean	isAvailable()	Checks if the provider is available in the current environment.
boolean	isLoaded()	Checks if the native library is loaded and available.
void	shutdown()	Called when the provider is no longer needed (e.g., application shutdown).
double[][]	transform(double[] real, double[] imag)
float[][]	transform(float[] real, float[] imag)
Real[][]	transform(Real[] real, Real[] imag)
double[][][]	transform2D(double[][] real, double[][] imag)
float[][][]	transform2D(float[][] real, float[][] imag)
Real[][][]	transform2D(Real[][] real, Real[][] imag)
double[][][][]	transform3D(double[][][] real, double[][][] imag)
float[][][][]	transform3D(float[][][] real, float[][][] imag)
Real[][][][]	transform3D(Real[][][] real, Real[][][] imag)
Complex[]	transformComplex(Complex[] data)
Complex[][]	transformComplex2D(Complex[][] data)
Complex[][][]	transformComplex3D(Complex[][][] data)

Methods inherited from class Object

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

Methods inherited from interface AlgorithmProvider

description, getMetadata, score

Methods inherited from interface Backend

getAlgorithmProviders, getStatusMessage, isExplicitlyDisabled

Methods inherited from interface ComputeBackend

createBackend, getDescription, getId

Methods inherited from interface CPUBackend

getType, supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Constructor Details

NativeFFTBackend

public NativeFFTBackend()

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

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

getPriority

public int getPriority()

Description copied from interface: AlgorithmProvider

Returns the execution priority (higher is better).

Specified by:

getPriority in interface AlgorithmProvider

Specified by:

getPriority in interface Backend

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 FFTProvider

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

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

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 FFTProvider

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

transform

public double[][] transform(double[] real,
 double[] imag)

Specified by:

transform in interface FFTProvider

inverseTransform

public double[][] inverseTransform(double[] real,
 double[] imag)

Specified by:

inverseTransform in interface FFTProvider

transform

public Real[][] transform(Real[] real,
 Real[] imag)

Specified by:

transform in interface FFTProvider

inverseTransform

public Real[][] inverseTransform(Real[] real,
 Real[] imag)

Specified by:

inverseTransform in interface FFTProvider

transformComplex

public Complex[] transformComplex(Complex[] data)

Specified by:

transformComplex in interface FFTProvider

inverseTransformComplex

public Complex[] inverseTransformComplex(Complex[] data)

Specified by:

inverseTransformComplex in interface FFTProvider

transform

public float[][] transform(float[] real,
 float[] imag)

Specified by:

transform in interface FFTProvider

inverseTransform

public float[][] inverseTransform(float[] real,
 float[] imag)

Specified by:

inverseTransform in interface FFTProvider

transform2D

public double[][][] transform2D(double[][] real,
 double[][] imag)

Specified by:

transform2D in interface FFTProvider

inverseTransform2D

public double[][][] inverseTransform2D(double[][] real,
 double[][] imag)

Specified by:

inverseTransform2D in interface FFTProvider

transform3D

public double[][][][] transform3D(double[][][] real,
 double[][][] imag)

Specified by:

transform3D in interface FFTProvider

inverseTransform3D

public double[][][][] inverseTransform3D(double[][][] real,
 double[][][] imag)

Specified by:

inverseTransform3D in interface FFTProvider

transform2D

public float[][][] transform2D(float[][] real,
 float[][] imag)

Specified by:

transform2D in interface FFTProvider

inverseTransform2D

public float[][][] inverseTransform2D(float[][] real,
 float[][] imag)

Specified by:

inverseTransform2D in interface FFTProvider

transform3D

public float[][][][] transform3D(float[][][] real,
 float[][][] imag)

Specified by:

transform3D in interface FFTProvider

inverseTransform3D

public float[][][][] inverseTransform3D(float[][][] real,
 float[][][] imag)

Specified by:

inverseTransform3D in interface FFTProvider

transformComplex2D

public Complex[][] transformComplex2D(Complex[][] data)

Specified by:

transformComplex2D in interface FFTProvider

inverseTransformComplex2D

public Complex[][] inverseTransformComplex2D(Complex[][] data)

Specified by:

inverseTransformComplex2D in interface FFTProvider

transformComplex3D

public Complex[][][] transformComplex3D(Complex[][][] data)

Specified by:

transformComplex3D in interface FFTProvider

inverseTransformComplex3D

public Complex[][][] inverseTransformComplex3D(Complex[][][] data)

Specified by:

inverseTransformComplex3D in interface FFTProvider

transform2D

public Real[][][] transform2D(Real[][] real,
 Real[][] imag)

Specified by:

transform2D in interface FFTProvider

inverseTransform2D

public Real[][][] inverseTransform2D(Real[][] real,
 Real[][] imag)

Specified by:

inverseTransform2D in interface FFTProvider

transform3D

public Real[][][][] transform3D(Real[][][] real,
 Real[][][] imag)

Specified by:

transform3D in interface FFTProvider

inverseTransform3D

public Real[][][][] inverseTransform3D(Real[][][] real,
 Real[][][] imag)

Specified by:

inverseTransform3D in interface FFTProvider

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