Skip to main content

BitSet

Struct BitSet 

Source
pub struct BitSet { /* private fields */ }
Expand description

Bit set providing fast operations on large arrays of bits.

Implementations§

Source§

impl BitSet

Source

pub fn new(bit_capacity: u32) -> BitSet

(b3CreateBitSet)

Source

pub fn destroy(&mut self)

Release the storage. (b3DestroyBitSet)

Rust would drop the storage automatically; this mirrors the C function so ported call sites read the same.

Source

pub fn set_bit_count_and_clear(&mut self, bit_count: u32)

(b3SetBitCountAndClear)

Source

pub fn grow(&mut self, block_count: u32)

(b3GrowBitSet)

Source

pub fn in_place_union(&mut self, other: &BitSet)

In-place union: self |= other. (b3InPlaceUnion)

Source

pub fn count_set_bits(&self) -> i32

Count the number of set bits. (b3CountSetBits, from table.c)

Source

pub fn set_bit(&mut self, bit_index: u32)

Set a bit that must lie within the current block count. (b3SetBit)

Source

pub fn set_bit_grow(&mut self, bit_index: u32)

Set a bit, growing the set if needed. (b3SetBitGrow)

Source

pub fn clear_bit(&mut self, bit_index: u32)

Clear a bit. Out-of-range indices are ignored. (b3ClearBit)

Source

pub fn get_bit(&self, bit_index: u32) -> bool

Get a bit. Out-of-range indices read as false. (b3GetBit)

Source

pub fn bytes(&self) -> i32

Byte size of the allocated storage. (b3GetBitSetBytes)

Source

pub fn block_count(&self) -> u32

Number of active 64-bit blocks (blockCount in C). Used together with BitSet::block to port the C word/CTZ set-bit iteration loops.

Source

pub fn block(&self, block_index: u32) -> u64

The k-th active 64-bit block (bits[k] in C).

Trait Implementations§

Source§

impl Clone for BitSet

Source§

fn clone(&self) -> BitSet

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BitSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BitSet

Source§

fn default() -> BitSet

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.