Struct Set32

pub struct Set32 { /* private fields */ }

This structure implemts a bitset with a maximum capacity of $capa bits. The structure requires no dynamic allocation and it is therefore fully copiable

Implementations

impl Set32

pub const fn empty() -> Self

Creates an empty set

pub const fn full() -> Self

Creates a set where all items are present

pub const fn singleton(x: usize) -> Self

Creates a singleton set comprising one single item

pub const fn capacity(self) -> usize

Returns the capacity of the bitset

pub fn len(self) -> usize

Returns the lenght of the set. That is the number of itemes present (value of the bit is 1) in the set

pub fn is_empty(self) -> bool

Returns true iff the set is empty

pub const fn contains(self, x: usize) -> bool

Returns true iff the set contains item ‘x’

pub const fn add(self, x: usize) -> Self

Returns a new set where item x is present in the set

pub fn add_inplace(&mut self, x: usize) -> &mut Self

Adds the item x to this set

pub const fn remove(self, x: usize) -> Self

Returns a new set where item x is absent from the set

pub fn remove_inplace(&mut self, x: usize) -> &mut Self

Removes x from the current set

pub fn union(self, other: Self) -> Self

Returns the union of both sets

pub fn union_inplace(&mut self, other: &Self) -> &mut Self

Updates this set so that it contains the union of self and other

pub fn inter(self, other: Self) -> Self

Returns a set which is the intersection of both sets

pub fn inter_inplace(&mut self, other: &Self) -> &mut Self

Updates this set so that it contains the intersection of self and other

pub fn diff(self, other: Self) -> Self

Returns a set which is the difference of the two sets

pub fn diff_inplace(&mut self, other: &Self) -> &mut Self

Updates this set so that it contains the difference of self and other

pub fn symmetric_difference(self, other: Self) -> Self

Returns a set which is the exclusive or of the two sets

pub fn symmetric_difference_inplace(&mut self, other: &Self) -> &mut Self

Updates this set so that it contains the exclusive or of self and other

pub fn flip(self) -> Self

Flips all the bits of self (all members are removed, all absent are added)

pub fn flip_inplace(&mut self) -> &mut Self

Updates this set so that it contains the negation of self

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

Returns true iff this set contains all the elements of the other set. (self is a superset of other).

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

Return true iff the two sets are disjoint

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

Returns true iff the intersects with other set

pub fn iter(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator that goes over all the items present in this set

pub fn ones(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator that goes over all the items present in this set

pub fn zeroes(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator that goes over all the items absent from this set

pub fn subsets(&self, of_size: usize) -> impl Iterator<Item = Self> + '_

Returns an iterator that goes over all the items absent from this set Requires the alloc feature

pub const fn inc(self) -> Self

Returns the next value when considering the bitset as a large integer value and incrementing it by one.

pub fn inc_inplace(&mut self) -> &mut Self

Consider the bitset as a large integer value and increments it by one

Trait Implementations

impl BitAnd for Set32

type Output = Set32

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for Set32

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Set32

type Output = Set32

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for Set32

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for Set32

type Output = Set32

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for Set32

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Set32

fn clone(&self) -> Set32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Set32

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

Formats the value using the given formatter.

impl Default for Set32

fn default() -> Self

Returns the “default value” for a type.

impl Display for Set32

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

Formats the value using the given formatter.

impl From<[u32; 1]> for Set32

fn from(x: [u32; 1]) -> Set32

Converts to this type from the input type.

impl From<Set32> for [u32; 1]

fn from(x: Set32) -> [u32; 1]

Converts to this type from the input type.

impl From<Set32> for u32

fn from(x: Set32) -> u32

Converts to this type from the input type.

impl From<u32> for Set32

fn from(x: u32) -> Set32

Converts to this type from the input type.

impl Hash for Set32

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 Not for Set32

type Output = Set32

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Set32

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd for Set32

fn partial_cmp(&self, other: &Set32) -> 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 Copy for Set32

impl Eq for Set32

impl StructuralPartialEq for Set32