Enum Parameter

pub enum Parameter {
    Constant(f64),
    ComplexConstant(Complex64),
    Symbol(SymbolicParameter),
    Symbolic(SymbolicExpression),
}

Parameter value representation for parametric gates

Variants

Constant(f64)

Constant floating-point value

ComplexConstant(Complex64)

Complex constant value

Symbol(SymbolicParameter)

Symbolic parameter with a name and optional value (legacy)

Symbolic(SymbolicExpression)

Full symbolic expression using SymEngine

Implementations

impl Parameter

pub fn constant(value: f64) -> Self

Create a new constant parameter

pub fn complex_constant(value: Complex64) -> Self

Create a new complex constant parameter

pub fn symbol(name: &str) -> Self

Create a new symbolic parameter (legacy)

pub fn symbol_with_value(name: &str, value: f64) -> Self

Create a new symbolic parameter with a value (legacy)

pub fn symbolic(expr: SymbolicExpression) -> Self

Create a symbolic expression parameter

pub fn variable(name: &str) -> Self

Create a symbolic variable

pub fn parse(expr: &str) -> QuantRS2Result<Self>

Parse a parameter from a string expression

pub fn value(&self) -> Option<f64>

Get the value of the parameter, if available

pub fn complex_value(&self) -> Option<Complex64>

Get the complex value of the parameter, if available

pub fn has_value(&self) -> bool

Check if the parameter has a concrete value

pub fn evaluate(&self, variables: &HashMap<String, f64>) -> QuantRS2Result<f64>

Evaluate the parameter with given variable values

pub fn evaluate_complex( &self, variables: &HashMap<String, Complex64>, ) -> QuantRS2Result<Complex64>

Evaluate the parameter with given variable values (complex)

pub fn variables(&self) -> Vec<String>

Get all variable names in the parameter

pub fn substitute( &self, substitutions: &HashMap<String, Parameter>, ) -> QuantRS2Result<Self>

Substitute variables with expressions

pub fn to_symbolic_expression(&self) -> SymbolicExpression

Convert parameter to SymbolicExpression

Trait Implementations

impl Add for Parameter

type Output = Parameter

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Div for Parameter

type Output = Parameter

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<&str> for Parameter

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for Parameter

fn from(value: Complex64) -> Self

Converts to this type from the input type.

impl From<SymbolicExpression> for Parameter

fn from(expr: SymbolicExpression) -> Self

Converts to this type from the input type.

impl From<f64> for Parameter

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Mul for Parameter

type Output = Parameter

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Sub for Parameter

type Output = Parameter

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.