Struct GrowingBitmap

pub struct GrowingBitmap { /* private fields */ }

A bitmap that is automatically resized whenever an element higher than the maximum capacity of the bitmap is set. Newly added bits are initialized to 0 (unset).

Implementations

impl GrowingBitmap

pub const EMPTY: &'static GrowingBitmap = _

An empty bitmap

pub const fn new() -> Self

Creates a new, empty, bitmap

pub fn from_slice(slice: &impl BitmapSlice) -> Self

Creates a bitmap and fills it with the data from slice.

pub fn clone_from_slice(&mut self, slice: &impl BitmapSlice)

Clears the current bitmap, then fills it with data from slice.

pub fn new_all_ones(num: usize) -> Self

Creates a new bitmap with num ones.

pub fn new_all_zeros(num: usize) -> Self

Creates a new bitmap with num zeros.

pub fn get(&self, n: usize) -> bool

Returns the value of the nth bit.

pub fn get_then_reset(&mut self, n: usize) -> bool

Returns the value of the nth bit, then resets it to 0.

pub fn and_with(&mut self, rhs: &impl BitmapSlice) -> bool

ANDs the bitmap with rhs.

pub fn or_with(&mut self, rhs: &impl BitmapSlice) -> bool

ORs the bitmap with rhs.

pub fn set(&mut self, n: usize) -> bool

Sets self[n] to true. Returns true if self[n] changed; False if self[n] was already true.

pub fn reset(&mut self, n: usize) -> bool

Sets self[n] to false. Returns true if self[n] changed; False if self[n] was already false.

pub fn extend(&mut self, items: impl IntoIterator<Item = bool>)

Extends the bitmap with items. New values are inserted at the end of the bitmap.

pub fn fill_with_ones(&mut self)

Fills the bitmap with ones.

pub fn count_ones(&self) -> usize

Returns the number of ones in the bitmap.

pub fn count_zeros(&self) -> usize

Returns the number of zeros in the bitmap.

pub fn is_all_zeros(&self) -> bool

Returns true if the bitmap only contains zeros.

pub fn is_all_ones(&self) -> bool

Returns true if the bitmap only contains ones.

pub fn remove(&mut self, n: usize) -> bool

Removes bit n and shifts all bits above n down by one bit.

pub fn remove_front(&mut self, num: usize)

Removes the first num bits, and shifts the other bits down by num bits.

pub fn remove_back(&mut self, num: usize)

Removes the last num bits from the bitmap.

pub fn first_bit_set(&self) -> Option<usize>

Returns the index of the first one bit in the bitmap.

pub fn first_bit_set_from(&self, start_index: usize) -> Option<usize>

Returns the lowest index >= start_index for which self[index] = true

pub fn first_bit_unset_from(&self, start_index: usize) -> Option<usize>

Returns the lowest index >= start_index for which self[index] = false

pub fn first_bit_set_after_many( items: &[&GrowingBitmap], start_index: usize, end_index: usize, ) -> Option<usize>

Returns the index of the first bit set in all bitmaps in items.

pub fn is_superset_of(&self, other: &GrowingBitmap) -> bool

Returns true if for all bits: other[n] implies self[n].

pub fn overlaps_with(&self, other: &impl BitmapSlice) -> bool

Returns true if there are any bits set both in this bitmap and in other.

pub fn clear_from(&mut self, other: &impl BitmapSlice)

Clears the bits in self if they are set in other

pub fn len(&self) -> usize

Returns the length of the bitmap.

pub fn is_empty(&self) -> bool

Returns true if the bitmap is empty.

pub fn iter(&self) -> GrowingBitmapIterator<'_>

Iterates over all bits in the bitmap.

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

Iterates over all indices of the bits that are one.

pub fn data(&self) -> &[u64]

Returns the backing data of the bitmap.

pub fn resize(&mut self, len: usize)

Resizes the bitmap to contain exactly len bits. If the bitmap grows, zero bits are inserted at the end.

pub fn set_range(&mut self, range: Range<usize>)

Sets all bits in range to one.

pub fn clear_range(&mut self, index: Range<usize>)

