Enum Expression

pub enum Expression {
    Zero,
    One,
    Amp(AmplitudeID),
    Add(Box<Expression>, Box<Expression>),
    Sub(Box<Expression>, Box<Expression>),
    Mul(Box<Expression>, Box<Expression>),
    Div(Box<Expression>, Box<Expression>),
    Neg(Box<Expression>),
    Real(Box<Expression>),
    Imag(Box<Expression>),
    Conj(Box<Expression>),
    NormSqr(Box<Expression>),
}

An expression tree which contains AmplitudeIDs and operators over them.

Variants

Zero

A expression equal to zero.

One

A expression equal to one.

Amp(AmplitudeID)

A registered Amplitude referenced by an AmplitudeID.

Add(Box<Expression>, Box<Expression>)

The sum of two Expressions.

Sub(Box<Expression>, Box<Expression>)

The difference of two Expressions.

Mul(Box<Expression>, Box<Expression>)

The product of two Expressions.

Div(Box<Expression>, Box<Expression>)

The division of two Expressions.

Neg(Box<Expression>)

The additive inverse of an Expression.

Real(Box<Expression>)

The real part of an Expression.

Imag(Box<Expression>)

The imaginary part of an Expression.

Conj(Box<Expression>)

The complex conjugate of an Expression.

NormSqr(Box<Expression>)

The absolute square of an Expression.

Implementations

impl Expression

pub fn evaluate(&self, amplitude_values: &AmplitudeValues) -> Complex<Float>

Evaluate an Expression over a single event using calculated AmplitudeValues

This method parses the underlying Expression but doesn’t actually calculate the values from the Amplitudes themselves.

pub fn evaluate_gradient( &self, amplitude_values: &AmplitudeValues, gradient_values: &GradientValues, ) -> DVector<Complex<Float>>

Evaluate the gradient of an Expression over a single event using calculated AmplitudeValues

This method parses the underlying Expression but doesn’t actually calculate the gradient from the Amplitudes themselves.

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

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Expression> for &AmplitudeID

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 AmplitudeID

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

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Expression> for &AmplitudeID

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 AmplitudeID

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

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Expression> for &AmplitudeID

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 AmplitudeID

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

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Expression> for &AmplitudeID

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 AmplitudeID

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 From<AmplitudeID> for Expression

fn from(value: AmplitudeID) -> Self

Converts to this type from the input type.

impl Mul<&AmplitudeID> for &Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Expression> for &AmplitudeID

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 AmplitudeID

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

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Expression> for &AmplitudeID

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 AmplitudeID

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

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Expression> for &AmplitudeID

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 AmplitudeID

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

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<AmplitudeID> for Expression

type Output = Expression

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Expression> for &AmplitudeID

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 AmplitudeID

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.