Struct SymbolTable

pub struct SymbolTable { /* private fields */ }

The global symbol table, mapping names to their definitions.

Names in the symbol table are unique, including between different types of object stored in the symbol table. For example, you cannot have a letting and decision variable with the same name.

Symbol Kinds

The symbol table tracks the following types of symbol:

Decision Variables

find NAME: DOMAIN

See DecisionVariable.

Lettings

Lettings define constants, of which there are two types:

• Constant values: letting val be A, where A is an Expression.

  A can be any integer, boolean, or matrix expression. A can include references to other lettings, model parameters, and, unlike Savile Row, decision variables.

• Constant domains: letting Domain be domain D, where D is a Domain.

  D can include references to other lettings and model parameters, and, unlike Savile Row, decision variables.

Unless otherwise stated, these follow the semantics specified in section 2.2.2 of the Savile Row manual (version 1.9.1 at time of writing).

Implementations

impl SymbolTable

pub fn new() -> SymbolTable

Creates an empty symbol table.

pub fn with_parent(parent: Rc<RefCell<SymbolTable>>) -> SymbolTable

Creates an empty symbol table with the given parent.

pub fn lookup_local(&self, name: &Name) -> Option<Rc<Declaration>>

Looks up the declaration with the given name in the current scope only.

Returns None if there is no declaration with that name in the current scope.

pub fn lookup(&self, name: &Name) -> Option<Rc<Declaration>>

Looks up the declaration with the given name, checking all enclosing scopes.

Returns None if there is no declaration with that name in scope.

pub fn insert(&mut self, declaration: Rc<Declaration>) -> Option<()>

Inserts a declaration into the symbol table.

Returns None if there is already a symbol with this name in the local scope.

pub fn update_insert(&mut self, declaration: Rc<Declaration>)

Updates or adds a declaration in the immediate local scope.

pub fn return_type(&self, name: &Name) -> Option<ReturnType>

Looks up the return type for name if it has one and is in scope.

pub fn return_type_local(&self, name: &Name) -> Option<ReturnType>

Looks up the return type for name if has one and is in the local scope.

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

Looks up the domain of name if it has one and is in scope.

This method can return domain references: if a ground domain is always required, use SymbolTable::resolve_domain.

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

Looks up the domain of name, resolving domain references to ground domains.

See SymbolTable::domain.

pub fn into_iter_local(self) -> LocalIntoIter

Iterates over entries in the local symbol table only.

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

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

pub fn gensym(&self) -> Name

Returns an arbitrary variable name that is not in the symbol table.

pub fn parent_mut_unchecked(&mut self) -> &mut Option<Rc<RefCell<SymbolTable>>>

Gets the parent of this symbol table as a mutable reference.

This function provides no sanity checks.

Trait Implementations

impl Biplate<Expression> for SymbolTable

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

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

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

Biplate variant of [Uniplate::descend]

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

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

fn children_bi(&self) -> VecDeque<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

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<SubModel> for SymbolTable

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

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

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

Biplate variant of [Uniplate::descend]

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

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

fn children_bi(&self) -> VecDeque<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

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Clone for SymbolTable

fn clone(&self) -> SymbolTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolTable

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

Formats the value using the given formatter.

impl Default for SymbolTable

fn default() -> SymbolTable

Returns the “default value” for a type.

impl DefaultWithId for SymbolTable

fn default_with_id(id: u32) -> SymbolTable

Creates a new default value of type T, but with the given id.

impl<'de> Deserialize<'de> for SymbolTable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasId for SymbolTable

fn id(&self) -> u32

The id of this object.

impl IntoIterator for SymbolTable

fn into_iter(self) -> <SymbolTable as IntoIterator>::IntoIter

Iterates over symbol table entries in scope.

type Item = (Name, Rc<Declaration>)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

impl PartialEq for SymbolTable

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

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 Uniplate for SymbolTable

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

Definition of a Uniplate.

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

Applies a function to all direct children of this

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

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

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

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

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

Reconstructs the node with the given children.

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

Applies the given function 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, VecDeque<T>) -> T>) -> T

Performs a fold-like computation on each value.

fn holes(&self) -> impl Iterator<Item = (Self, Arc<dyn Fn(Self) -> Self>)>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts(&self) -> impl Iterator<Item = (Self, Arc<dyn Fn(Self) -> Self>)>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Eq for SymbolTable