bit-array-rs 0.0.3

Bit Array
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# BitArray - A Simple Bit Array Implementation in Rust

`bit-array-rs` is a Rust library that provides a simple and efficient implementation of a bit array. A bit array (or bit vector) is a data structure that compactly stores bits (0s and 1s).

## Installation

Add the following to your `Cargo.toml`:

```toml
[dependencies]
bit-array-rs = "0.0.3"
```

## Usage

### Creating a BitArray

```rust
use bit_array_rs::BitArray;

fn main() {
    let mut bit_array = BitArray::new(16);
    bit_array.set(3);
    bit_array.set(7);
    println!("{:?}", bit_array);  // Outputs: "00001000 10000000"
    println!("{}", bit_array);    // Outputs: "0000100010000000"
}
```

### Setting and Unsetting Bits

```rust
use bit_array_rs::BitArray;

fn main() {
    let mut bit_array = BitArray::new(8);

    bit_array.set(2);
    bit_array.unset(2);

    assert_eq!(bit_array[2], false);
    bit_array.set_bit(2, true);
    assert_eq!(bit_array[2], true);
}
```

### Finding the First Set/Unset Bit

```rust
use bit_array_rs::BitArray;

fn main() {
    let mut bit_array = BitArray::new(16);

    bit_array.set(3);
    bit_array.set(5);

    assert_eq!(bit_array.first_unset_bit(), Some(0));
    assert_eq!(bit_array.first_set_bit(), Some(3));
}
```

### Debug and Display

```rust
use bit_array_rs::BitArray;

fn main() {
    let mut bit_array = BitArray::new(16);
    bit_array.set(3);
    bit_array.set(7);
    bit_array.set(9);
    bit_array.set(15);

    println!("{:?}", bit_array);  // Outputs: "00010001 01000001"
    println!("{}", bit_array);    // Outputs: "0001000101000001"
}
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.