Repository navigation
docs: README, London example, corrected Queensland figure, performance tables - #64
Merged
Merged
Conversation
A subsection after the Queensland example with the map of the road network and the routes there and back between Buckingham Palace and Tower Bridge, drawn by the london notebook, and a link to it. The figure is in docs/figs. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Installation; the Queensland example reads the same data file as the notebook it links to and gives the same path; component(c) takes a component number, and v.label is the component of a vertex; path_UCS, the geometry methods, metric, copy, export and validate are listed; vertex_class and edge_class in the subclassing section; headings that make an outline; the two benchmark tables, with the description of the runs in one paragraph above them. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…e figures The figure was drawn from places.json, whose coordinates are in metres while the road distances are in km, so the A* heuristic was far too large and the route it found, 1,759 km via Rockhampton, was not the shortest. The notebook and the snippet use queensland.json, in km: 1,659 km via Roma. The figure is drawn from that, with the axes in km. The README figures have a description as their alternative text. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Measured on main with the faster planners, the components union-find, and the vertex constructor that does not pay for the coordinate hook: a vertex is 1.5 us, the components after a change are 3.9 ms (undirected) and 5.9 ms (directed) at 10,000 vertices. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #64 +/- ##
=======================================
Coverage 97.26% 97.26%
=======================================
Files 3 3
Lines 1570 1570
=======================================
Hits 1527 1527
Misses 43 43 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A review and extension of the README.
Corrections
roads.pngwas drawn fromplaces.json, whose coordinates are in metres while the road distances are in km, so the A* heuristic was about 1,000 times too large and the route it found, 1,759 km via Rockhampton, was not the shortest.queensland.json(the same routes and distances, coordinates in km) gives 1,659 km via Roma, which is what the notebook and the snippet compute. The figure is regenerated from the snippet, axes in km.g.component(v)was documented as "the component that vertexvbelongs to"; it takes a component number.v.labelis the component of a vertex.intro.rst: "pgaph-python" in the history paragraph.Added
pip install pgraph-python, Python 3.9 or later).path_UCS,closest,near,within,subgraph,coordinates,build_kdtree,metric/SE2Metric,copy,exportandvalidate;vertex_classandedge_classin the subclassing section; a runnable subclassing snippet.examples/benchmark.pyon current main.## Installation,## Examples,## Using pgraph,## Performance,## History.Docs only, apart from the regenerated PNG and the new
docs/figs/london_route.png.🤖 Generated with Claude Code