Struct sqrid::base::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 = W

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

pub const HEIGHT: u16 = H

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 camefrom_into_path<MapPosDir>( map: MapPosDir, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where MapPosDir: MapPos<Option<Dir>, W, H, WORDS, SIZE>,

TODO

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: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Perform an A* search; see astar

pub fn astar_path_grid<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Perform an A* search using a Grid internally; see astar

pub fn astar_path_hash<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Perform an A* search using a HashMap internally; see astar

pub fn astar_path_btree<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Perform an A* search using a BTreeMap internally; see astar

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<GoFn>( go: GoFn, orig: &Pos<W, H> ) -> BfIterator<GoFn, Gridbool<W, H, WORDS>, W, H, D, WORDS, SIZE>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Create new breadth-first iterator; see bf

pub fn bf_iter_grid<GoFn>( go: GoFn, orig: &Pos<W, H> ) -> BfIterator<GoFn, Gridbool<W, H, WORDS>, W, H, D, WORDS, SIZE>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Create new breadth-first iterator using Grid/Gridbool internally; see bf

pub fn bf_iter_hash<GoFn>( go: GoFn, orig: &Pos<W, H> ) -> BfIterator<GoFn, HashSet<Pos<W, H>>, W, H, D, WORDS, SIZE>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Create new breadth-first iterator using the HashMap]/HashSet] types internally; see bf

pub fn bf_iter_btree<GoFn>( go: GoFn, orig: &Pos<W, H> ) -> BfIterator<GoFn, BTreeSet<Pos<W, H>>, W, H, D, WORDS, SIZE>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>,

Create new breadth-first iterator using the BTreeMap/BTreeSet types internally; see bf

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

pub fn bfs_path<GoFn, FoundFn>( go: GoFn, orig: &Pos<W, H>, found: FoundFn ) -> Result<(Pos<W, H>, Vec<Dir>), Error>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>, FoundFn: Fn(Pos<W, H>) -> bool,

Perform a breadth-first search; see bf

pub fn bfs_path_grid<GoFn, FoundFn>( go: GoFn, orig: &Pos<W, H>, found: FoundFn ) -> Result<(Pos<W, H>, Vec<Dir>), Error>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>, FoundFn: Fn(Pos<W, H>) -> bool,

Perform a breadth-first search using a Grid internally; see bf

pub fn bfs_path_hash<GoFn, FoundFn>( go: GoFn, orig: &Pos<W, H>, found: FoundFn ) -> Result<(Pos<W, H>, Vec<Dir>), Error>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>, FoundFn: Fn(Pos<W, H>) -> bool,

Perform a breadth-first search using the HashMap/HashSet types internally; see bf

pub fn bfs_path_btree<GoFn, FoundFn>( go: GoFn, orig: &Pos<W, H>, found: FoundFn ) -> Result<(Pos<W, H>, Vec<Dir>), Error>

where GoFn: Fn(Pos<W, H>, Dir) -> Option<Pos<W, H>>, FoundFn: Fn(Pos<W, H>) -> bool,

Perform a breadth-first search using the HashMap/HashSet types internally; see bf

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

pub fn ucs_path<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<(Pos<W, H>, Cost)>,

Perform a uniform-cost search; see ucs.

pub fn ucs_path_grid<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<(Pos<W, H>, Cost)>,

Perform a uniform-cost search using a Grid internally; see ucs.

pub fn ucs_path_hash<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<(Pos<W, H>, Cost)>,

Perform a uniform-cost search using a HashMap internally; see ucs.

pub fn ucs_path_btree<F>( go: F, orig: &Pos<W, H>, dest: &Pos<W, H> ) -> Result<Vec<Dir>, Error>

where F: Fn(Pos<W, H>, Dir) -> Option<(Pos<W, H>, Cost)>,

Perform a uniform-cost search using a BTreeMap internally; see ucs.

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>