Enum Term 

pub enum Term<T> {
    Value(T),
    Scalar(u128),
    Var(VarValue),
    Add(Box<Self>, Box<Self>),
    Mul(Box<Self>, Box<Self>),
}

A symbolic term that can be used to express simple arithmetic.

Can only be evaluated to a concrete value within a crate::scope::Scope.

Variants

Value(T)

Scalar(u128)

Var(VarValue)

Add(Box<Self>, Box<Self>)

Mul(Box<Self>, Box<Self>)

Implementations

impl Term<u128>

pub fn eval(&self, ctx: &SimpleScope) -> Result<u128, String>

Evaluates the term within the given scope to a concrete value.

pub fn into_chromatic(self, unit: Dimension) -> ChromaticTerm

impl<T> Term<T>

where T: Clone + Display + One + Zero + PartialEq + Eq + ValueFormatter,

pub fn is_const_zero(&self) -> bool

pub fn is_const_one(&self) -> bool

pub fn free_vars(&self, scope: &Scope<Term<T>>) -> Set<String>

Returns the variables of the term that are not part of crate::scope::Scope.

Lambda calculus calls such a variable free. This is the inverse of Self::bound_vars.

pub fn bound_vars(&self, scope: &Scope<Term<T>>) -> Set<String>

Returns the variables of the term that are part of crate::scope::Scope.

Lambda calculus calls such a variable bound. This is the inverse of Self::free_vars.

pub fn fmt_equation(&self, scope: &Scope<Term<T>>) -> String

pub fn into_substituted(self, var: &str, term: &Term<T>) -> Self

pub fn substitute(&mut self, var: &str, term: &Term<T>)

pub fn visit<F, R>(&self, f: &mut F) -> Result<Vec<R>, String>

where F: FnMut(&Self) -> Result<R, String>,

pub fn find_largest_factor(&self, var: &str) -> Option<u128>

Returns the largest pre-factor of the variable in the term.

pub fn as_scalar(&self) -> Option<u128>

pub fn as_var(&self) -> Option<&str>

impl Term<Weight>

pub fn eval(&self, ctx: &ChromaticScope) -> Result<Weight, String>

Evaluates the term within the given scope to a concrete value.

pub fn simplify(&self, unit: Dimension) -> Result<SimpleTerm, String>

pub fn for_values<F>(&self, f: F) -> Result<SimpleTerm, String>

where F: Fn(&Self) -> Result<SimpleTerm, String> + Clone,

pub fn splice_add(self, other: Self) -> Self

Splice orthogonal weight terms together so that they produce a sum.

Trait Implementations

impl<T: Clone> Clone for Term<T>

fn clone(&self) -> Term<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Term<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Term<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Term<T>

where T: Clone + Display + One + Zero + PartialEq + Eq + ValueFormatter,

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

Formats the value using the given formatter.

impl<T: Ord> Ord for Term<T>

fn cmp(&self, other: &Term<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Term<T>

fn eq(&self, other: &Term<T>) -> 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<T: PartialOrd> PartialOrd for Term<T>

fn partial_cmp(&self, other: &Term<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Term<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryInto<Term<u128>> for &ExprBinary

type Error = String

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SimpleTerm, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for Term<T>

impl<T> StructuralPartialEq for Term<T>