Enum QisError 

pub enum QisError {
    ModeOutOfBounds {
        mode: usize,
        num_modes: usize,
    },
    ModeMismatch {
        expected: usize,
        actual: usize,
    },
    NonFiniteCoefficient {
        coefficient: Complex64,
    },
    InvalidOccupation {
        index: usize,
        value: u8,
    },
    CircuitError(CircuitError),
    QubitMismatch {
        expected: usize,
        actual: usize,
    },
    DimensionMismatch {
        expected: usize,
        actual: usize,
    },
    InvalidStateDimension(usize),
    InvalidProbability(f64),
    IndexOutOfBounds {
        index: usize,
        max: usize,
    },
    UnsupportedOperation(String),
    PauliStringParseError(PauliStringParseError),
    NotNormalized,
    NotHermitian,
    NotPositiveSemidefinite,
    InvalidParameterValue(String),
    InvalidSubsystem(String),
    UnsupportedDimension {
        expected: usize,
        actual: usize,
    },
    NonCliffordGate(String),
}

Comprehensive error type for the qis (Quantum Information Science) module.

This enum captures errors that can occur during statevector simulation, density matrix simulation, observables, Hamiltonians, and Pauli operator manipulations.

Variants

ModeOutOfBounds

A fermionic mode lies outside the declared mode space.

Fields

mode: usize

num_modes: usize

ModeMismatch

Fermionic operators must declare the same mode count.

Fields

expected: usize

actual: usize

NonFiniteCoefficient

Operator coefficients and arithmetic results must be finite.

Fields

coefficient: Complex64

InvalidOccupation

A fermionic occupation must be either zero or one.

Fields

index: usize

value: u8

CircuitError(CircuitError)

Errors originating from quantum circuit operations, such as unsupported gates or symbolic parameters.

QubitMismatch

Thrown when the number of qubits of an operator (e.g., Hamiltonian) does not match the number of qubits of the quantum state being measured.

Fields

expected: usize

actual: usize

DimensionMismatch

Thrown when the dimensions of matrices or vectors do not match expectations (e.g., when multiplying matrices of incompatible shapes).

Fields

expected: usize

actual: usize

InvalidStateDimension(usize)

Thrown when a state vector or density matrix has an invalid length (e.g., its length is not a power of 2).

InvalidProbability(f64)

Thrown when a probability value is mathematically invalid (e.g., < 0 or > 1).

IndexOutOfBounds

Thrown when attempting to access a qubit or amplitude index that is out of bounds.

Fields

index: usize

max: usize

UnsupportedOperation(String)

Thrown when an operation is requested but not supported by the simulation backend.

PauliStringParseError(PauliStringParseError)

Thrown when parsing a Pauli string fails.

NotNormalized

Thrown when an explicitly provided quantum state is not normalized (i.e., trace or norm is not 1).

NotHermitian

Thrown when an operator is expected to be Hermitian but is not (e.g., a non-Hermitian Hamiltonian or density matrix).

NotPositiveSemidefinite

Thrown when a density matrix is expected to be positive semidefinite but is not.

InvalidParameterValue(String)

Thrown when a parameter value is invalid.

InvalidSubsystem(String)

Thrown when a subsystem specification is invalid for entanglement calculations.

UnsupportedDimension

Thrown when an operation requires a specific dimension that is not met.

Fields

expected: usize

actual: usize

NonCliffordGate(String)

Thrown when a gate is applied to a [StabilizerState] but is not a Clifford gate (i.e., it does not map the Pauli group to itself under conjugation). Examples: T, T†, Rx(θ) for generic θ.

Use crate::qis::Statevector for universal (non-Clifford) simulation.

Trait Implementations

impl Debug for QisError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for QisError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for QisError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CircuitError> for QisError

fn from(source: CircuitError) -> Self

Converts to this type from the input type.

impl From<PauliStringParseError> for QisError

fn from(source: PauliStringParseError) -> Self

Converts to this type from the input type.

impl From<QisError> for ErrorMitigationError

fn from(source: QisError) -> Self

Converts to this type from the input type.