Struct zdd::wrapped::Zdd

pub struct Zdd<Label: Eq + Hash + Clone> { /* fields omitted */ }

A wrapper around a ZDD and its factory.

Methods

impl<Label: Eq + Hash + Clone + Ord> Zdd<Label>

pub fn zero(factory: &Factory<Label>) -> Self

Creates an empty wrapped ZDD.

pub fn one(factory: &Factory<Label>) -> Self

Creates a wrapped ZDD containing the empty combination only.

pub fn of(zdd: &HConsed<ZddTree<Label>>, factory: &Factory<Label>) -> Self

Creates a wrapped ZDD from a regular ZDD.

pub fn get(&self) -> &ZddTree<Label>

The underlying Zdd.

pub fn get_factory(&self) -> &Factory<Label>

The underlying factory.

pub fn add_one(&self) -> Self

Adds the empty combination to a ZDD if it's not already there.

pub fn rm_one(&self) -> Self

Removes the empty combination from a ZDD if it's there.

pub fn lft(&self) -> Result<Zdd<Label>, bool>

Returns the left subtree if the ZDD is a node, an error

• of true if the ZDD is One (more precisely HasOne(Zero)) and
• of false if it is Zero.

pub fn rgt(&self) -> Result<Zdd<Label>, bool>

Returns the right subtree if the ZDD is a node, an error of true if the ZDD is One and false if it is Zero.

pub fn kids(&self) -> Result<(Zdd<Label>, Zdd<Label>), bool>

Returns the subtrees if the ZDD is a node, an error of true if the ZDD is One and false if it is Zero.

pub fn count(&self) -> usize

The number of combinations in a ZDD. Cached.

pub fn offset(&self, lbl: Label) -> Self

The set of combinations of zdd in which lbl does not appear. Cached.

pub fn onset(&self, lbl: Label) -> Self

The set of combinations of zdd in which lbl appears, without lbl in them. Cached.

pub fn change(&self, lbl: Label) -> Self

Switches lbl in each combination of zdd. Inverts offset and onset. Cached.

pub fn union(&self, rhs: Self) -> Self

The union of two ZDDs. Cached.

pub fn inter(&self, rhs: Self) -> Self

The intersection of two ZDDs. Cached.

pub fn minus(&self, rhs: Self) -> Self

The difference of two ZDDs. Cached.

pub fn subset(&self, rhs: Self) -> bool

Returns true iff lhs is a subset of rhs. Cached.

Methods from Deref<Target = ZddTree<Label>>

pub fn iter(&self) -> Iterator<Label>

Returns an iterator over a ZddTree. There's no into_iter since a ZDD is immutable anyway.

Trait Implementations

impl<'a, Label: Eq + Hash + Clone + Ord> Add<&'a Zdd<Label>> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Zdd<Label>) -> Zdd<Label>

Performs the + operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> Add<&'a Zdd<Label>> for &'b Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Zdd<Label>) -> Zdd<Label>

Performs the + operation.

impl<Label: Eq + Hash + Clone + Ord> Add<Zdd<Label>> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the + operator.

fn add(self, rhs: Zdd<Label>) -> Zdd<Label>

Performs the + operation.

impl<'a, Label: Eq + Hash + Clone + Ord> Add<Zdd<Label>> for &'a Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the + operator.

fn add(self, rhs: Zdd<Label>) -> Zdd<Label>

Performs the + operation.

impl<'a, Label: Eq + Hash + Clone + Ord> BitAnd<&'a Zdd<Label>> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Zdd<Label>) -> Zdd<Label>

Performs the & operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> BitAnd<&'a Zdd<Label>> for &'b Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Zdd<Label>) -> Zdd<Label>

Performs the & operation.

impl<Label: Eq + Hash + Clone + Ord> BitAnd<Zdd<Label>> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the & operator.

fn bitand(self, rhs: Zdd<Label>) -> Zdd<Label>

Performs the & operation.

impl<'a, Label: Eq + Hash + Clone + Ord> BitAnd<Zdd<Label>> for &'a Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the & operator.

fn bitand(self, rhs: Zdd<Label>) -> Zdd<Label>

Performs the & operation.

impl<'a, Label: Eq + Hash + Clone + Ord> BitOr<&'a Label> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Label) -> Zdd<Label>

Performs the | operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> BitOr<&'a Label> for &'b Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Label) -> Zdd<Label>

Performs the | operation.

impl<Label: Eq + Hash + Clone + Ord> BitOr<Label> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the | operator.

fn bitor(self, lbl: Label) -> Zdd<Label>

Performs the | operation.

impl<'a, Label: Eq + Hash + Clone + Ord> BitOr<Label> for &'a Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the | operator.

fn bitor(self, rhs: Label) -> Zdd<Label>

Performs the | operation.

impl<'a, Label: Eq + Hash + Clone + Ord> BitXor<&'a Label> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Label) -> Zdd<Label>

Performs the ^ operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> BitXor<&'a Label> for &'b Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Label) -> Zdd<Label>

