Struct Gridbool

pub struct Gridbool<P: PosT, const WORDS: usize>(/* private fields */);

Space-optimized grid of booleans using bitmaps

Gridbool uses an array of u32 to implement a Pos-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 Pos as a source of these values.

Implementations

impl<P: PosT, const WORDS: usize> Gridbool<P, 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, posref: &P)

Set the provided Pos position to true.

pub fn set_f(&mut self, posref: &P)

Set the provided Pos position to false.

pub fn set(&mut self, posref: &P, value: bool)

Set the provided Pos position to value.

pub fn get(&self, posref: &P) -> bool

Return the value at position Pos.

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_pos(&self) -> impl Iterator<Item = (P, bool)> + '_

where P: Copy,

Iterate over all coordinates and corresponding true/false values.

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

Iterate over all true coordinates the Gridbool.

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

Iterate over all false coordinates the Gridbool.

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

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

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

Take a Pos 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 XYMAX: u16, const WORDS: usize> Gridbool<Pos<XYMAX, XYMAX>, 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<P: Clone + PosT, const WORDS: usize> Clone for Gridbool<P, WORDS>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + PosT, const WORDS: usize> Debug for Gridbool<P, WORDS>

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

Formats the value using the given formatter.

impl<P: PosT, const WORDS: usize> Default for Gridbool<P, WORDS>

fn default() -> Self

Returns the “default value” for a type.

impl<P: PosT, const WORDS: usize> Display for Gridbool<P, WORDS>

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

Formats the value using the given formatter.

impl<P: PosT, const WORDS: usize> FromIterator<P> for Gridbool<P, WORDS>

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

where I: IntoIterator<Item = P>,

Creates a value from an iterator.

impl<P: PosT, const WORDS: usize> FromIterator<bool> for Gridbool<P, WORDS>

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

where I: IntoIterator<Item = bool>,

Creates a value from an iterator.

impl<P: Hash + PosT, const WORDS: usize> Hash for Gridbool<P, WORDS>

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<P: PosT, const WORDS: usize> Index<&P> for Gridbool<P, WORDS>

type Output = bool

The returned type after indexing.

fn index(&self, pos: &P) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P: PosT, const WORDS: usize> Index<P> for Gridbool<P, WORDS>

type Output = bool

The returned type after indexing.

fn index(&self, pos: P) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P: Ord + PosT, const WORDS: usize> Ord for Gridbool<P, WORDS>

fn cmp(&self, other: &Gridbool<P, WORDS>) -> 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,

Restrict a value to a certain interval.

impl<P: PartialEq + PosT, const WORDS: usize> PartialEq for Gridbool<P, WORDS>

fn eq(&self, other: &Gridbool<P, WORDS>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<P: PartialOrd + PosT, const WORDS: usize> PartialOrd for Gridbool<P, WORDS>

fn partial_cmp(&self, other: &Gridbool<P, WORDS>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<P: PosT, const WORDS: usize, const SIZE: usize> SetPos<P, WORDS, SIZE> for Gridbool<P, WORDS>

fn contains(&self, pos: &P) -> bool

Check if the provided super::pos::Pos is in the set

fn insert(&mut self, pos: P)

Insert the provided super::pos::Pos

fn remove(&mut self, pos: &P)

Remove the provided super::pos::Pos

fn set(&mut self, pos: P, add: bool)

Insert or remove the provided super::pos::Pos

impl<P: Copy + PosT, const WORDS: usize> Copy for Gridbool<P, WORDS>

impl<P: Eq + PosT, const WORDS: usize> Eq for Gridbool<P, WORDS>

impl<P: PosT, const WORDS: usize> StructuralPartialEq for Gridbool<P, WORDS>