! Copyright (C) 2010 Samuel Tardieu.
! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax assocs ;
IN: path-finding
{ <astar> <bfs> <dijkstra> } related-words
{ "neighbours" "a quotation with stack effect ( node -- seq )" }
{ "cost" "a quotation with stack effect ( from to -- cost )" }
{ "heuristic" "a quotation with stack effect ( pos target -- cost )" }
- { "astar" "a astar tuple" }
+ { "astar" astar }
}
{ $description "Build an astar object from the given quotations. The "
{ $snippet "neighbours" } " one builds the list of neighbours. The "
HELP: <bfs>
{ $values
- { "neighbours" "an assoc" }
- { "astar" "a astar tuple" }
+ { "neighbours" assoc }
+ { "astar" astar }
}
{ $description "Build an astar object from the " { $snippet "neighbours" } " assoc. "
"When used with " { $link find-path } ", this astar tuple will use the breadth-first search (BFS) "
HELP: <dijkstra>
{ $values
- { "costs" "an assoc" }
+ { "costs" assoc }
+ { "astar" astar }
}
{ $description "Build an astar object from the " { $snippet "costs" } " assoc. "
"The assoc keys are edges of the graph, while the corresponding values are assocs whose keys are "
{ $values
{ "start" "a node" }
{ "target" "a node" }
- { "astar" "a astar tuple" }
+ { "astar" astar }
{ "path/f" "an optimal path from " { $snippet "start" } " to " { $snippet "target" }
", or f if no such path exists" }
}
HELP: considered
{ $values
- { "astar" "a astar tuple" }
+ { "astar" astar }
{ "considered" "a sequence" }
}
{ $description "When called after a call to " { $link find-path } ", return a list of nodes "