Struct sqrid::Sqrid

pub struct Sqrid<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> {}

Sqrid base “factory” type

This struct holds all the generic const parameters required by the other structs. This can be aliased and used as a pseudo-module to ease the creation of the other entites and use of algorithms like BFS.

Implementations

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Sqrid<W, H, D, WORDS, SIZE>

pub const WIDTH: u16

Width of the grid: exclusive max of the x coordinate.

pub const HEIGHT: u16

Height of the grid: exclusive max of the y coordinate.

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Sqrid<W, H, D, WORDS, SIZE>

pub fn bf_iter<F>(go: F, orig: &Qa<W, H>) -> BfIterator<F, W, H, D, WORDS> where
    F: Fn(Qa<W, H>, Qr) -> Option<Qa<W, H>>, 

Create new breadth-first iterator

This is used to iterate coordinates in breadth-first order, from a given origin, using a provided function to evaluate a given Qa position + Qr direction into the next Qa position.

Example usage:

type Sqrid = sqrid::sqrid_create!(3, 3, false);
type Qa = sqrid::qa_create!(Sqrid);

for (qa, qr) in Sqrid::bf_iter(sqrid::qaqr_eval, &Qa::CENTER)
                .flatten() {
    println!("breadth-first qa {} from {}", qa, qr);
}

pub fn bfs_qrgrid<F, G>(
    go: F,
    orig: &Qa<W, H>,
    found: G
) -> Result<(Qa<W, H>, Grid<Qr, W, H, SIZE>), Error> where
    F: Fn(Qa<W, H>, Qr) -> Option<Qa<W, H>>,
    G: Fn(Qa<W, H>) -> bool, 

Perform a breadth-first search; see search_qrgrid

pub fn bfs_path<F, G>(
    go: F,
    orig: &Qa<W, H>,
    found: G
) -> Result<(Qa<W, H>, Vec<Qr>), Error> where
    F: Fn(Qa<W, H>, Qr) -> Option<Qa<W, H>>,
    G: Fn(Qa<W, H>) -> bool, 

Perform a breadth-first search; see search_path

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Sqrid<W, H, D, WORDS, SIZE>

pub fn astar_path<F>(
    go: F,
    orig: &Qa<W, H>,
    dest: &Qa<W, H>
) -> Result<Vec<Qr>, Error> where
    F: Fn(Qa<W, H>, Qr) -> Option<Qa<W, H>>, 

Perform an A* search; see search_path

Trait Implementations

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Clone for Sqrid<W, H, D, WORDS, SIZE>

fn clone(&self) -> Sqrid<W, H, D, WORDS, SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Debug for Sqrid<W, H, D, WORDS, SIZE>

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

Formats the value using the given formatter.

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Default for Sqrid<W, H, D, WORDS, SIZE>

fn default() -> Sqrid<W, H, D, WORDS, SIZE>

Returns the “default value” for a type.

impl<const W: u16, const H: u16, const D: bool, const WORDS: usize, const SIZE: usize> Copy for Sqrid<W, H, D, WORDS, SIZE>