Struct Model

pub struct Model {
    pub constraints: Vec<Expression>,
    pub context: Arc<RwLock<Context<'static>>>,
    /* private fields */
}

Represents a computational model containing variables, constraints, and a shared context.

The Model struct holds a set of variables and constraints for manipulating and evaluating symbolic expressions.

Fields

• constraints:

  • Type: Vec<Expression>
  • Represents the logical constraints applied to the model’s variables.
  • Can be a single constraint or a combination of various expressions, such as logical operations (e.g., AND, OR), arithmetic operations (e.g., SafeDiv, UnsafeDiv), or specialized constraints like SumEq.

• context:

  • Type: Arc<RwLock<Context<'static>>>
  • A shared object that stores global settings and state for the model.
  • Can be safely read or changed by multiple parts of the program at the same time, making it good for multi-threaded use.

Usage

This struct is typically used to:

• Define a set of variables and constraints for rule-based evaluation.
• Have transformations, optimizations, and simplifications applied to it using a set of rules.

Fields

constraints: Vec<Expression>

context: Arc<RwLock<Context<'static>>>

Implementations

impl Model

pub fn new( symbols: SymbolTable, constraints: Vec<Expression>, context: Arc<RwLock<Context<'static>>>, ) -> Model

Creates a new model.

pub fn new_empty(context: Arc<RwLock<Context<'static>>>) -> Model

pub fn symbols(&self) -> &SymbolTable

The global symbol table for this model.

pub fn symbols_mut(&mut self) -> &mut SymbolTable

The global symbol table for this model, as a mutable reference.

pub fn update_domain(&mut self, name: &Name, new_domain: Domain)

pub fn get_domain(&self, name: &Name) -> Option<&Domain>

Gets the domain of name if it exists and has one.

pub fn add_variable( &mut self, name: Name, decision_var: DecisionVariable, ) -> Option<()>

Adds a decision variable to the model.

Returns None if there is a decision variable or other object with that name in the symbol table.

pub fn get_constraints_vec(&self) -> Vec<Expression>

pub fn set_constraints(&mut self, constraints: Vec<Expression>)

pub fn set_context(&mut self, context: Arc<RwLock<Context<'static>>>)

pub fn add_constraint(&mut self, expression: Expression)

pub fn add_constraints(&mut self, expressions: Vec<Expression>)

pub fn gensym(&self) -> Name

Returns an arbitrary variable name that is not in the model.

pub fn extend_sym_table(&mut self, other: SymbolTable)

Extends the models symbol table with the given symbol table, updating the gensym counter if necessary.

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Model

fn deserialize<__D>( __deserializer: __D, ) -> Result<Model, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Model

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

Formats the value using the given formatter.

impl PartialEq for Model

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Model