Struct IndexedGraphMap 

pub struct IndexedGraphMap<N, C> { /* private fields */ }

Helper that maps external node values to dense indices and builds an indexed graph.

Implementations

impl<N, C> IndexedGraphMap<N, C>

where N: Eq + Hash + Clone,

pub fn from_nodes_and_successors<I, FN, IN>(nodes: I, successors: FN) -> Self

where I: IntoIterator<Item = N>, FN: FnMut(&N) -> IN, IN: IntoIterator<Item = (N, C)>,

Build a mapped graph from seed nodes and a successor function.

pub const fn graph(&self) -> &IndexedGraph<C>

Return the indexed graph.

pub fn into_graph(self) -> IndexedGraph<C>

Return the indexed graph, consuming the mapping helper.

pub const fn node_count(&self) -> usize

Return the number of nodes in the mapped graph.

pub fn index_of(&self, node: &N) -> Option<usize>

Return the index assigned to node.

pub fn node(&self, index: usize) -> Option<&N>

Return the external node value for a given index.

pub fn nodes(&self) -> &[N]

Return the mapped node values in index order.

impl IndexedGraphMap<(usize, usize), usize>

pub fn from_walkable_matrix_4( matrix: &[Vec<bool>], ) -> Result<Self, IndexedInputError>

Build a mapped graph from a boolean matrix with 4-neighbor connectivity.

true cells are walkable and become nodes labeled by (row, column).

Errors

Returns IndexedInputError::RaggedMatrix if rows have different lengths.

Example

use pathfinding_indexed::IndexedGraphMap;

let mapped = IndexedGraphMap::from_walkable_matrix_4(&[
    vec![true, true, false],
    vec![false, true, true],
])
.unwrap();

let start = mapped.index_of(&(0, 0)).unwrap();
let goal = mapped.index_of(&(1, 2)).unwrap();
let result = mapped.graph().dijkstra(start, |node| node == goal);
assert_eq!(result.map(|(_, cost)| cost), Some(3));

pub fn from_walkable_matrix_8( matrix: &[Vec<bool>], ) -> Result<Self, IndexedInputError>

Build a mapped graph from a boolean matrix with 8-neighbor connectivity.

true cells are walkable and become nodes labeled by (row, column).

Errors

Returns IndexedInputError::RaggedMatrix if rows have different lengths.

pub fn from_walkable_cells_4<F>( rows: usize, columns: usize, walkable: F, ) -> Self

where F: FnMut((usize, usize)) -> bool,

Build a mapped graph from grid dimensions and a walkability predicate using 4-neighbor connectivity.

pub fn from_walkable_cells_8<F>( rows: usize, columns: usize, walkable: F, ) -> Self

where F: FnMut((usize, usize)) -> bool,

Build a mapped graph from grid dimensions and a walkability predicate using 8-neighbor connectivity.

Trait Implementations

impl<N: Clone, C: Clone> Clone for IndexedGraphMap<N, C>

fn clone(&self) -> IndexedGraphMap<N, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug, C: Debug> Debug for IndexedGraphMap<N, C>

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

Formats the value using the given formatter.