Struct BitSeq 

pub struct BitSeq<I: BitRepr> { /* private fields */ }

A sequence of Bits of length up to MAX_LEN = I::BITS, packed into a single word I. The bit at index i is stored at position i of val, i.e. the least-significant bit of val is self[0].

Implementations

impl<I: BitRepr> BitSeq<I>

pub const MAX_LEN: usize = I::BITS

pub fn new(val: I, len: usize) -> Self

pub fn new_rev(val: I, len: usize) -> Self

Like new, but interprets val as bit-reversed so that the most-significant bit becomes self[0].

pub fn empty() -> Self

pub fn zeros(len: usize) -> Self

pub fn ones(len: usize) -> Self

pub fn len(&self) -> usize

pub fn val(&self) -> I

pub fn as_usize(&self) -> usize

The packed word as an index. Panics rather than truncating, which a plain as usize would do once the sequence exceeds usize::BITS.

pub fn is_empty(&self) -> bool

pub fn weight(&self) -> usize

The number of bits set to 1 (Hamming weight).

pub fn iter(&self) -> impl Iterator<Item = Bit> + use<I>

pub fn set(&mut self, i: usize, b: Bit)

pub fn set_0(&mut self, i: usize)

pub fn set_1(&mut self, i: usize)

pub fn push(&mut self, b: Bit)

pub fn push_0(&mut self)

pub fn push_1(&mut self)

pub fn append(&mut self, b: BitSeq<I>)

pub fn remove(&mut self, i: usize)

pub fn insert(&mut self, i: usize, b: Bit)

pub fn insert_0(&mut self, i: usize)

pub fn insert_1(&mut self, i: usize)

pub fn edit<F>(&self, f: F) -> Self

where F: FnOnce(&mut BitSeq<I>),

pub fn sub(&self, l: usize) -> Self

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

true if self is a prefix of other.

pub fn generate(len: usize) -> impl Iterator<Item = BitSeq<I>>

Enumerate all 2^len sequences of the given length, in ascending order of val.

Trait Implementations

impl<I: BitRepr> Add for BitSeq<I>

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: BitSeq<I>) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<&Bit> for &BitSeq<I>

where BitSeq<I>: Clone,

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: &Bit) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<&Bit> for BitSeq<I>

where BitSeq<I>: Clone,

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: &Bit) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<&BitSeq<I>> for &BitSeq<I>

where BitSeq<I>: Clone,

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: &BitSeq<I>) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<&BitSeq<I>> for BitSeq<I>

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: &BitSeq<I>) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<Bit> for &BitSeq<I>

where BitSeq<I>: Clone,

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: Bit) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<Bit> for BitSeq<I>

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: Bit) -> Self::Output

Performs the + operation.

impl<I: BitRepr> Add<BitSeq<I>> for &BitSeq<I>

where BitSeq<I>: Clone,

type Output = BitSeq<I>

The resulting type after applying the + operator.

fn add(self, rhs: BitSeq<I>) -> Self::Output

Performs the + operation.

impl<I: BitRepr> AddAssign for BitSeq<I>

fn add_assign(&mut self, rhs: BitSeq<I>)

Performs the += operation.

impl<I: BitRepr> AddAssign<&Bit> for BitSeq<I>

where BitSeq<I>: Clone,

fn add_assign(&mut self, rhs: &Bit)

Performs the += operation.

impl<I: BitRepr> AddAssign<&BitSeq<I>> for BitSeq<I>

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl<I: BitRepr> AddAssign<Bit> for BitSeq<I>

fn add_assign(&mut self, b: Bit)

Performs the += operation.

impl<I: Clone + BitRepr> Clone for BitSeq<I>

fn clone(&self) -> BitSeq<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Copy + BitRepr> Copy for BitSeq<I>

impl<I: BitRepr> Debug for BitSeq<I>

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

Formats the value using the given formatter.

impl<I: Default + BitRepr> Default for BitSeq<I>

fn default() -> BitSeq<I>

Returns the “default value” for a type.

impl<I: BitRepr> Display for BitSeq<I>

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

Formats the value using the given formatter.

impl<I: Eq + BitRepr> Eq for BitSeq<I>

impl<I: BitRepr, T> From<T> for BitSeq<I>

where Bit: From<T>,

fn from(b: T) -> Self

Converts to this type from the input type.

impl<I: BitRepr, T, const N: usize> From<[T; N]> for BitSeq<I>

where Bit: From<T>,

fn from(value: [T; N]) -> Self

Converts to this type from the input type.

impl<I: BitRepr, T> FromIterator<T> for BitSeq<I>

where Bit: From<T>,

fn from_iter<Itr: IntoIterator<Item = T>>(iter: Itr) -> Self

Creates a value from an iterator.

impl<I: BitRepr> FromStr for BitSeq<I>

type Err = ParseErr

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<I: Hash + BitRepr> Hash for BitSeq<I>

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<I: BitRepr> Index<usize> for BitSeq<I>

type Output = Bit

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I: BitRepr> Ord for BitSeq<I>

Ordered by len, then weight, then raw val.

fn cmp(&self, other: &Self) -> 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<I: PartialEq + BitRepr> PartialEq for BitSeq<I>

fn eq(&self, other: &BitSeq<I>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<I: BitRepr> PartialOrd for BitSeq<I>

fn partial_cmp(&self, other: &Self) -> 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<I: PartialEq + BitRepr> StructuralPartialEq for BitSeq<I>