Struct datazoo::bitmatrix::BitMatrix

pub struct BitMatrix(/* private fields */);

A bitset with fixed-size rows.

Note that only the total size is tracked in BitMatrix and you must provide the width value when calling methods on BitMatrix.

Implementations

impl BitMatrix

pub fn height(&self, width: usize) -> usize

The height this matrix would have if it had given width.

Note that this might be greater than the height given to Self::new_with_size due to BitMatrix discarding information about actual size.

Panics

If Self is not empty and width equals 0 (division by zero)

pub fn active_rows_in_column(&self, width: usize, x: usize) -> Column<'_>

Iterate over active bits in given column.

Panics

When width = 0 (this would otherwise mean there is an infinite amount of columns)

pub fn row(&self, width: usize, y: usize) -> impl Iterator<Item = usize> + '_

Iterate over the enabled bits of a single row at y of this Bitmatrix.

Assuming the Bitmatrix has the provided width.

pub fn enable_bit(&mut self, width: usize, x: usize, y: usize) -> Option<()>

Enables bit at position bit.

Returns None and does nothing if bit is out of range.

When [Bitset::bit(bit)] will be called next, it will be true if this returned Some.

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

Create a BitMatrix with given proportions.

Note that the total size is the lowest multiple of 32 higher or equal to width * height.

pub fn bit(&self, width: usize, x: usize, y: usize) -> bool

true if bit at position x, y in matrix is enabled.

false otherwise, included if x, y is outside of the matrix.

pub const fn sextant_display( &self, width: usize, height: usize ) -> SextantDisplay<'_>

Return a struct that, when printed with fmt::Display or fmt::Debug, displays the matrix using unicode sextant characters(pdf).

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.