Performs the ^ operation.

impl<Label: Eq + Hash + Clone + Ord> BitXor<Label> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the ^ operator.

fn bitxor(self, lbl: Label) -> Zdd<Label>

Performs the ^ operation.

impl<'a, Label: Eq + Hash + Clone + Ord> BitXor<Label> for &'a Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Label) -> Zdd<Label>

Performs the ^ operation.

impl<Label: Clone + Eq + Hash> Clone for Zdd<Label>

fn clone(&self) -> Zdd<Label>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Label: Eq + Hash + Clone> Deref for Zdd<Label>

type Target = ZddTree<Label>

The resulting type after dereferencing.

fn deref(&self) -> &ZddTree<Label>

Dereferences the value.

impl<Label: Eq + Hash + Clone + Ord + Display> Display for Zdd<Label>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<Label: Eq + Hash + Clone> Eq for Zdd<Label>

impl<Label: Eq + Hash + Clone> Hash for Zdd<Label>

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<Label: Eq + Hash + Clone> Ord for Zdd<Label>

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Label: Eq + Hash + Clone> PartialEq<Zdd<Label>> for Zdd<Label>

fn eq(&self, rhs: &Self) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Label: Eq + Hash + Clone> PartialOrd<Zdd<Label>> for Zdd<Label>

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a, Label: Eq + Hash + Clone + Ord> Rem<&'a Label> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Label) -> Zdd<Label>

Performs the % operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> Rem<&'a Label> for &'b Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Label) -> Zdd<Label>

Performs the % operation.

impl<Label: Eq + Hash + Clone + Ord> Rem<Label> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the % operator.

fn rem(self, lbl: Label) -> Zdd<Label>

Performs the % operation.

impl<'a, Label: Eq + Hash + Clone + Ord> Rem<Label> for &'a Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the % operator.

fn rem(self, rhs: Label) -> Zdd<Label>

Performs the % operation.

impl<Label: Eq + Hash + Clone> Send for Zdd<Label>

impl<'a, Label: Eq + Hash + Clone + Ord> Shl<&'a Zdd<Label>> for Zdd<Label>

type Output = bool

The resulting type after applying the << operator.

fn shl(self, rhs: &'a Zdd<Label>) -> bool

Performs the << operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> Shl<&'a Zdd<Label>> for &'b Zdd<Label>

type Output = bool

The resulting type after applying the << operator.

fn shl(self, rhs: &'a Zdd<Label>) -> bool

Performs the << operation.

impl<Label: Eq + Hash + Clone + Ord> Shl<Zdd<Label>> for Zdd<Label>

type Output = bool

The resulting type after applying the << operator.

fn shl(self, rhs: Zdd<Label>) -> bool

Performs the << operation.

impl<'a, Label: Eq + Hash + Clone + Ord> Shl<Zdd<Label>> for &'a Zdd<Label>

type Output = bool

The resulting type after applying the << operator.

fn shl(self, rhs: Zdd<Label>) -> bool

Performs the << operation.

impl<'a, Label: Eq + Hash + Clone + Ord> Sub<&'a Zdd<Label>> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Zdd<Label>) -> Zdd<Label>

Performs the - operation.

impl<'a, 'b, Label: Eq + Hash + Clone + Ord> Sub<&'a Zdd<Label>> for &'b Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Zdd<Label>) -> Zdd<Label>

Performs the - operation.

impl<Label: Eq + Hash + Clone + Ord> Sub<Zdd<Label>> for Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the - operator.

fn sub(self, rhs: Zdd<Label>) -> Zdd<Label>

Performs the - operation.

impl<'a, Label: Eq + Hash + Clone + Ord> Sub<Zdd<Label>> for &'a Zdd<Label>

type Output = Zdd<Label>

The resulting type after applying the - operator.

fn sub(self, rhs: Zdd<Label>) -> Zdd<Label>

Performs the - operation.

impl<Label: Eq + Hash + Clone> Sync for Zdd<Label>

impl<Label: Display + Ord + Hash + Clone> ZddPrint<Label> for Zdd<Label>

fn print(&self, pref: String)

Pretty prints a ZDD with a prefix.

fn write_as_gv(&self, wrt: &mut impl Write) -> Result<()>

Logs a ZDD as graphviz to a Write.

impl<Label: Eq + Hash + Ord + Clone> ZddTreeOps<Label> for Zdd<Label>

fn is_zero(&self) -> bool

Returns true iff the ZDD is zero.

fn is_one(&self) -> bool

Returns true iff the ZDD is one.

fn has_one(&self) -> bool

Returns true for all ZDDs containing the empty combination.

fn top(&self) -> Result<Label, bool>

Returns the top label if the ZDD is a node, an error of true if the ZDD is one and false if it is zero.

fn to_set(&self) -> BTreeSet<BTreeSet<Label>>

Turns a ZDD in the corresponding set of sets of labels.

fn iter(&self) -> Iterator<Label>

Returns an iterator over a ZDD.