Enum Expression

pub enum Expression {
    Bubble(Metadata, Box<Expression>, Box<Expression>),
    FactorE(Metadata, Factor),
    Sum(Metadata, Vec<Expression>),
    Min(Metadata, Vec<Expression>),
    Max(Metadata, Vec<Expression>),
    Not(Metadata, Box<Expression>),
    Or(Metadata, Vec<Expression>),
    And(Metadata, Vec<Expression>),
    Eq(Metadata, Box<Expression>, Box<Expression>),
    Neq(Metadata, Box<Expression>, Box<Expression>),
    Geq(Metadata, Box<Expression>, Box<Expression>),
    Leq(Metadata, Box<Expression>, Box<Expression>),
    Gt(Metadata, Box<Expression>, Box<Expression>),
    Lt(Metadata, Box<Expression>, Box<Expression>),
    SafeDiv(Metadata, Box<Expression>, Box<Expression>),
    UnsafeDiv(Metadata, Box<Expression>, Box<Expression>),
    SumEq(Metadata, Vec<Expression>, Box<Expression>),
    SumGeq(Metadata, Vec<Expression>, Box<Expression>),
    SumLeq(Metadata, Vec<Expression>, Box<Expression>),
    DivEq(Metadata, Box<Expression>, Box<Expression>, Box<Expression>),
    Ineq(Metadata, Box<Expression>, Box<Expression>, Box<Expression>),
    AllDiff(Metadata, Vec<Expression>),
    WatchedLiteral(Metadata, Name, Literal),
    Reify(Metadata, Box<Expression>, Box<Expression>),
    AuxDeclaration(Metadata, Name, Box<Expression>),
}

Represents different types of expressions used to define rules and constraints in the model.

The Expression enum includes operations, constants, and variable references used to build rules and conditions for the model.

Compatability

JsonInput

• And
• Eq
• Geq
• Gt
• Leq
• Lt
• Max
• Min
• Neq
• Not
• Or
• Sum
• UnsafeDiv

SAT

• And
• Not
• Or

Minion

• AllDiff
• AuxDeclaration
• DivEq
• Ineq
• Reify
• Sum
• SumGeq
• SumLeq
• WatchedLiteral

Variants

Bubble(Metadata, Box<Expression>, Box<Expression>)

An expression representing “A is valid as long as B is true” Turns into a conjunction when it reaches a boolean context

FactorE(Metadata, Factor)

Sum(Metadata, Vec<Expression>)

Supported by: Minion, JsonInput.

Min(Metadata, Vec<Expression>)

Supported by: JsonInput.

Max(Metadata, Vec<Expression>)

Supported by: JsonInput.

Not(Metadata, Box<Expression>)

Supported by: JsonInput, SAT.

Or(Metadata, Vec<Expression>)

Supported by: JsonInput, SAT.

And(Metadata, Vec<Expression>)

Supported by: JsonInput, SAT.

Eq(Metadata, Box<Expression>, Box<Expression>)

Supported by: JsonInput.

Neq(Metadata, Box<Expression>, Box<Expression>)

Supported by: JsonInput.

Geq(Metadata, Box<Expression>, Box<Expression>)

Supported by: JsonInput.

Leq(Metadata, Box<Expression>, Box<Expression>)

Supported by: JsonInput.

Gt(Metadata, Box<Expression>, Box<Expression>)

Supported by: JsonInput.

Lt(Metadata, Box<Expression>, Box<Expression>)

Supported by: JsonInput.

SafeDiv(Metadata, Box<Expression>, Box<Expression>)

Division after preventing division by zero, usually with a bubble

UnsafeDiv(Metadata, Box<Expression>, Box<Expression>)

Division with a possibly undefined value (division by 0) Supported by: JsonInput.

SumEq(Metadata, Vec<Expression>, Box<Expression>)

SumGeq(Metadata, Vec<Expression>, Box<Expression>)

Supported by: Minion.

SumLeq(Metadata, Vec<Expression>, Box<Expression>)

Supported by: Minion.

DivEq(Metadata, Box<Expression>, Box<Expression>, Box<Expression>)

Supported by: Minion.

Ineq(Metadata, Box<Expression>, Box<Expression>, Box<Expression>)

Supported by: Minion.

AllDiff(Metadata, Vec<Expression>)

Supported by: Minion.

WatchedLiteral(Metadata, Name, Literal)

w-literal(x,k) is SAT iff x == k, where x is a variable and k a constant.

