Enum BasePattern 

pub enum BasePattern {
    Ignore,
    Identifier(Identifier),
    Product(Arc<Self>, Arc<Self>),
}

Basic structure of a SimplicityHL value for pattern matching.

Variants

Ignore

Ignore: Match any value.

Used for matching values that are not assigned to a variable.

Identifier(Identifier)

Variable identifier: Match any value and bind it to an identifier.

Product(Arc<Self>, Arc<Self>)

Product: Match product value component-wise.

Implementations

impl BasePattern

pub fn product(left: Self, right: Self) -> Self

Construct a product of patterns left and right.

pub fn as_identifier(&self) -> Option<&Identifier>

Access the identifier inside an identifier pattern.

pub fn contains(&self, identifier: &Identifier) -> bool

Check if the identifier is contained inside the pattern.

pub fn subsumes(&self, other: &Self) -> bool

Check if self subsumes the other pattern.

Subsumption

• Ignore: _ subsumes every pattern.
• Identifier: a subsumes b iff a = b
• Product: (a1, a2) subsumes (b1, b2) iff a1 subsumes b1 and a2 subsumes b2.

Matching

If value v matches pattern p and pattern p' subsumes p, then v matches p'.

The subsuming pattern is more general than the subsumed pattern.

pub fn identifiers(&self) -> impl Iterator<Item = &Identifier>

Get an iterator over all identifiers inside the pattern.

pub fn contains_all<'a, I>(&self, identifiers: I) -> bool

where I: Iterator<Item = &'a Identifier>,

Check if all identifiers are contained inside the pattern.

pub fn covers(&self, other: &Self) -> bool

Check if self covers the other pattern in terms of variable names.

Coverage

Pattern p1 covers pattern p2 if p1 contains all variable names from p2.

pub fn is_ignore(&self) -> bool

Check if the pattern is the ignore pattern.

pub fn contains_ignore(&self) -> bool

Check if the pattern contains an ignore pattern.

pub fn translate<'brand, P: CoreExt<'brand>>( &self, ctx: &Context<'brand>, to: &Self, ) -> Option<PairBuilder<P>>

Compute a Simplicity expression that takes as input a value that matches the self pattern and that produces as output a value that matches the to pattern.

Panics

The to pattern contains ignore patterns: Every value matches the ignore pattern. This means there are infinitely many translating expressions from self to to. For instance, iden, iden & iden, (iden & iden) & iden, and so on. We enforce a unique translation by banning ignore from the to pattern.

Trait Implementations

impl Clone for BasePattern

fn clone(&self) -> BasePattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasePattern

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

Formats the value using the given formatter.

impl Eq for BasePattern

impl From<&Pattern> for BasePattern

fn from(pattern: &Pattern) -> Self

Converts to this type from the input type.

impl Hash for BasePattern

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BasePattern

fn eq(&self, other: &BasePattern) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BasePattern

impl TreeLike for &BasePattern

fn as_node(&self) -> Tree<Self>

Interpret the node as an abstract node.

fn n_children(&self) -> usize

Accessor for the number of children this node has.

fn nth_child(&self, n: usize) -> Option<Self>

Accessor for the nth child of the node, if a child with that index exists.

fn pre_order_iter(self) -> PreOrderIter<Self>

Obtains an iterator of all the nodes rooted at the node, in pre-order.

fn verbose_pre_order_iter(self) -> VerbosePreOrderIter<Self>

Obtains a verbose iterator of all the nodes rooted at the DAG, in pre-order.

fn post_order_iter(self) -> PostOrderIter<Self>

Obtains an iterator of all the nodes rooted at the DAG, in post order.