bit-matrix 0.10.0

Library for bit matrices and vectors.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

<div align="center">
  <h1>bit-matrix</h1>
  <p>
    <strong>A compact matrix of bits.</strong>
  </p>
  <p>

[![crates.io][crates.io shield]][crates.io link]
[![Documentation][docs.rs badge]][docs.rs link]
![Rust CI][github ci badge]
![MSRV][rustc 1.85+]
<br />
<br />
[![Dependency Status][deps.rs status]][deps.rs link]
[![Download Status][shields.io download count]][crates.io link]

  </p>
</div>

[crates.io shield]: https://img.shields.io/crates/v/bit-matrix?label=latest
[crates.io link]: https://crates.io/crates/bit-matrix
[docs.rs badge]: https://docs.rs/bit-matrix/badge.svg?version=0.10.0
[docs.rs link]: https://docs.rs/bit-matrix/0.10.0/bit-matrix/
[github ci badge]: https://github.com/pczarn/bit-matrix/workflows/CI/badge.svg?branch=master
[rustc 1.85+]: https://img.shields.io/badge/rustc-1.85%2B-blue.svg
[deps.rs status]: https://deps.rs/crate/bit-matrix/0.10.0/status.svg
[deps.rs link]: https://deps.rs/crate/bit-matrix/0.10.0
[shields.io download count]: https://img.shields.io/crates/d/bit-matrix.svg

Rust library that implements bit matrices.
[You can check the documentation here](https://docs.rs/bit-matrix/latest/bit_matrix/).

Built on top of [contain-rs/bit-vec](https://github.com/contain-rs/bit-vec/).

<!-- cargo-rdme start -->

Implements bit matrices.

# Examples

Gets a mutable reference to the square bit matrix within this
rectangular matrix, then performs a transitive closure.

```rust
use bit_matrix::BitMatrix;

let mut matrix = <BitMatrix>::new(7, 5);
matrix.set(1, 2, true);
matrix.set(2, 3, true);
matrix.set(3, 4, true);

{
    let mut sub_matrix = matrix.sub_matrix_mut(1 .. 6);
    sub_matrix.transitive_closure();
}
assert!(matrix[(1, 4)]);

matrix.reflexive_closure();
assert!(matrix[(0, 0)]);
assert!(matrix[(1, 1)]);
assert!(matrix[(2, 2)]);
assert!(matrix[(3, 3)]);
```

This simple example calculates the transitive closure of 4x4 bit matrix.

```rust
use bit_matrix::BitMatrix;

let mut matrix = <BitMatrix>::new(4, 4);
let points = &[
    (0, 0),
    (0, 1),
    (0, 3),
    (1, 0),
    (1, 2),
    (2, 0),
    (2, 1),
    (3, 1),
    (3, 3),
];
for &(i, j) in points {
    matrix.set(i, j, true);
}
matrix.transitive_closure();

let mut expected_matrix = BitMatrix::new(4, 4);
for i in 0..4 {
    for j in 0..4 {
        expected_matrix.set(i, j, true);
    }
}

assert_eq!(matrix, expected_matrix);
```

<!-- cargo-rdme end -->

## License

Dual-licensed for compatibility with the Rust project.

Licensed under the Apache License Version 2.0:
http://www.apache.org/licenses/LICENSE-2.0, or the MIT license:
http://opensource.org/licenses/MIT, at your option.