Enum Tree

pub enum Tree<B, U, A>
where
    B: Symbolic,
    U: Symbolic,
    A: Symbolic,
{
    Binary {
        conn: B,
        left: Box<Tree<B, U, A>>,
        right: Box<Tree<B, U, A>>,
    },
    Unary {
        conn: U,
        next: Box<Tree<B, U, A>>,
    },
    Atom(A),
}

Classic tree implementation, but the enum variants for Binary, Unary and Atom ensure that ill-formed formulas can never be constructed. Uses Box as internal pointer because we modify formulae through a zipper. Within the formula struct, represents the untraversed/‘unzipped’ parts of the formula.

Variants

Binary

Fields

conn: B

left: Box<Tree<B, U, A>>

right: Box<Tree<B, U, A>>

Unary

Fields

conn: U

next: Box<Tree<B, U, A>>

Atom(A)

Implementations

impl<B, U, A> Tree<B, U, A>

where B: Symbolic, U: Symbolic, A: Symbolic,

Only the most basic manipulations (adding unary operators and combining formulas) are provided; more complex manipulations are provided by the Formula which is much more ergonomic for expressing in-place mutation using its internal Zipper Zipper: Zipper Formula: Formula

pub fn new(atom: A) -> Self

pub fn is_atomic(&self) -> bool

pub fn is_unary(&self) -> bool

pub fn is_binary(&self) -> bool

pub fn inorder_traverse<F: FnMut(&Self) -> Option<()>>( &self, func: &mut F, ) -> Option<()>

Inorder traversal starting at the current zipper. Does not mutate the formula at all but the closure passed in is still std::ops::FnMut so that other state can be mutated. As usual returns [Option<()>] so that traversal can be stopped early by returning None.

pub fn preorder_traverse<F: FnMut(&Self) -> Option<()>>( &self, func: &mut F, ) -> Option<()>

Preorder traversal starting at the current context. Also takes in a closure that can read the formula.

pub fn combine(&mut self, bin: B, formula: Self)

Combine two trees with a binary operator, inserting the new tree on the right side.

pub fn left_combine(&mut self, bin: B, formula: Self)

Combine with new tree on the left!

pub fn unify(&mut self, un: U)

Add a unary operator to the existing formula.

pub fn read_inorder(&self, repr: &mut String)

Print the customary inorder traversal of a tree formula into an outparameter.

Trait Implementations

impl<B, U, A> Clone for Tree<B, U, A>

where B: Symbolic + Clone, U: Symbolic + Clone, A: Symbolic + Clone,

fn clone(&self) -> Tree<B, U, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B, U, A> Debug for Tree<B, U, A>

where B: Symbolic + Debug, U: Symbolic + Debug, A: Symbolic + Debug,

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

Formats the value using the given formatter.

impl<B, U, A> Default for Tree<B, U, A>

where B: Symbolic, U: Symbolic, A: Symbolic,

fn default() -> Self

Assuming A::default() returns a 0 value, effectively amounts to a null value without allowing invalid trees to be constructed.

impl<B, U, A> Display for Tree<B, U, A>

where B: Symbolic, U: Symbolic, A: Symbolic,

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

Formats the value using the given formatter.

impl<B, U, A> From<&Formula<B, U, A>> for Tree<B, U, A>

where B: Symbolic, U: Symbolic, A: Symbolic,

If you’re really lazy I guess!

fn from(value: &Formula<B, U, A>) -> Self

Converts to this type from the input type.

impl<B, U, A> From<Tree<B, U, A>> for Formula<B, U, A>

where B: Symbolic, U: Symbolic, A: Symbolic,

fn from(value: Tree<B, U, A>) -> Self

Converts to this type from the input type.

impl<B, U, A> Hash for Tree<B, U, A>

where B: Symbolic + Hash, U: Symbolic + Hash, A: Symbolic + Hash,

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<B, U, A> Ord for Tree<B, U, A>

where B: Symbolic + Ord, U: Symbolic + Ord, A: Symbolic + Ord,

fn cmp(&self, other: &Tree<B, U, A>) -> 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<B, U, A> PartialEq for Tree<B, U, A>

where B: Symbolic + PartialEq, U: Symbolic + PartialEq, A: Symbolic + PartialEq,

fn eq(&self, other: &Tree<B, U, A>) -> 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<B, U, A> PartialOrd for Tree<B, U, A>

where B: Symbolic + PartialOrd, U: Symbolic + PartialOrd, A: Symbolic + PartialOrd,

fn partial_cmp(&self, other: &Tree<B, U, A>) -> 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<B, U, A> Eq for Tree<B, U, A>

where B: Symbolic + Eq, U: Symbolic + Eq, A: Symbolic + Eq,

impl<B, U, A> StructuralPartialEq for Tree<B, U, A>

where B: Symbolic, U: Symbolic, A: Symbolic,