Sets all bits in range to zero.

pub fn append(&mut self, bitmap: &GrowingBitmap)

Appends bitmap to the bitmap.

pub fn slice(&self, range: Range<usize>) -> impl BitmapSlice + '_

Returns a slice that references the bits in range.

pub fn slice_mut(&mut self, range: Range<usize>) -> impl BitmapSliceMut + '_

Returns a mutable slice that references the bits in range.

pub fn set_all_zero(&mut self)

Sets all bits in the bitmap to zero.

Trait Implementations

impl BitAnd for &GrowingBitmap

type Output = GrowingBitmap

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for GrowingBitmap

type Output = GrowingBitmap

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a> BitAndAssign<&'a GrowingBitmap> for GrowingBitmap

fn bitand_assign(&mut self, rhs: &'a GrowingBitmap)

Performs the &= operation.

impl BitAndAssign for GrowingBitmap

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for &GrowingBitmap

type Output = GrowingBitmap

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr for GrowingBitmap

type Output = GrowingBitmap

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a> BitOrAssign<&'a GrowingBitmap> for GrowingBitmap

fn bitor_assign(&mut self, rhs: &'a GrowingBitmap)

Performs the |= operation.

impl BitOrAssign for GrowingBitmap

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitmapSlice for &GrowingBitmap

fn get(&self, index: usize) -> bool

Returns the value of the bit at position index.

fn len(&self) -> usize

Returns the number of bits in the bitmap.

fn iter_data(&self) -> impl Iterator<Item = u64> + '_

Iterates over the internal backing data of the bitmap.

fn is_empty(&self) -> bool

Return true if the bitmap is empty.

fn count_overlapping_with(&self, other: &impl BitmapSlice) -> usize

where Self: Sized,

Counts the number of bits that are one in both this bitmap and other.

fn overlaps_with(&self, other: &impl BitmapSlice) -> bool

where Self: Sized,

Returns true if the bitmap overlaps with other. In other words, if there is any bit which is set in both bitmaps.

fn is_all_zeros(&self) -> bool

Returns true if all bits in the bitmap are set to one.

fn is_subset_of(&self, other: &impl BitmapSlice) -> bool

Returns true if, for all bits set in the bitmap, it is also set in other.

fn flipped(&self) -> Flipped<'_, Self>

where Self: Sized,

Returns a slice to a bitmap where each bit is negated.

fn anded_with<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> AndWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is ANDed with other.

fn xored_with<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> XorWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is XORed with other.

fn ored_with<'r, B: BitmapSlice>(&'r self, other: &'r B) -> OrWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is ORed with other.

fn cleared_from<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> ClearFrom<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is set to self & !other.

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

Iterates over all indices in the bitmap that are set to one.

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

Iterates over all bits in the bitmap.

fn count_ones(&self) -> usize

Counts the number of bits that are one.

fn count_zeros(&self) -> usize

Counts the number of bits that are zero.

impl BitmapSlice for &mut GrowingBitmap

fn get(&self, index: usize) -> bool

Returns the value of the bit at position index.

fn len(&self) -> usize

Returns the number of bits in the bitmap.

fn iter_data(&self) -> impl Iterator<Item = u64> + '_

Iterates over the internal backing data of the bitmap.

fn is_empty(&self) -> bool

Return true if the bitmap is empty.

fn count_overlapping_with(&self, other: &impl BitmapSlice) -> usize

where Self: Sized,

Counts the number of bits that are one in both this bitmap and other.

fn overlaps_with(&self, other: &impl BitmapSlice) -> bool

where Self: Sized,

Returns true if the bitmap overlaps with other. In other words, if there is any bit which is set in both bitmaps.

fn is_all_zeros(&self) -> bool

Returns true if all bits in the bitmap are set to one.

fn is_subset_of(&self, other: &impl BitmapSlice) -> bool

Returns true if, for all bits set in the bitmap, it is also set in other.

fn flipped(&self) -> Flipped<'_, Self>

where Self: Sized,

Returns a slice to a bitmap where each bit is negated.

fn anded_with<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> AndWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is ANDed with other.

fn xored_with<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> XorWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is XORed with other.

fn ored_with<'r, B: BitmapSlice>(&'r self, other: &'r B) -> OrWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is ORed with other.

fn cleared_from<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> ClearFrom<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is set to self & !other.

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

Iterates over all indices in the bitmap that are set to one.

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

Iterates over all bits in the bitmap.

fn count_ones(&self) -> usize

Counts the number of bits that are one.

fn count_zeros(&self) -> usize

Counts the number of bits that are zero.

impl BitmapSlice for GrowingBitmap

fn get(&self, index: usize) -> bool

Returns the value of the bit at position index.

fn len(&self) -> usize

Returns the number of bits in the bitmap.

fn iter_data(&self) -> impl Iterator<Item = u64> + '_

Iterates over the internal backing data of the bitmap.

fn is_empty(&self) -> bool

Return true if the bitmap is empty.

fn count_overlapping_with(&self, other: &impl BitmapSlice) -> usize

where Self: Sized,

Counts the number of bits that are one in both this bitmap and other.

fn overlaps_with(&self, other: &impl BitmapSlice) -> bool

where Self: Sized,

Returns true if the bitmap overlaps with other. In other words, if there is any bit which is set in both bitmaps.

fn is_all_zeros(&self) -> bool

Returns true if all bits in the bitmap are set to one.

fn is_subset_of(&self, other: &impl BitmapSlice) -> bool

Returns true if, for all bits set in the bitmap, it is also set in other.

fn flipped(&self) -> Flipped<'_, Self>

where Self: Sized,

Returns a slice to a bitmap where each bit is negated.

fn anded_with<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> AndWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is ANDed with other.

fn xored_with<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> XorWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is XORed with other.

fn ored_with<'r, B: BitmapSlice>(&'r self, other: &'r B) -> OrWith<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is ORed with other.

fn cleared_from<'r, B: BitmapSlice>( &'r self, other: &'r B, ) -> ClearFrom<'r, Self, B>

where Self: Sized,

Returns a slice to a bitmap where each bit is set to self & !other.

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

Iterates over all indices in the bitmap that are set to one.

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

Iterates over all bits in the bitmap.

fn count_ones(&self) -> usize

Counts the number of bits that are one.

fn count_zeros(&self) -> usize

Counts the number of bits that are zero.

impl BitmapSliceMut for &mut GrowingBitmap

fn modify(&mut self, f: impl FnMut(u64) -> u64)

Modifies the backing data according to f.

fn clear(&mut self)

Sets all bits in the bitmap to 0.

fn copy_from(&mut self, other: &impl BitmapSlice)

Overwrites all bits in the bitmap with bits from other.

fn clear_from(&mut self, other: &impl BitmapSlice)

ANDs each bit in the bitmap with !other.

fn or_with(&mut self, other: &impl BitmapSlice)

ORs each bit in the bitmap with other.

impl BitmapSliceMut for GrowingBitmap

fn modify(&mut self, f: impl FnMut(u64) -> u64)

Modifies the backing data according to f.

fn clear(&mut self)

Sets all bits in the bitmap to 0.

fn copy_from(&mut self, other: &impl BitmapSlice)

Overwrites all bits in the bitmap with bits from other.

fn clear_from(&mut self, other: &impl BitmapSlice)

ANDs each bit in the bitmap with !other.

fn or_with(&mut self, other: &impl BitmapSlice)

ORs each bit in the bitmap with other.

impl Clone for GrowingBitmap

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrowingBitmap

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

Formats the value using the given formatter.

impl Default for GrowingBitmap

fn default() -> GrowingBitmap

Returns the “default value” for a type.

impl FromIterator<bool> for GrowingBitmap

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

Creates a value from an iterator.

impl Hash for GrowingBitmap

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<'a> Index<&'a usize> for GrowingBitmap

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for GrowingBitmap

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl PartialEq for GrowingBitmap

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

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

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<const N: usize> TryFrom<&GrowingBitmap> for FixedBitmapU64<N>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &GrowingBitmap) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for GrowingBitmap