Enum SymbolicExpression

pub enum SymbolicExpression {
    Constant(f64),
    ComplexConstant(Complex64),
    Variable(String),
    Simple(SimpleExpression),
}

A symbolic expression that can represent constants, variables, or complex expressions

Variants

Constant(f64)

Constant floating-point value

ComplexConstant(Complex64)

Complex constant value

Variable(String)

Variable with a name

Simple(SimpleExpression)

Simple arithmetic expression for when SymEngine is not available

Implementations

impl SymbolicExpression

pub fn constant(value: f64) -> Self

Create a constant expression

pub fn zero() -> Self

pub fn complex_constant(value: Complex64) -> Self

Create a complex constant expression

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

Create a variable expression

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

Parse an expression from a string

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

Evaluate the expression with given variable values

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

Evaluate complex expression with given variable values

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

Get all variable names in the expression

pub fn is_constant(&self) -> bool

Check if the expression is constant (has no variables)

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

Substitute variables with expressions

Trait Implementations

impl Add for SymbolicExpression

type Output = SymbolicExpression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for SymbolicExpression

fn clone(&self) -> SymbolicExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolicExpression

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

Formats the value using the given formatter.

impl Display for SymbolicExpression

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

Formats the value using the given formatter.

impl Div for SymbolicExpression

type Output = SymbolicExpression

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<&str> for SymbolicExpression

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for SymbolicExpression

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 SymbolicExpression

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Mul for SymbolicExpression

type Output = SymbolicExpression

The resulting type after applying the * operator.

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

Performs the * operation.

impl One for SymbolicExpression

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl PartialEq for SymbolicExpression

fn eq(&self, other: &SymbolicExpression) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for SymbolicExpression

type Output = SymbolicExpression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Zero for SymbolicExpression

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl StructuralPartialEq for SymbolicExpression