Struct egg::RecExpr

pub struct RecExpr<L> { /* private fields */ }

A recursive expression from a user-defined Language.

This conceptually represents a recursive expression, but it’s actually just a list of enodes.

RecExprs must satisfy the invariant that enodes’ children must refer to elements that come before it in the list. For example, the expression (+ (* x 5) x) could be represented by a recursive expression of the form [Num(5), Var("x"), Mul(1, 0), Add(2, 1)].

If the serde-1 feature is enabled, this implements serde::Serialize.

Implementations

impl<L: Language> RecExpr<L>

pub fn add(&mut self, node: L) -> Id

Adds a given enode to this RecExpr. The enode’s children Ids must refer to elements already in this list.

pub fn is_dag(&self) -> bool

Checks if this expr is a DAG, i.e. doesn’t have any back edges

impl<L: Language + Display> RecExpr<L>

pub fn pretty(&self, width: usize) -> String

Pretty print with a maximum line length.

This gives you a nice, indented, pretty-printed s-expression.

Example

let e: RecExpr<SymbolLang> = "(* (+ 2 2) (+ x y))".parse().unwrap();
assert_eq!(e.pretty(10), "
(*
  (+ 2 2)
  (+ x y))
".trim());

impl<L: Language> RecExpr<ENodeOrVar<L>>

pub fn alpha_rename(&self) -> Self

Returns a new PatternAst with the variables renames canonically

Trait Implementations

impl<L> AsRef<[L]> for RecExpr<L>

fn as_ref(&self) -> &[L]

Performs the conversion.

impl<L: Clone> Clone for RecExpr<L>

fn clone(&self) -> RecExpr<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Debug> Debug for RecExpr<L>

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

Formats the value using the given formatter.

impl<L> Default for RecExpr<L>

fn default() -> Self

Returns the “default value” for a type.

impl<L: Language + Display> Display for RecExpr<L>

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

Formats the value using the given formatter.

impl<L: Language> From<&'_ RecExpr<L>> for Pattern<L>

fn from(expr: &RecExpr<L>) -> Self

Performs the conversion.

impl<L: Language> From<RecExpr<ENodeOrVar<L>>> for Pattern<L>

fn from(ast: PatternAst<L>) -> Self

Performs the conversion.

impl<L> From<RecExpr<L>> for Vec<L>

fn from(val: RecExpr<L>) -> Self

Performs the conversion.

impl<L> From<Vec<L, Global>> for RecExpr<L>

fn from(nodes: Vec<L>) -> Self

Performs the conversion.

impl<L: FromOp> FromStr for RecExpr<L>

type Err = RecExprParseError<L::Error>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<L: Hash> Hash for RecExpr<L>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<L: Language> Index<Id> for RecExpr<L>

type Output = L

The returned type after indexing.

fn index(&self, id: Id) -> &L

Performs the indexing (container[index]) operation.

impl<L: Language> IndexMut<Id> for RecExpr<L>

fn index_mut(&mut self, id: Id) -> &mut L

Performs the mutable indexing (container[index]) operation.

impl<L: Ord> Ord for RecExpr<L>

fn cmp(&self, other: &RecExpr<L>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<L: PartialEq> PartialEq<RecExpr<L>> for RecExpr<L>

fn eq(&self, other: &RecExpr<L>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RecExpr<L>) -> bool

This method tests for !=.

impl<L: PartialOrd> PartialOrd<RecExpr<L>> for RecExpr<L>

fn partial_cmp(&self, other: &RecExpr<L>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<L: Language + Display> Serialize for RecExpr<L>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<L: Language> TryFrom<Pattern<L>> for RecExpr<L>

type Error = Var

The type returned in the event of a conversion error.

fn try_from(pat: Pattern<L>) -> Result<Self, Self::Error>

Performs the conversion.

impl<L: Eq> Eq for RecExpr<L>

impl<L> StructuralEq for RecExpr<L>

impl<L> StructuralPartialEq for RecExpr<L>