Struct bitmatrix::BitMatrix

pub struct BitMatrix { /* fields omitted */ }

A matrix of bits.

Access can be done through the Index<usize>, Index<(usize, usize)> and IndexMut<usize> traits. As the IndexMut trait is incompatible with proxies, a set method is also provided.

If the serde_support feature is enabled, this type implements serde's Serialize and Deserialize traits.

Implementations

impl BitMatrix

pub fn new(height: usize, width: usize) -> Self

Create a BitMatrix with the given size. All bits are initialized to false.

let matrix = BitMatrix::new(5, 10);

pub fn height(&self) -> usize

Get the matrix height.

pub fn width(&self) -> usize

Get the matrix width.

pub fn iter(&self) -> Iter<'_, Lsb0, usize>

Iterate over all bits in the matrix.

let mut matrix = BitMatrix::new(2, 2);
matrix.set((0,1), true);
matrix.set((1,0), true);
let mut iter = matrix.iter();
assert_eq!(iter.next(), Some(&false));
assert_eq!(iter.next(), Some(&true));
assert_eq!(iter.next(), Some(&true));
assert_eq!(iter.next(), Some(&false));
assert_eq!(iter.next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, Lsb0, usize>

Iterate over all bits in the matrix.

let mut matrix = BitMatrix::new(2, 2);
let mut iter = matrix.iter_mut();
if let Some(bit) = iter.next() {
	bit.set(true);
}
assert_eq!(matrix[(0,0)], true);

pub fn rows(&self) -> ChunksExact<'_, Lsb0, usize>

An iterator to the matrix rows. Returns an iterator over BitSlices.

pub fn rows_mut(&mut self) -> ChunksExactMut<'_, Lsb0, usize>

A mutable iterator to the matrix rows. Returns a mutable iterator over BitSlices.

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

Set a given bit in the matrix. This method is necessary because IndexMut is incompatible with proxies.

let mut matrix = BitMatrix::new(3, 11);
matrix.set((1,2), true);
assert_eq!(matrix[(1,2)], true);

Panics

Panics if i or j are out of bounds.

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

Set all bits in the matrix.

use std::convert::identity;
let mut matrix = BitMatrix::new(3, 11);
matrix.set_all(true);
assert!(matrix.iter().copied().all(identity));

Trait Implementations

impl Clone for BitMatrix

fn clone(&self) -> BitMatrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitMatrix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BitMatrix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for BitMatrix

impl Hash for BitMatrix

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Index<(usize, usize)> for BitMatrix

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for BitMatrix

type Output = BitSlice

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for BitMatrix

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

Performs the mutable indexing (container[index]) operation.

impl PartialEq<BitMatrix> for BitMatrix

fn eq(&self, other: &BitMatrix) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BitMatrix) -> bool

This method tests for !=.

impl Serialize for BitMatrix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for BitMatrix

impl StructuralPartialEq for BitMatrix