Class NativeQuantumBackend

java.lang.Object

org.episteme.nativ.physics.quantum.backends.NativeQuantumBackend

All Implemented Interfaces:

AlgorithmProvider, Backend, ComputeBackend, NativeBackend, QuantumBackend

@AutoService({AlgorithmProvider.class,QuantumBackend.class,ComputeBackend.class,Backend.class,NativeBackend.class})
public class NativeQuantumBackend
extends Object
implements NativeBackend, QuantumBackend, AlgorithmProvider

Native Quantum Provider using Panama FFM bindings for QuEST or Qiskit Aer.

Provides high-performance quantum circuit simulation using native libraries.

Since:

1.2

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Nested Class Summary

Nested classes/interfaces inherited from interface QuantumBackend

QuantumBackend.QuantumCircuit, QuantumBackend.QuantumResult

Constructor Summary

Constructors

Constructor	Description
NativeQuantumBackend()

Method Summary

Modifier and Type	Method	Description
QuantumBackend.QuantumCircuit	createCircuit(int numQubits, int numClassicalBits)	Creates a new quantum circuit.
ExecutionContext	createContext()	Creates an execution context for running operations.
QuantumBackend.QuantumResult	executeHardware(QuantumBackend.QuantumCircuit circuit, int shots, String backend)	Executes a quantum circuit on real quantum hardware.
QuantumBackend.QuantumResult	executeSimulator(QuantumBackend.QuantumCircuit circuit, int shots)	Executes a quantum circuit on a simulator.
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getAlgorithmType()	Returns the unique category of the algorithm.
String[]	getAvailableBackends()	Returns available quantum backends (simulators and hardware).
Map<String,Object>	getBackendInfo(String backendName)	Returns backend information (num_qubits, connectivity, etc.).
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 priority for auto-selection (higher = preferred).
String	getStatusMessage()	Returns a human-readable status message for this backend.
boolean	isAvailable()	Checks if this backend is currently available (libraries loaded, etc.).
boolean	isLoaded()	Checks if the native library is loaded and available.
void	runCircuit()
void	shutdown()	Called when the application is shutting down or the backend is being replaced.

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

Methods inherited from interface ComputeBackend

createBackend, getDescription, getId, supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface QuantumBackend

execute, getType

Constructor Details

NativeQuantumBackend

public NativeQuantumBackend()

Method Details

isAvailable

public boolean isAvailable()

Description copied from interface: Backend

Checks if this backend is currently available (libraries loaded, etc.).

Default implementation checks Backend.isExplicitlyDisabled() and returns false if it is.

Specified by:

isAvailable in interface AlgorithmProvider

Specified by:

isAvailable in interface Backend

Specified by:

isAvailable in interface QuantumBackend

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

shutdown

public void shutdown()

Description copied from interface: Backend

Called when the application is shutting down or the backend is being replaced. Use this to release hardware resources, close file handles, or stop background threads.

Specified by:

shutdown in interface AlgorithmProvider

Specified by:

shutdown in interface Backend

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

createCircuit

public QuantumBackend.QuantumCircuit createCircuit(int numQubits,
 int numClassicalBits)

Description copied from interface: QuantumBackend

Creates a new quantum circuit.

Specified by:

createCircuit in interface QuantumBackend

executeSimulator

public QuantumBackend.QuantumResult executeSimulator(QuantumBackend.QuantumCircuit circuit,
 int shots)

Description copied from interface: QuantumBackend

Executes a quantum circuit on a simulator.

Specified by:

executeSimulator in interface QuantumBackend

executeHardware

public QuantumBackend.QuantumResult executeHardware(QuantumBackend.QuantumCircuit circuit,
 int shots,
 String backend)

Description copied from interface: QuantumBackend

Executes a quantum circuit on real quantum hardware.

Specified by:

executeHardware in interface QuantumBackend

getAvailableBackends

public String[] getAvailableBackends()

Description copied from interface: QuantumBackend

Returns available quantum backends (simulators and hardware).

Specified by:

getAvailableBackends in interface QuantumBackend

getBackendInfo

public Map<String,Object> getBackendInfo(String backendName)

Description copied from interface: QuantumBackend

Returns backend information (num_qubits, connectivity, etc.).

Specified by:

getBackendInfo in interface QuantumBackend

getAlgorithmType

public String getAlgorithmType()

Description copied from interface: AlgorithmProvider

Returns the unique category of the algorithm.

Specified by:

getAlgorithmType in interface AlgorithmProvider

getPriority

public int getPriority()

Description copied from interface: Backend

Returns the priority for auto-selection (higher = preferred). Used when multiple backends are available.

Specified by:

getPriority in interface AlgorithmProvider

Specified by:

getPriority in interface Backend

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

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

runCircuit

public void runCircuit()

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