Struct k2_tree::matrix::BitMatrix

pub struct BitMatrix {
    pub width: usize,
    pub height: usize,
    // some fields omitted
}

A 2-d bit-matrix.

Fields

width: usize

Width of the matrix.

height: usize

Height of the matrix.

Implementations

impl BitMatrix

pub fn new() -> Self

Creates an empty BitMatrix with zero width or height.

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

Creates an empty BitMatrix with predefined dimensions.

pub fn from_bits(
    width: usize,
    height: usize,
    data: impl IntoIterator<Item = bool>
) -> Self

Builds a BitMatrix instance from another collection of bits.

If the data passed in contains more bits than will fit a matrix of the specified height and width, excess data is discarded. If not enough bits are passed in, 0s will be appended until the right size is reached.

pub fn get(&self, x: usize, y: usize) -> Result<bool, BitMatrixError>

Returns the state of a bit at a specific coordinate.

pub fn get_column(&self, x: usize) -> Result<Vec<bool>, BitMatrixError>

Returns the state of all the bits at a specific x-coordinate.

Bits are ordered by row, starting at y-coordinate 0.

pub fn get_row(&self, y: usize) -> Result<Vec<bool>, BitMatrixError>

Returns the state of all the bits at a specific y-coordinate.

Bits are ordered by column, starting at x-coordinate 0.

pub fn set(
    &mut self,
    x: usize,
    y: usize,
    state: bool
) -> Result<(), BitMatrixError>

Changes the state of a bit at a specififc coordinate.

pub fn resize_width(&mut self, len: usize)

Changes the width of the matrix.

If len is greater than matrix's width, each row is extended with 0s. Otherwise, each row is concatenated.

pub fn resize_height(&mut self, len: usize)

Changes the hieght of the matrix.

If len is greater than matrix's height, it is extended with blank rows. Otherwise, the number of rows is suitably concatenated.

pub fn to_bits(&self) -> Vec<bool>

Produces the contents of the matrix as a flat vec of bits.

Vec contains each row one after another.

pub fn into_bits(self) -> Vec<bool>

Consumes the BitMatrix to produce its contents as a flat vec of bits.

Vec contains each row one after another.

pub fn to_columns(&self) -> Vec<Vec<bool>>

Produces the contents of the matrix as a vec of its columns.

pub fn into_columns(self) -> Vec<Vec<bool>>

Consumes the BitMatrix to produce its contents as a vec of its columns.

pub fn to_rows(&self) -> Vec<Vec<bool>>

Produces the contents of the matrix as a vec of its rows.

pub fn into_rows(self) -> Vec<Vec<bool>>

Consumes the BitMatrix to produce its contents as a vec of its rows.

pub fn shrink_to_fit(&mut self)

Reduces the width and height such that there are no empty columns or rows on the edges.

Trait Implementations

impl Clone for BitMatrix

pub fn clone(&self) -> BitMatrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitMatrix

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

Formats the value using the given formatter.

impl Default for BitMatrix

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for BitMatrix

impl Hash for BitMatrix

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<BitMatrix> for BitMatrix

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

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

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

This method tests for !=.

impl StructuralEq for BitMatrix

impl StructuralPartialEq for BitMatrix