Struct Expression 

pub struct Expression { /* private fields */ }

A holder struct that owns both an expression tree and the registered amplitudes.

Implementations

impl Expression

pub fn from_amplitude(amplitude: Box<dyn Amplitude>) -> LadduResult<Self>

Build an Expression from a single Amplitude.

pub fn zero() -> Self

Create an expression representing zero, the additive identity.

pub fn one() -> Self

Create an expression representing one, the multiplicative identity.

pub fn parameters(&self) -> ParameterMap

Get the parameters used by this expression.

pub fn n_free(&self) -> usize

Number of free parameters.

pub fn n_fixed(&self) -> usize

Number of fixed parameters.

pub fn n_parameters(&self) -> usize

Total number of parameters.

pub fn compiled_expression(&self) -> CompiledExpression

Returns a tree-like diagnostic snapshot of this expression’s compiled form.

This compiles the expression on each call with every registered amplitude active. Use Evaluator::compiled_expression when you need the compiled form for a loaded evaluator’s current active-amplitude mask.

pub fn fix_parameter(&self, name: &str, value: f64) -> LadduResult<()>

Fix a parameter used by this expression’s evaluator resources.

pub fn free_parameter(&self, name: &str) -> LadduResult<()>

Mark a parameter used by this expression’s evaluator resources as free.

pub fn rename_parameter(&mut self, old: &str, new: &str) -> LadduResult<()>

Return a new Expression with a single parameter renamed.

pub fn rename_parameters( &mut self, mapping: &HashMap<String, String>, ) -> LadduResult<()>

Return a new Expression with several parameters renamed.

pub fn load(&self, dataset: &Arc<Dataset>) -> LadduResult<Evaluator>

Load an Expression against a dataset, binding amplitudes and reserving caches.

pub fn real(&self) -> Self

Takes the real part of the given Expression.

pub fn imag(&self) -> Self

Takes the imaginary part of the given Expression.

pub fn conj(&self) -> Self

Takes the complex conjugate of the given Expression.

pub fn norm_sqr(&self) -> Self

Takes the absolute square of the given Expression.

pub fn sqrt(&self) -> Self

Takes the square root of the given Expression.

pub fn pow(&self, power: &Expression) -> Self

Raises the given Expression to an expression-valued power.

pub fn powi(&self, power: i32) -> Self

Raises the given Expression to an integer power.

pub fn powf(&self, power: f64) -> Self

Raises the given Expression to a real-valued power.

pub fn exp(&self) -> Self

Takes the exponential of the given Expression.

pub fn sin(&self) -> Self

Takes the sine of the given Expression.

pub fn cos(&self) -> Self

Takes the cosine of the given Expression.

pub fn log(&self) -> Self

Takes the natural logarithm of the given Expression.

pub fn cis(&self) -> Self

Takes the complex phase factor exp(i * expression).

Trait Implementations

impl Add<&Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for &Complex64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for &Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for &f64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for Complex64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for f64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&f64> for &Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&f64> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Expression> for &Complex64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Expression> for &Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Expression> for &f64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Expression> for Complex64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Expression> for f64

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for &Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Expression

fn clone(&self) -> Expression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Expression

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

Formats the value using the given formatter.

impl Default for Expression

fn default() -> Expression

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Expression

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Expression

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

Formats the value using the given formatter.

impl Div<&Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for &Complex64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for &Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for &f64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for Complex64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for f64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&f64> for &Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&f64> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Expression> for &Complex64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Expression> for &Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Expression> for &f64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Expression> for Complex64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Expression> for f64

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for &Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<&Complex<f64>> for Expression

fn from(value: &Complex64) -> Self

Converts to this type from the input type.

impl From<&f64> for Expression

fn from(value: &f64) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for Expression

fn from(value: Complex64) -> Self

Converts to this type from the input type.

impl From<f64> for Expression

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Mul<&Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for &Complex64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for &f64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for Complex64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for f64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Expression> for &Complex64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Expression> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Expression> for &f64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Expression> for Complex64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Expression> for f64

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for &Expression

type Output = Expression

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Expression

type Output = Expression

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Serialize for Expression

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for &Complex64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for &Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for &f64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for Complex64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for f64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&f64> for &Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&f64> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Complex<f64>> for &Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Complex<f64>> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Expression> for &Complex64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Expression> for &Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Expression> for &f64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Expression> for Complex64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Expression> for f64

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for &Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.