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) -> Vec<String>

Get the list of parameter names in the order they appear in the underlying resources.

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

Get the list of free parameter names.

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

Get the list of fixed parameter names.

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 fix(&self, name: &str, value: f64) -> LadduResult<Self>

Return a new Expression with the given parameter fixed to a value.

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

Return a new Expression with the given parameter freed.

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

Return a new Expression with a single parameter renamed.

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

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.

Trait Implementations

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 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 &Expression

type Output = Expression

The resulting type after applying the + operator.

fn add(self, rhs: Expression) -> 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<'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<&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 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 &Expression

type Output = Expression

The resulting type after applying the / operator.

fn div(self, rhs: Expression) -> 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 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 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 &Expression

type Output = Expression

The resulting type after applying the * operator.

fn mul(self, rhs: Expression) -> 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 ReadWrite for Expression

fn create_null() -> Self

Create a null version of the object which acts as a shell into which Python’s pickle module can load data. This generally shouldn’t be used to construct the struct in regular code.

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<&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 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 &Expression

type Output = Expression

The resulting type after applying the - operator.

fn sub(self, rhs: Expression) -> 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.