path-finding 0.8.0

This library provides a variety of path finding and graph operations. Work in progress.
Documentation
use std::collections::{HashMap, HashSet};

use ordered_float::NotNan;
use priority_queue::DoublePriorityQueue;

use crate::graph::{Edge, Graph};
use crate::grid::{Direction, Grid};
use crate::node::{Node, Vec3};
use crate::path::PathFinding;

pub struct BreadthFirstSearch {}

pub struct Dijkstra {}

pub(crate) fn dijkstra(source: Node,
                       target: Node,
                       graph: &Graph,
                       heuristic: &dyn Fn(&Vec3, &Vec3) -> f32) -> Graph {
    let mut visited: HashSet<usize> = HashSet::new();
    let mut node_to_edges: HashMap<usize, Vec<Edge>> = HashMap::new();
    let mut queue: DoublePriorityQueue<usize, NotNan<f32>> = DoublePriorityQueue::new();

    queue.push(source.id, NotNan::new(0.0).unwrap());
    node_to_edges.insert(source.id, Vec::new());

    while !visited.contains(&target.id) && !queue.is_empty() {
        let current = queue.pop_min().unwrap();
        visited.insert(current.0);

        if let Some(node) = graph.nodes_lookup.get(&current.0) {
            for edge in &node.edges {
                let dest_id = edge.destination;

                if !visited.contains(&dest_id) {
                    let mut cost = current.1 + edge.weight;

                    if graph.position_is_set() {
                        cost = cost + heuristic(graph.get_position(&edge.destination),
                            graph.get_position(&target.id), );
                    }

                    queue.push(edge.destination, cost);

                    let mut from_edges = node_to_edges.get(&current.0).unwrap_or(&Vec::new()).clone();
                    from_edges.push(edge.clone());
                    node_to_edges.insert(dest_id, from_edges);
                }
            }
        }
    }

    return Graph::from(node_to_edges.get(&target.id).cloned().unwrap_or_default().into());
}

pub(crate) fn dijkstra_grid(source: (usize, usize),
                            target: (usize, usize),
                            grid: &Grid,
                            directions: &[Direction],
                            heuristic: &dyn Fn(&Vec3, &Vec3) -> f32) -> Graph {
    let mut visited: HashSet<usize> = HashSet::new();
    let mut node_to_edges: HashMap<usize, Vec<Edge>> = HashMap::new();
    let mut queue: DoublePriorityQueue<usize, NotNan<f32>> = DoublePriorityQueue::new();

    let src_id = grid.node_id(source);
    let trg_id = grid.node_id(target);

    queue.push(src_id, NotNan::new(0.0).unwrap());
    node_to_edges.insert(src_id, Vec::new());

    while !visited.contains(&trg_id) && !queue.is_empty() {
        let current = queue.pop_min().unwrap();
        visited.insert(current.0);

        for direction in directions {
            let dest_coord = direction.attempt_move(grid.coords(current.0));

            if grid.outside(dest_coord) {
                continue;
            }

            let dest_id = grid.node_id(dest_coord);

            if !visited.contains(&dest_id) {
                let cost = current.1 + grid.cost(dest_id) + heuristic(
                    &Vec3::from(dest_coord.0 as f32, dest_coord.1 as f32, 0.0),
                    &Vec3::from(target.0 as f32, target.1 as f32, 0.0),
                );
                queue.push(dest_id, cost);
                let edge = Edge::from(dest_id, current.0, dest_id, grid.cost(dest_id));

                let mut from_edges = node_to_edges.get(&current.0).unwrap_or(&Vec::new()).clone();
                from_edges.push(edge);
                node_to_edges.insert(dest_id, from_edges);
            }
        }
    }

    return Graph::from(node_to_edges.get(&trg_id).cloned().unwrap_or_default().into());
}

fn dijkstra_heuristic(_src: &Vec3, _dest: &Vec3) -> f32 {
    return 0.0;
}

impl PathFinding for Dijkstra {
    fn graph(&self, source: Node, target: Node, graph: &Graph) -> Graph {
        return dijkstra(source, target, graph, &dijkstra_heuristic);
    }

    fn grid(&self, source: (usize, usize), target: (usize, usize), grid: &Grid, directions: &[Direction]) -> Graph {
        return dijkstra_grid(source, target, grid, directions, &dijkstra_heuristic);
    }
}

#[test]
fn should_find_path_with_dijkstra_between_a_and_b() {
    let graph = graph();

    let dij = Dijkstra {};
    let path = dij.graph(graph.nodes_lookup.get(&0).unwrap().clone(),
                         graph.nodes_lookup.get(&1).unwrap().clone(), &graph);

    assert_eq!(3.0, calc_cost(&path.edges));
    assert_eq!(2, path.edges.len());
}

#[test]
fn should_find_path_with_dijkstra_between_a_and_c() {
    let graph = graph();

    let dij = Dijkstra {};
    let path = dij.graph(get_node(0, &graph), get_node(2, &graph), &graph);


    assert_eq!(2.0, calc_cost(&path.edges));
    assert_eq!(1, path.edges.len());
}

#[test]
fn should_find_path_with_dijkstra_between_a_and_d() {
    let graph = graph();

    let dij = Dijkstra {};
    let path = dij.graph(get_node(0, &graph), get_node(3, &graph), &graph);


    assert_eq!(5.0, calc_cost(&path.edges));
    assert_eq!(3, path.edges.len());
}

#[test]
fn should_find_path_with_dijkstra_between_a_and_e() {
    let graph = graph();

    let dij = Dijkstra {};
    let path = dij.graph(get_node(0, &graph), get_node(4, &graph), &graph);


    assert_eq!(6.0, calc_cost(&path.edges));
    assert_eq!(3, path.edges.len());
}

#[test]
fn should_find_path_with_disjoint_graphs() {
    let graph = disjoint_graph();

    let dij = Dijkstra {};
    let path = dij.graph(get_node(0, &graph), get_node(3, &graph), &graph);

    assert_eq!(0.0, calc_cost(&path.edges));
    assert_eq!(0, path.edges.len());
}

#[cfg(test)]
fn graph() -> Graph {
    return Graph::from(Vec::from([
        Edge::from(0, 0, 1, 4.0),
        Edge::from(1, 0, 2, 2.0),
        Edge::from(2, 1, 2, 3.0),
        Edge::from(3, 1, 3, 2.0),
        Edge::from(4, 1, 4, 3.0),
        Edge::from(5, 2, 1, 1.0),
        Edge::from(6, 2, 3, 4.0),
        Edge::from(7, 2, 4, 5.0),
        Edge::from(8, 4, 3, 1.0)
    ]));
}

#[cfg(test)]
fn disjoint_graph() -> Graph {
    return Graph::from(Vec::from([
        Edge::from(0, 0, 1, 4.0),
        Edge::from(1, 2, 3, 2.0),
    ]));
}

#[cfg(test)]
fn get_node(id: usize, graph: &Graph) -> Node {
    return graph.nodes_lookup.get(&id).unwrap().clone();
}

#[cfg(test)]
fn calc_cost(edges: &Vec<Edge>) -> f32 {
    let mut total_cost: f32 = 0.0;
    for edge in edges {
        total_cost += edge.weight;
    }

    return total_cost;
}