Struct biodivine_lib_bdd::BddPointer

pub(crate) struct BddPointer(u32);

(internal) A type-safe index into the Bdd node array representation.

BDD pointers are an internal type-safe wrapper around indices into BDD arrays. Outside this crate, no one should know or care about their existence. Since we can't reasonably expect a BDD to be larger than 2^32 right now, the pointer is represented as u32 instead of usize, because usize can be 64-bits and pointers represent most of the memory consumed by our BDDs.

Implementations

impl BddPointer

pub fn zero() -> BddPointer

Make a new pointer to the 0 terminal node.

pub fn one() -> BddPointer

Make a new pointer to the 1 terminal node.

pub fn is_zero(&self) -> bool

Check if the pointer corresponds to the 0 terminal.

pub fn is_one(&self) -> bool

Check if the pointer corresponds to the 1 terminal.

pub fn is_terminal(&self) -> bool

Check if the pointer corresponds to the 0 or 1 terminal.

pub fn to_index(&self) -> usize

Cast this pointer to standard usize index.

pub fn from_index(index: usize) -> BddPointer

Create a pointer from an usize index.

pub fn from_bool(value: bool) -> BddPointer

Convert a bool value to valid terminal BDD pointer.

pub fn as_bool(&self) -> Option<bool>

If this pointer is a terminal, convert it to bool, otherwise return None.

pub fn flip_if_terminal(&mut self)

If this pointer corresponds to a terminal node, flip it (switching 1 to 0 and vice versa).

pub fn to_le_bytes(&self) -> [u8; 4]

Convert to little endian bytes

pub fn from_le_bytes(bytes: [u8; 4]) -> BddPointer

Read from little endian byte representation

Trait Implementations

impl Clone for BddPointer

pub fn clone(&self) -> BddPointer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BddPointer

impl Debug for BddPointer

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

Formats the value using the given formatter.

impl Display for BddPointer

For display purposes, pointer is just a number.

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

Formats the value using the given formatter.

impl Eq for BddPointer

impl Hash for BddPointer

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for BddPointer

pub fn cmp(&self, other: &BddPointer) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<BddPointer> for BddPointer

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

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

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

This method tests for !=.

impl PartialOrd<BddPointer> for BddPointer

pub fn partial_cmp(&self, other: &BddPointer) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl StructuralEq for BddPointer

impl StructuralPartialEq for BddPointer