Struct bit_matrix::matrix::BitMatrix

pub struct BitMatrix { /* private fields */ }

A matrix of bits.

Implementations

impl BitMatrix

pub fn new(rows: usize, row_bits: usize) -> Self

Create a new BitMatrix with specific numbers of bits in columns and rows.

pub fn size(&self) -> (usize, usize)

Returns the matrix’s size as (rows, columns).

pub fn set(&mut self, row: usize, col: usize, enabled: bool)

Sets the value of a bit.

Panics

Panics if (row, col) is out of bounds.

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

Sets the value of all bits.

pub fn grow(&mut self, num_rows: usize, value: bool)

Grows the matrix in-place, adding num_rows rows filled with value.

pub fn truncate(&mut self, num_rows: usize)

Truncates the matrix.

pub fn sub_matrix(&self, range: Range<usize>) -> BitSubMatrix<'_>

Returns a slice of the matrix’s rows.

pub fn split_at(&self, row: usize) -> (BitSubMatrix<'_>, BitSubMatrix<'_>)

Given a row’s index, returns a slice of all rows above that row, a reference to said row, and a slice of all rows below.

Functionally equivalent to (self.sub_matrix(0..row), &self[row], self.sub_matrix(row..self.num_rows())).

pub fn split_at_mut( &mut self, row: usize ) -> (BitSubMatrixMut<'_>, BitSubMatrixMut<'_>)

Given a row’s index, returns a slice of all rows above that row, a reference to said row, and a slice of all rows below.

pub fn iter_row(&self, row: usize) -> Iter<'_>

Iterate over bits in the specified row.

pub fn transitive_closure(&mut self)

Computes the transitive closure of the binary relation represented by the matrix.

Uses the Warshall’s algorithm.

pub fn reflexive_closure(&mut self)

Computes the reflexive closure of the binary relation represented by the matrix.

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 Default for BitMatrix

fn default() -> BitMatrix

Returns the “default value” for a type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<(usize, usize)> for BitMatrix

Returns true if a bit is enabled in the matrix, or false otherwise.

type Output = bool

The returned type after indexing.

fn index(&self, (row, col): (usize, usize)) -> &bool

Performs the indexing (container[index]) operation.

impl Index<usize> for BitMatrix

Returns the matrix’s row in the form of an immutable slice.

type Output = BitSlice

The returned type after indexing.

fn index(&self, row: usize) -> &BitSlice

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for BitMatrix

Returns the matrix’s row in the form of a mutable slice.

fn index_mut(&mut self, row: usize) -> &mut BitSlice

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

impl Ord for BitMatrix

fn cmp(&self, other: &BitMatrix) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BitMatrix

fn partial_cmp(&self, other: &BitMatrix) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for BitMatrix

impl StructuralPartialEq for BitMatrix