Struct ddo::core::common::VarSet

pub struct VarSet(pub BitSet);

This type denotes a set of variable. It encodes them compactly as a fixed size bitset. A VarSet can be efficiently iterated upon.

Methods

impl VarSet

This is the implementation of the core features of a VarSet (set of variables).

Example

let vs = VarSet::all(3);
assert!(vs.contains(Variable(0)));
assert!(vs.contains(Variable(1)));
assert!(vs.contains(Variable(2)));

pub fn all(n: usize) -> VarSet

Returns a VarSet where all the possible n variables are present.

pub fn empty() -> VarSet

Creates an empty var set

pub fn add(&mut self, v: Variable)

Adds the given variable v to the set if it is not already present.

pub fn remove(&mut self, v: Variable)

Removes the variable v from the set if it was present.

pub fn contains(&self, v: Variable) -> bool

Returns true iff the set contains the variable v.

pub fn len(&self) -> usize

Returns the count of variables that are present in the set.

pub fn is_empty(&self) -> bool

Returns true iff no variables are preset in the set.

pub fn iter(&self) -> VarSetIter

Returns an iterator in this set of variables.

Trait Implementations

impl Clone for VarSet

fn clone(&self) -> VarSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarSet

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

Formats the value using the given formatter.

impl Eq for VarSet

impl<'a> From<&'a VarSet> for Domain<'a>

Implements the conversion from a varset to a domain

fn from(b: &'a VarSet) -> Self

Performs the conversion.

impl Hash for VarSet

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 Ord for VarSet

Any two sets of variables can be compared with a lexicographical ordering on the id of the variables present in the sets. Hence, VarSet implements the standard traits Ord and PartialOrd.

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

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

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

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

This method tests for !=.

impl PartialOrd<VarSet> for VarSet

fn partial_cmp(&self, other: &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 StructuralEq for VarSet

impl StructuralPartialEq for VarSet