Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • graph-tool graph-tool
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 56
    • Issues 56
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 1
    • Merge requests 1
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar

Please use the issue tracker only to report bugs (i.e. errors in the library that need to be fixed) or feature requests.

For questions about how to compile, install or use the library, please use instead either the web forum at https://forum.skewed.de/c/graph-tool or the mailing list at https://graph-tool.skewed.de/mailing


(If unsure, use the forum or mailing list first.)


When opening new issues, please choose the BUG template from the drop-down menu, and fill out the required information.

  • Tiago Peixoto
  • graph-toolgraph-tool
  • Issues
  • #222
Closed
Open
Issue created May 04, 2015 by jeremyherbert@jeremyherbert

Ambiguous sentence in documentation

Hi,

I'm using graph-tool to do a simple astar search, and the documentation has the following sentence under astar_search:

heuristic : unary function (optional, default: lambda v: 1) The heuristic function that guides the search. It should take a single argument which is a Vertex, and output an estimated distance from the source vertex.

This is kind of ambiguous, because it is not clear which source vertex you are referring to. Is it the one which is passed to the original call? Or is the argument v === source vertex? (But I already know the answer)

Can I suggest the following wording? (changes bold)

heuristic : unary function (optional, default: lambda v: 1) The heuristic function that guides the search. It should take a single argument which is a Vertex, and output an estimated distance from the supplied vertex to the target vertex.

Assignee
Assign to
Time tracking