This is a low-level Minion constraint and you should (probably) use Eq instead. The main use of w-literal is to convert boolean variables to constraints so that they can be used inside watched-and and watched-or.

See rules::minion::boolean_literal_to_wliteral.

Supported by: Minion.

Reify(Metadata, Box<Expression>, Box<Expression>)

Supported by: Minion.

AuxDeclaration(Metadata, Name, Box<Expression>)

Declaration of an auxiliary variable.

As with Savile Row, we semantically distinguish this from Eq. Supported by: Minion.

Implementations

impl Expression

pub fn domain_of(&self, vars: &SymbolTable) -> Option<Domain>

Returns the possible values of the expression, recursing to leaf expressions

pub fn get_meta(&self) -> Metadata

pub fn set_meta(&self, meta: Metadata)

pub fn can_be_undefined(&self) -> bool

pub fn return_type(&self) -> Option<ReturnType>

pub fn is_clean(&self) -> bool

pub fn set_clean(&mut self, bool_value: bool)

pub fn as_factor(&self) -> Option<Factor>

Trait Implementations

impl Biplate<Expression> for Expression

fn biplate( &self, ) -> (Tree<Expression>, Box<dyn Fn(Tree<Expression>) -> Expression>)

Returns all the top most children of type to within from.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Like descend but with more general types.

fn universe_bi(&self) -> Vector<To>

fn children_bi(&self) -> Vector<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

impl Biplate<Expression> for Factor

fn biplate(&self) -> (Tree<Expression>, Box<dyn Fn(Tree<Expression>) -> Factor>)

Returns all the top most children of type to within from.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Like descend but with more general types.

fn universe_bi(&self) -> Vector<To>

fn children_bi(&self) -> Vector<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

impl Biplate<Factor> for Expression

fn biplate(&self) -> (Tree<Factor>, Box<dyn Fn(Tree<Factor>) -> Expression>)

Returns all the top most children of type to within from.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Like descend but with more general types.

fn universe_bi(&self) -> Vector<To>

fn children_bi(&self) -> Vector<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

impl Biplate<Literal> for Expression

fn biplate(&self) -> (Tree<Literal>, Box<dyn Fn(Tree<Literal>) -> Expression>)

Returns all the top most children of type to within from.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Like descend but with more general types.

fn universe_bi(&self) -> Vector<To>

fn children_bi(&self) -> Vector<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

impl Biplate<Metadata> for Expression

fn biplate(&self) -> (Tree<Metadata>, Box<dyn Fn(Tree<Metadata>) -> Expression>)

Returns all the top most children of type to within from.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Like descend but with more general types.

fn universe_bi(&self) -> Vector<To>

fn children_bi(&self) -> Vector<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

impl Biplate<Name> for Expression

fn biplate(&self) -> (Tree<Name>, Box<dyn Fn(Tree<Name>) -> Expression>)

Returns all the top most children of type to within from.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Like descend but with more general types.

fn universe_bi(&self) -> Vector<To>

fn children_bi(&self) -> Vector<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

impl Clone for Expression

fn clone(&self) -> Expression

Returns a copy 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 From<Factor> for Expression

fn from(value: Factor) -> Self

Converts to this type from the input type.

impl From<bool> for Expression

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<i32> for Expression

fn from(i: i32) -> Self

Converts to this type from the input type.

impl PartialEq for Expression

fn eq(&self, other: &Expression) -> 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 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 Uniplate for Expression

fn uniplate( &self, ) -> (Tree<Expression>, Box<dyn Fn(Tree<Expression>) -> Expression>)

fn descend(&self, op: Arc<dyn Fn(Self) -> Self>) -> Self

fn universe(&self) -> Vector<Self>

Gets all children of a node, including itself and all children.

fn children(&self) -> Vector<Self>

Gets the direct children (maximal substructures) of a node.

fn with_children(&self, children: Vector<Self>) -> Self

Reconstructs the node with the given children.

fn transform(&self, f: Arc<dyn Fn(Self) -> Self>) -> Self

Applies the given rule to all nodes bottom up.

fn rewrite(&self, f: Arc<dyn Fn(Self) -> Option<Self>>) -> Self

Rewrites by applying a rule everywhere it can.

fn cata<T>(&self, op: Arc<dyn Fn(Self, Vec<T>) -> T>) -> T

Performs a fold-like computation on each value.

impl Eq for Expression

impl StructuralPartialEq for Expression