Struct QuantumOperator 

pub struct QuantumOperator { /* private fields */ }

Named linear combination of operator components.

Implementations

impl QuantumOperator

pub fn new( components: impl IntoIterator<Item = QuantumComponent>, ) -> Result<Self>

Construct a named linear family after validating names and shapes.

pub const fn shape(&self) -> (usize, usize)

Return the common rectangular shape of every component.

pub fn component_names(&self) -> impl Iterator<Item = &str>

Iterate component names in stable coefficient order.

pub fn components(&self) -> &[QuantumComponent]

Return every named component in stable coefficient order.

pub fn component(&self, name: &str) -> Result<&Operator>

Look up one named component or return an invalid-options error.

pub fn resolve_coefficients( &self, parameters: &HashMap<String, Complex64>, ) -> Result<Vec<Complex64>>

Resolve named parameters into the stable component order returned by Self::component_names.

This is the allocation-light coefficient boundary used by dynamic frontends: names are validated once at the edge, while repeated operator applications consume a compact coefficient slice.

pub fn apply_coefficients( &self, coefficients: &[Complex64], input: &[Complex64], output: &mut [Complex64], ) -> Result<()>

Apply a compact ordered coefficient vector without materializing the linear combination.

pub fn apply( &self, parameters: &HashMap<String, Complex64>, input: &[Complex64], output: &mut [Complex64], ) -> Result<()>

Apply one named member of the family without assembling a temporary sparse matrix.

pub fn evaluate( &self, parameters: &HashMap<String, Complex64>, format: MatrixFormat, ) -> Result<Operator>

Materialize one parameter value in the requested format.

For repeated evaluations prefer QuantumOperator::plan, which retains a common sparse pattern and updates only numeric values.

pub fn plan(&self, format: MatrixFormat) -> Result<QuantumOperatorPlan>

Prepare a fixed sparse pattern for repeated evaluations of this family.

The plan aligns every component on one union pattern, reuses all index arrays, and mutates only a preallocated value buffer. It supports dense, CSC, CSR, DIA, and matrix-free output without a model-specific fast path.

pub fn scaled(&self, coefficient: impl Into<Complex64>) -> Result<Self>

pub fn conjugated(&self) -> Result<Self>

pub fn add(&self, right: &Self) -> Result<Self>

pub fn adjoint(&self) -> Result<Self>

pub fn transpose(&self) -> Result<Self>

Trait Implementations

impl Clone for QuantumOperator

fn clone(&self) -> QuantumOperator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QuantumOperator

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

Formats the value using the given formatter.