Struct BitMap 

pub struct BitMap { /* private fields */ }

A memory-efficient bitmap implementation

Provides efficient bit manipulation operations for use in bloom filters and other data structures that require bit-level operations.

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(42, true);
assert!(bitmap.get(42));
assert_eq!(bitmap.count_ones(), 1);

Implementations

impl BitMap

pub fn new(size: usize) -> Self

Create a new bitmap with the specified number of bits

Arguments

• size - Number of bits in the bitmap

Examples

use yimi_rutool::algorithms::BitMap;

let bitmap = BitMap::new(1000);
assert_eq!(bitmap.len(), 1000);

pub fn filled(size: usize) -> Self

Create a bitmap filled with ones

Arguments

• size - Number of bits in the bitmap

Examples

use yimi_rutool::algorithms::BitMap;

let bitmap = BitMap::filled(8);
assert_eq!(bitmap.count_ones(), 8);

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

Get the value of a bit at the specified index

Arguments

• index - Bit index (0-based)

Panics

Panics if index is out of bounds

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(42, true);
assert!(bitmap.get(42));
assert!(!bitmap.get(43));

pub fn set(&mut self, index: usize, value: bool)

Set the value of a bit at the specified index

Arguments

• index - Bit index (0-based)
• value - Value to set (true for 1, false for 0)

Panics

Panics if index is out of bounds

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(42, true);
assert!(bitmap.get(42));

bitmap.set(42, false);
assert!(!bitmap.get(42));

pub fn toggle(&mut self, index: usize)

Toggle the bit at the specified index

Arguments

• index - Bit index (0-based)

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.toggle(42);
assert!(bitmap.get(42));
bitmap.toggle(42);
assert!(!bitmap.get(42));

pub fn fill(&mut self, value: bool)

Fill all bits with the specified value

Arguments

• value - Value to set all bits to

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.fill(true);
assert_eq!(bitmap.count_ones(), 100);

bitmap.fill(false);
assert_eq!(bitmap.count_ones(), 0);

pub fn clear(&mut self)

Clear all bits (set to 0)

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::filled(100);
bitmap.clear();
assert_eq!(bitmap.count_ones(), 0);

pub fn count_ones(&self) -> usize

Count the number of bits set to 1

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(10, true);
bitmap.set(20, true);
bitmap.set(30, true);
assert_eq!(bitmap.count_ones(), 3);

pub fn count_zeros(&self) -> usize

Count the number of bits set to 0

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(10, true);
assert_eq!(bitmap.count_zeros(), 99);

pub fn len(&self) -> usize

Get the number of bits in the bitmap

Examples

use yimi_rutool::algorithms::BitMap;

let bitmap = BitMap::new(1000);
assert_eq!(bitmap.len(), 1000);

pub fn is_empty(&self) -> bool

Check if the bitmap is empty (size 0)

Examples

use yimi_rutool::algorithms::BitMap;

let empty_bitmap = BitMap::new(0);
assert!(empty_bitmap.is_empty());

let bitmap = BitMap::new(100);
assert!(!bitmap.is_empty());

pub fn all_zeros(&self) -> bool

Check if all bits are set to 0

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
assert!(bitmap.all_zeros());

bitmap.set(50, true);
assert!(!bitmap.all_zeros());

pub fn all_ones(&self) -> bool

Check if all bits are set to 1

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
assert!(!bitmap.all_ones());

bitmap.fill(true);
assert!(bitmap.all_ones());

pub fn and(&mut self, other: &BitMap)

Perform bitwise AND operation with another bitmap

Arguments

• other - The other bitmap to AND with

Panics

Panics if the bitmaps have different sizes

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap1 = BitMap::new(100);
let mut bitmap2 = BitMap::new(100);

bitmap1.set(10, true);
bitmap1.set(20, true);
bitmap2.set(10, true);
bitmap2.set(30, true);

bitmap1.and(&bitmap2);
assert!(bitmap1.get(10));  // Both had this bit set
assert!(!bitmap1.get(20)); // Only bitmap1 had this bit set
assert!(!bitmap1.get(30)); // Only bitmap2 had this bit set

pub fn or(&mut self, other: &BitMap)

Perform bitwise OR operation with another bitmap

Arguments

• other - The other bitmap to OR with

Panics

Panics if the bitmaps have different sizes

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap1 = BitMap::new(100);
let mut bitmap2 = BitMap::new(100);

bitmap1.set(10, true);
bitmap2.set(20, true);

bitmap1.or(&bitmap2);
assert!(bitmap1.get(10)); // From bitmap1
assert!(bitmap1.get(20)); // From bitmap2

pub fn xor(&mut self, other: &BitMap)

Perform bitwise XOR operation with another bitmap

Arguments

• other - The other bitmap to XOR with

Panics

Panics if the bitmaps have different sizes

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap1 = BitMap::new(100);
let mut bitmap2 = BitMap::new(100);

bitmap1.set(10, true);
bitmap1.set(20, true);
bitmap2.set(10, true);
bitmap2.set(30, true);

bitmap1.xor(&bitmap2);
assert!(!bitmap1.get(10)); // Both had this bit set
assert!(bitmap1.get(20));  // Only bitmap1 had this bit set
assert!(bitmap1.get(30));  // Only bitmap2 had this bit set

pub fn not(&mut self)

Perform bitwise NOT operation (invert all bits)

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(10, true);

bitmap.not();
assert!(!bitmap.get(10));
assert_eq!(bitmap.count_ones(), 99);

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

Get an iterator over all set bit indices

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(10, true);
bitmap.set(20, true);
bitmap.set(30, true);

let set_bits: Vec<usize> = bitmap.iter_ones().collect();
assert_eq!(set_bits, vec![10, 20, 30]);

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

Get an iterator over all unset bit indices

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(5);
bitmap.set(1, true);
bitmap.set(3, true);

let unset_bits: Vec<usize> = bitmap.iter_zeros().collect();
assert_eq!(unset_bits, vec![0, 2, 4]);

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

Resize the bitmap to a new size

If the new size is larger, new bits are set to false. If the new size is smaller, excess bits are discarded.

Arguments

• new_size - New size in bits

Examples

use yimi_rutool::algorithms::BitMap;

let mut bitmap = BitMap::new(100);
bitmap.set(50, true);

bitmap.resize(200);
assert_eq!(bitmap.len(), 200);
assert!(bitmap.get(50)); // Existing data preserved

bitmap.resize(25);
assert_eq!(bitmap.len(), 25);
// bit 50 is now out of bounds

Trait Implementations

impl Clone for BitMap

fn clone(&self) -> BitMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitMap

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

Formats the value using the given formatter.

impl Index<usize> for BitMap

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl PartialEq for BitMap

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 Eq for BitMap