Struct sqrid::Gridbool

pub struct Gridbool<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize>(/* private fields */);

Space-optimized grid of booleans using bitmaps

Gridbool uses an array of u32 to implement a Qa-indexable grid of booleans, balancing space and performance.

At the moment we need to provide the number of u32 WORDS to use due to rust generic const limitations. We are able to check that the value is appropriate, though.

We can use the gridbool_create macro to use a Qa as a source of these values.

Implementations

impl<const W: u16, const H: u16, const WORDS: usize> Gridbool<W, H, WORDS>

pub const ALL_TRUE: Self = _

Const Gridbool filled with true values.

pub const ALL_FALSE: Self = _

Const Gridbool filled with false values.

pub const fn repeat(value: bool) -> Self

Create a Gridbool filled with the provided value.

pub fn set_t(&mut self, qaref: impl Borrow<Qa<W, H>>)

Set the provided Qa position to true.

pub fn set_f(&mut self, qaref: impl Borrow<Qa<W, H>>)

Set the provided Qa position to false.

pub fn set(&mut self, qaref: impl Borrow<Qa<W, H>>, value: bool)

Set the provided Qa position to value.

pub fn get(&self, qaref: impl Borrow<Qa<W, H>>) -> bool

Return the value at position Qa.

pub fn into_inner(self) -> [u32; WORDS]

Consume self and returns the inner bitmap.

pub fn as_inner(&self) -> &[u32; WORDS]

Return a reference to the inner bitmap; useful for testing.

pub fn as_inner_mut(&mut self) -> &mut [u32; WORDS]

Return a mut reference to the inner bitmap; useful for testing.

pub fn iter(&self) -> impl Iterator<Item = bool> + '_

Iterate over all true/false values in the Gridbool.

pub fn iter_qa(&self) -> impl Iterator<Item = (Qa<W, H>, bool)> + '_

Iterate over all coordinates and corresponding true/false values.

pub fn iter_t(&self) -> impl Iterator<Item = Qa<W, H>> + '_

Iterate over all true coordinates the Gridbool.

pub fn iter_f(&self) -> impl Iterator<Item = Qa<W, H>> + '_

Iterate over all false coordinates the Gridbool.

pub fn set_iter_t<AQA>(&mut self, qaiter: impl Iterator<Item = AQA>)

where AQA: Borrow<Qa<W, H>>,

Take a Qa iterator and set all corresponding values to true.

pub fn set_iter_f<AQA>(&mut self, qaiter: impl Iterator<Item = AQA>)

where AQA: Borrow<Qa<W, H>>,

Take a Qa iterator and set all corresponding values to false.

pub fn flip_h(&mut self)

Flip all elements horizontally.

pub fn flip_v(&mut self)

Flip all elements vertically.

impl<const W: u16, const WORDS: usize> Gridbool<W, W, WORDS>

pub fn rotate_cw(&mut self)

Rotate all elements 90 degrees clockwise

pub fn rotate_cc(&mut self)

Rotate all elements 90 degrees counterclockwise

Trait Implementations

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> Clone for Gridbool<WIDTH, HEIGHT, WORDS>

fn clone(&self) -> Gridbool<WIDTH, HEIGHT, WORDS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> Debug for Gridbool<WIDTH, HEIGHT, WORDS>

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

Formats the value using the given formatter.

impl<const W: u16, const H: u16, const WORDS: usize> Default for Gridbool<W, H, WORDS>

fn default() -> Self

Returns the “default value” for a type.

impl<const W: u16, const H: u16, const WORDS: usize> Display for Gridbool<W, H, WORDS>

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

Formats the value using the given formatter.

impl<AQA, const W: u16, const H: u16, const WORDS: usize> FromIterator<AQA> for Gridbool<W, H, WORDS>

where AQA: Borrow<Qa<W, H>>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = AQA>,

Creates a value from an iterator.

impl<const W: u16, const H: u16, const WORDS: usize> FromIterator<bool> for Gridbool<W, H, WORDS>

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = bool>,

Creates a value from an iterator.

impl<AQA, const W: u16, const H: u16, const WORDS: usize> Index<AQA> for Gridbool<W, H, WORDS>

where AQA: Borrow<Qa<W, H>>,

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> PartialEq for Gridbool<WIDTH, HEIGHT, WORDS>

fn eq(&self, other: &Gridbool<WIDTH, HEIGHT, WORDS>) -> 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<const W: u16, const H: u16, const WORDS: usize, const SIZE: usize> SetQa<W, H, WORDS, SIZE> for Gridbool<W, H, WORDS>

fn contains(&self, qa: &Qa<W, H>) -> bool

Check if the provided Qa is in the set

fn insert(&mut self, qa: &Qa<W, H>)

Insert the provided Qa

fn remove(&mut self, qa: &Qa<W, H>)

Remove the provided Qa

fn set(&mut self, qa: &Qa<W, H>, add: bool)

Insert or remove the provided Qa

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> Copy for Gridbool<WIDTH, HEIGHT, WORDS>

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> Eq for Gridbool<WIDTH, HEIGHT, WORDS>

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> StructuralEq for Gridbool<WIDTH, HEIGHT, WORDS>

impl<const WIDTH: u16, const HEIGHT: u16, const WORDS: usize> StructuralPartialEq for Gridbool<WIDTH, HEIGHT, WORDS>