bit_combi_iter
bit_combi_iter is a small dependency-free crate to enumerate all bit combinations less than given unsigned integer value keeping 1s in the bits.
0b00010010 println!("{:#b}", c.next().unwrap()); // => 0b00010001 println!("{:#b}", c.next().unwrap()); // => 0b00001100 println!("{:#b}", c.next().unwrap()); // => 0b00001010 println!("{:#b}", c.next().unwrap()); // => 0b00001001 println!("{:#b}", c.next().unwrap()); // => 0b00000110 println!("{:#b}", c.next().unwrap()); // => 0b00000101 println!("{:#b}", c.next().unwrap()); // => 0b00000011 println!("{}", c.next().is_none()); // => true } ">
use bit_combi_iter::BitCombinations; fn main() { let u = 0b00010100u8; let mut c = BitCombinations::new(u); println!("{:#b}", c.next().unwrap()); // => 0b00010010 println!("{:#b}", c.next().unwrap()); // => 0b00010001 println!("{:#b}", c.next().unwrap()); // => 0b00001100 println!("{:#b}", c.next().unwrap()); // => 0b00001010 println!("{:#b}", c.next().unwrap()); // => 0b00001001 println!("{:#b}", c.next().unwrap()); // => 0b00000110 println!("{:#b}", c.next().unwrap()); // => 0b00000101 println!("{:#b}", c.next().unwrap()); // => 0b00000011 println!("{}", c.next().is_none()); // => true }
This crate is useful when you want to enumerate all n bit integers including k ones.
// Enumerate all 5 bit integers including 3 ones (as u8)
BitCombinations::new(0b11100u8)
// 11100
// 11010
// 11001
// 10110
// 10101
// ...
Implementation of this crate is very efficient:
- The algorithm to generate the next bit combination consists of only a few arithmetic calculations, bit operations and shift operations.
- Size of
BitCombinationsis the same as size ofU. For example, size ofBitCombinationsis 8 bytes.
Install
Add this crate to dependencies in your Cargo.toml.
[dependencies]
bit_combi_iter = "1"
Document
See the API document.
Special Thanks
The algorithm was borrowed from the blog post by @herumi.
Bug reporting
Visit the repository page and open a new issue.
License
Distributed under the MIT License.
82 Dec 31, 2022
21 Oct 29, 2022
0 Dec 22, 2021
5 May 27, 2022
5 May 6, 2021
52 Nov 26, 2022
4 Aug 13, 2022
6 Feb 29, 2024
13 Jan 31, 2022
11 Dec 18, 2021
9 Jul 22, 2022
33 Dec 29, 2022
29 Dec 27, 2022
70 Dec 13, 2022
2 Oct 4, 2021
7 Jun 25, 2022
16 Sep 29, 2022
11 Dec 22, 2022
89 Dec 29, 2022