searchlib 0.1.2

Satisficing and optimal search algorithms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! [Greedy Best First Search](https://en.wikipedia.org/wiki/Best-first_search)

use crate::{trace, FxIndexMap};
use indexmap::map::Entry::{Occupied, Vacant};
use std::{collections::BinaryHeap, hash::Hash};

#[derive(Debug, Clone, Eq, PartialEq)]
struct Element {
    index: usize,
    estimate: usize,
}

impl Ord for Element {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        other.estimate.cmp(&self.estimate)
    }
}

impl PartialOrd for Element {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

pub struct GBFS<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER>
where
    STATE: Eq + Hash + Clone,
    SUCCESSORS: FnMut(&STATE) -> ITER,
    SUCCESS: FnMut(&STATE) -> bool,
    HEURISTIC: FnMut(&STATE) -> usize,
    ITER: IntoIterator<Item = STATE>,
{
    queue: BinaryHeap<Element>,
    states: FxIndexMap<STATE, usize>,
    successors: SUCCESSORS,
    success: SUCCESS,
    heuristic: HEURISTIC,
}

impl<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER> GBFS<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER>
where
    STATE: Eq + Hash + Clone,
    SUCCESSORS: FnMut(&STATE) -> ITER,
    SUCCESS: FnMut(&STATE) -> bool,
    HEURISTIC: FnMut(&STATE) -> usize,
    ITER: IntoIterator<Item = STATE>,
{
    pub fn new(
        init: &STATE,
        successors: SUCCESSORS,
        success: SUCCESS,
        heuristic: HEURISTIC,
    ) -> Self {
        let mut states = FxIndexMap::default();
        states.insert(init.clone(), 0);
        let queue = BinaryHeap::from(vec![Element {
            index: 0,
            estimate: 0,
        }]);
        Self {
            queue,
            states,
            successors,
            success,
            heuristic,
        }
    }
}

impl<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER> Iterator
    for GBFS<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER>
where
    STATE: Eq + Hash + Clone,
    SUCCESSORS: FnMut(&STATE) -> ITER,
    SUCCESS: FnMut(&STATE) -> bool,
    HEURISTIC: FnMut(&STATE) -> usize,
    ITER: IntoIterator<Item = STATE>,
{
    type Item = Option<Vec<STATE>>;

    fn next(&mut self) -> Option<Self::Item> {
        let Element { index, estimate: _ } = self.queue.pop()?;
        let (node, _) = self.states.get_index(index).unwrap();
        if (self.success)(node) {
            return Some(Some(trace(&self.states, index)));
        }
        for successor in (self.successors)(node) {
            let index = match self.states.entry(successor) {
                Vacant(e) => {
                    let i = e.index();
                    e.insert(index);
                    i
                }
                Occupied(_) => continue,
            };
            let (state, _) = self.states.get_index(index).unwrap();
            self.queue.push(Element {
                index,
                estimate: (self.heuristic)(state),
            });
        }
        Some(None)
    }
}

/// ```
/// use searchlib::gbfs::solve;
/// const INIT: (isize, isize) = (1, 1);
/// const GOAL: (isize, isize) = (4, 6);
///
/// fn successors(state: &(isize, isize)) -> Vec<(isize, isize)> {
///     let (x, y) = state;
///     vec![(x + 1, *y), (x - 1, *y),(*x, y + 1), (*x, y - 1)]
/// }
///
/// fn heuristic(state: &(isize, isize)) -> usize {
///     state.0.abs_diff(GOAL.0) + state.1.abs_diff(GOAL.1)
/// }
///
/// let result = solve(&INIT, successors, |&s| s == GOAL, heuristic);
/// assert!(result.is_some());
/// ```
pub fn solve<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER>(
    init: &STATE,
    successors: SUCCESSORS,
    success: SUCCESS,
    heuristic: HEURISTIC,
) -> Option<Vec<STATE>>
where
    STATE: Eq + Hash + Clone,
    SUCCESSORS: FnMut(&STATE) -> ITER,
    SUCCESS: FnMut(&STATE) -> bool,
    HEURISTIC: FnMut(&STATE) -> usize,
    ITER: IntoIterator<Item = STATE>,
{
    GBFS::new(init, successors, success, heuristic)
        .into_iter()
        .find(|i| i.is_some())?
}

pub fn paths<STATE, SUCCESSORS, SUCCESS, HEURISTIC, ITER>(
    init: &STATE,
    successors: SUCCESSORS,
    success: SUCCESS,
    heuristic: HEURISTIC,
) -> impl Iterator<Item = Vec<STATE>>
where
    STATE: Eq + Hash + Clone,
    SUCCESSORS: FnMut(&STATE) -> ITER,
    SUCCESS: FnMut(&STATE) -> bool,
    HEURISTIC: FnMut(&STATE) -> usize,
    ITER: IntoIterator<Item = STATE>,
{
    GBFS::new(init, successors, success, heuristic)
        .into_iter()
        .filter_map(|i| i)
}