Trait BitBoard 

pub trait BitBoard: Sized {
    // Required methods
    fn n_rows(&self) -> usize;
    fn n_cols(&self) -> usize;
    fn board_mut(&mut self) -> &mut BitSlice ;
    fn board(&self) -> &BitSlice ;
    fn or(&self, other: &impl BitBoard) -> Result<Self, DimensionMismatch>;
    fn and(&self, other: &impl BitBoard) -> Result<Self, DimensionMismatch>;

    // Provided methods
    fn index_of(&self, row: usize, col: usize) -> usize { ... }
    fn row_col_of(&self, index: usize) -> (usize, usize) { ... }
    fn fill(&mut self, value: bool) { ... }
    fn set(&mut self, row: usize, col: usize, value: bool) { ... }
    fn get(&self, row: usize, col: usize) -> bool { ... }
    fn set_col(&mut self, col: usize, value: bool) { ... }
    fn get_col(&self, col: usize) -> impl Iterator<Item = bool> { ... }
    fn set_row(&mut self, row: usize, value: bool) { ... }
    fn get_row(&self, row: usize) -> impl Iterator<Item = bool> { ... }
    fn set_cardinal_neighbors(&mut self, row: usize, col: usize, value: bool) { ... }
    fn set_diagonals(&mut self, row: usize, col: usize, value: bool) { ... }
    fn set_all_neighbors(&mut self, row: usize, col: usize, value: bool) { ... }
}

Required Methods

fn n_rows(&self) -> usize

Returns the number of rows in the board.

fn n_cols(&self) -> usize

Returns the number of columns in the board.

fn board_mut(&mut self) -> &mut BitSlice

Returns a mutable reference to the underlying bits.

fn board(&self) -> &BitSlice

Returns an immutable reference to the underlying bits.

fn or(&self, other: &impl BitBoard) -> Result<Self, DimensionMismatch>

fn and(&self, other: &impl BitBoard) -> Result<Self, DimensionMismatch>

Provided Methods

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

Get the index that we can use to directly access a certain spot on the board

fn row_col_of(&self, index: usize) -> (usize, usize)

Get the row and column of the linear index

fn fill(&mut self, value: bool)

Set all bits to the desired value.

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

Set the value at index [row, col] to be the new_val.

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

Get the value at index [row, col]. If the index is out of bounds, return false.

fn set_col(&mut self, col: usize, value: bool)

Set an entire column to a certain value

fn get_col(&self, col: usize) -> impl Iterator<Item = bool>

Get the values in a given col

fn set_row(&mut self, row: usize, value: bool)

Set an entire row to a certain value

fn get_row(&self, row: usize) -> impl Iterator<Item = bool>

Get the values in a given row

fn set_cardinal_neighbors(&mut self, row: usize, col: usize, value: bool)

Will set the neighbors immediately above, below, left, and right to value. If the neighbor is out of bounds, nothing will happen

fn set_diagonals(&mut self, row: usize, col: usize, value: bool)

Set just the spots diagonal from the given position to value. If the neighbor is out of bounds, nothing will happen

fn set_all_neighbors(&mut self, row: usize, col: usize, value: bool)

Set the cardinal neighbors and the diagonal neighbors to value. If the neighbor is out of bounds, nothing will happen

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl BitBoard for BitBoardDyn

impl<const W: usize> BitBoard for BitBoardStatic<W>