| 1 | <HTML> |
|---|
| 2 | <!-- |
|---|
| 3 | -- Copyright (c) 2004 Kris Beevers |
|---|
| 4 | -- |
|---|
| 5 | -- Permission to use, copy, modify, distribute and sell this software |
|---|
| 6 | -- and its documentation for any purpose is hereby granted without fee, |
|---|
| 7 | -- provided that the above copyright notice appears in all copies and |
|---|
| 8 | -- that both that copyright notice and this permission notice appear |
|---|
| 9 | -- in supporting documentation. We make no |
|---|
| 10 | -- representations about the suitability of this software for any |
|---|
| 11 | -- purpose. It is provided "as is" without express or implied warranty. |
|---|
| 12 | --> |
|---|
| 13 | <Head> |
|---|
| 14 | <Title>Boost Graph Library: astar_heuristic</Title> |
|---|
| 15 | <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" |
|---|
| 16 | ALINK="#ff0000"> |
|---|
| 17 | <IMG SRC="../../../boost.png" |
|---|
| 18 | ALT="C++ Boost" width="277" height="86"> |
|---|
| 19 | |
|---|
| 20 | <BR Clear> |
|---|
| 21 | |
|---|
| 22 | <H1> |
|---|
| 23 | <pre> |
|---|
| 24 | astar_heuristic<Graph, CostType> |
|---|
| 25 | </pre> |
|---|
| 26 | </H1> |
|---|
| 27 | |
|---|
| 28 | This class is a default implementation of the <a |
|---|
| 29 | href="./AStarHeuristic.html">AStarHeuristic</a> concept. It |
|---|
| 30 | implements a "zero" heuristic -- a heuristic function that returns a |
|---|
| 31 | cost of zero regardless of the vertex it is passed. |
|---|
| 32 | |
|---|
| 33 | <h3>Model of</h3> |
|---|
| 34 | |
|---|
| 35 | <a href="./AStarHeuristic.html">AStarHeuristic</a> |
|---|
| 36 | |
|---|
| 37 | <H3>Template Parameters</H3> |
|---|
| 38 | |
|---|
| 39 | <P> |
|---|
| 40 | <TABLE border> |
|---|
| 41 | <TR> |
|---|
| 42 | <th>Parameter</th><th>Description</th><th>Default</th> |
|---|
| 43 | </tr> |
|---|
| 44 | |
|---|
| 45 | <TR><TD><TT>Graph</TT></TD> |
|---|
| 46 | <TD> |
|---|
| 47 | The type of the graph being searched. |
|---|
| 48 | </TD> |
|---|
| 49 | <TD></TD> |
|---|
| 50 | </TR> |
|---|
| 51 | |
|---|
| 52 | <TR><TD><TT>CostType</TT></TD> |
|---|
| 53 | <TD> |
|---|
| 54 | A type that can be used with the <tt>compare</tt> and |
|---|
| 55 | <tt>combine</tt> functions passed to A*. Typically an integer or |
|---|
| 56 | floating point type. |
|---|
| 57 | </TD> |
|---|
| 58 | <TD></TD> |
|---|
| 59 | </TR> |
|---|
| 60 | |
|---|
| 61 | </table> |
|---|
| 62 | |
|---|
| 63 | <H3>Where Defined</H3> |
|---|
| 64 | |
|---|
| 65 | <P> |
|---|
| 66 | <a href="../../../boost/graph/astar_search.hpp"> |
|---|
| 67 | <TT>boost/graph/astar_search.hpp</TT></a> |
|---|
| 68 | |
|---|
| 69 | <h3>Member Functions</h3> |
|---|
| 70 | |
|---|
| 71 | This class implements the single member function required by <a |
|---|
| 72 | href="./AStarHeuristic.html">AStarHeuristic</a>: |
|---|
| 73 | |
|---|
| 74 | <table border> |
|---|
| 75 | <tr> |
|---|
| 76 | <th>Function</th><th>Description</th> |
|---|
| 77 | </tr> |
|---|
| 78 | |
|---|
| 79 | <tr><td><tt> |
|---|
| 80 | CostType operator()(graph_traits<Graph>::vertex_descriptor u); |
|---|
| 81 | </tt></td><td> |
|---|
| 82 | Called for the target of every out edge of a vertex being examined. |
|---|
| 83 | Returns the cost, estimated by the heuristic, from vertex <tt>u</tt> |
|---|
| 84 | to a goal. |
|---|
| 85 | </td></tr> |
|---|
| 86 | |
|---|
| 87 | </table> |
|---|
| 88 | |
|---|
| 89 | <br> |
|---|
| 90 | <HR> |
|---|
| 91 | <TABLE> |
|---|
| 92 | <TR valign=top> |
|---|
| 93 | <TD nowrap>Copyright © 2004</TD><TD> |
|---|
| 94 | <A HREF="http://www.cs.rpi.edu/~beevek/">Kristopher Beevers</A>, |
|---|
| 95 | Rensselaer Polytechnic Institute (<A |
|---|
| 96 | HREF="mailto:beevek@cs.rpi.edu">beevek@cs.rpi.edu</A>) |
|---|
| 97 | </TD></TR></TABLE> |
|---|
| 98 | |
|---|
| 99 | </BODY> |
|---|
| 100 | </HTML> |
|---|
