Struct 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.

If the serde-1 feature is enabled, this implements [serde::Serialize][https://docs.rs/serde/latest/serde/trait.Serialize.html].

Implementations

impl<L> RecExpr<L>

where L: Language,

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> RecExpr<L>

where L: Language + Display,

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> RecExpr<ENodeOrVar<L>>

where L: Language,

pub fn alpha_rename(&self) -> RecExpr<ENodeOrVar<L>>

Returns a new PatternAst with the variables renames canonically

Trait Implementations

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

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<L> Clone for RecExpr<L>

where L: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L> Debug for RecExpr<L>

where L: Debug,

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

Formats the value using the given formatter.

impl<L> Default for RecExpr<L>

fn default() -> RecExpr<L>

Returns the “default value” for a type.

impl<L> Display for RecExpr<L>

where L: Language + Display,

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

Formats the value using the given formatter.

impl From<&Expr> for &RecExpr<Lambda>

Expr <-> RecExpr

fn from(e: &Expr) -> Self

Converts to this type from the input type.

impl From<Expr> for RecExpr<Lambda>

Expr <-> RecExpr

fn from(e: Expr) -> Self

Converts to this type from the input type.

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

where L: Language,

fn from(ast: RecExpr<ENodeOrVar<L>>) -> Pattern<L>

Converts to this type from the input type.

impl From<RecExpr<Lambda>> for Expr

Expr <-> RecExpr

fn from(e: RecExpr<Lambda>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<L> FromStr for RecExpr<L>

where L: FromOp,

type Err = RecExprParseError<<L as FromOp>::Error>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<RecExpr<L>, <RecExpr<L> as FromStr>::Err>

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

impl<L> Hash for RecExpr<L>

where L: Hash,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

where L: Language,

type Output = L

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

where L: Language,

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

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

impl<L> Ord for RecExpr<L>

where L: Ord,

fn cmp(&self, other: &RecExpr<L>) -> 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<L> PartialEq for RecExpr<L>

where L: PartialEq,

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

where L: PartialOrd,

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

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<L> Serialize for RecExpr<L>

where L: Language + Display,

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<L> TryFrom<Pattern<L>> for RecExpr<L>

where L: Language,

type Error = Var

The type returned in the event of a conversion error.

fn try_from( pat: Pattern<L>, ) -> Result<RecExpr<L>, <RecExpr<L> as TryFrom<Pattern<L>>>::Error>

Performs the conversion.

impl<L> Eq for RecExpr<L>

where L: Eq,

impl<L> StructuralPartialEq for RecExpr<L>