Straightforward, no-std compatible, simd optimized, BitSet API.
This crate provides its functionality through the BitSet trait.
rust
use bitset_core::BitSet;
The containers for the bitset provided by this crate are unsigned integers, slices of unsigned integers and simd-like types, and Vec<_>, Box<[_]> if the std feature is enabled (enabled by default).
```rust use bitset_core::BitSet;
let mut bits = [0u32; 4]; asserteq!(bits.bitlen(), 4 * 32);
bits.bitinit(true); // Set all bits to true assert!(bits.bitall()); // All bits are set
bits.bitreset(13); // Reset the 13th bit assert!(bits.bitany()); // At least some bits are set
bits.bitflip(42); // Flip the 42nd bit twice (no change) bits.bitflip(42);
bits.bit_cond(1, false); // Set the bit to runtime value
asserteq!(bits.bittest(42), true); asserteq!(bits.bittest(13), false); asserteq!(bits.bittest(1), false);
asserteq!(bits.bitcount(), 4 * 32 - 2); ```
Simd optimization is provided by using underlying primitives such as [u32; 4] which match the hardware's 128-bit simd registers. The compiler is heavily encouraged to vectorize these primitives.
```rust use bitset_core::BitSet;
let mut a = [[0x21212121u32; 4]; 16]; let b = [[0x55555555u32; 4]; 16];
a.bitor(&b); a.bitand(&b); a.bitxor(&b); a.bitnot();
assert_eq!(a, [[0xffffffffu32; 4]; 16]); ```
For non fixed-size containers using the std feature BitSet is also implemented for Vec<T> and Box<[T]> (where [T]: BitSet).
Future work includes making everything const fn to enable all of this at compiletime, blocked on support for traits in const fn.
Licensed under MIT License, see license.txt.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.