We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent d18d3a3 commit 3de044aCopy full SHA for 3de044a
src/primitive/defs.rs
@@ -2440,6 +2440,8 @@ primitive!(
2440
/// - An array of the neighboring nodes must always be returned.
2441
/// - An array of costs may be returned above the nodes array on the stack. If ommitted, all costs are assumed to be 1.
2442
/// The second function should return a heuristic cost to reach the goal node.
2443
+ /// - The heuristic may return a value [less or equal] the actual cost
2444
+ /// - It must *never* overestimate the cost, or the algorithm may not find the shortest path
2445
/// The third function should return whether or not the goal node has been reached.
2446
///
2447
/// When called, [astar] will pop any additional arguments its functions need from the stack.
0 commit comments