Skip to content

feat: within, near, subgraph, coordinates and an optional k-d tree #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
petercorke merged 4 commits into from
Oct 12, 2026
Merged

feat: within, near, subgraph, coordinates and an optional k-d tree #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
78ffdb7
feat: Graph.within, Graph.near and Graph.subgraph
petercorke Oct 12, 2026
caec1ab
feat: coordinates(), build_kdtree(), subgraph mask, validate coordinates
petercorke Oct 12, 2026
b761767
tests: cover near without an index, the guards, and the pickle markers
petercorke Oct 12, 2026
3973f82
Merge branch 'main' into feat/spatial-queries
petercorke Oct 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/source/analysis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,29 @@ Structure and connectivity
Geometry and consistency
^^^^^^^^^^^^^^^^^^^^^^^^^

For a graph whose vertices have coordinates,
:meth:`~pgraph.PGraph.Graph.coordinates` is the matrix of them, one column per
vertex. :meth:`~pgraph.PGraph.Graph.closest` finds the nearest vertex to a
point, :meth:`~pgraph.PGraph.Graph.near` the vertices within a distance of a
point and :meth:`~pgraph.PGraph.Graph.within` the vertices inside a box. Passing
the result of the last to :meth:`~pgraph.PGraph.Graph.subgraph` gives the part of
the graph in a region, without the edges that cross its border, and a boolean
mask computed from the coordinates selects in the same way.

These are a single pass over the vertices. For a large graph that is queried
often, :meth:`~pgraph.PGraph.Graph.build_kdtree` builds an index that
:meth:`~pgraph.PGraph.Graph.closest` and :meth:`~pgraph.PGraph.Graph.near` then
use, which needs scipy and is for the built-in metrics.

.. autosummary::
:nosignatures:

~pgraph.PGraph.Graph.coordinates
~pgraph.PGraph.Graph.closest
~pgraph.PGraph.Graph.near
~pgraph.PGraph.Graph.within
~pgraph.PGraph.Graph.build_kdtree
~pgraph.PGraph.Graph.subgraph
~pgraph.PGraph.Graph.validate

The matrices of a graph (:meth:`~pgraph.PGraph.Graph.adjacency`,
Expand Down Expand Up @@ -153,7 +172,12 @@ Details
.. automethod:: pgraph.PGraph.Graph.samecomponent
.. automethod:: pgraph.PGraph.Graph.connectivity
.. automethod:: pgraph.PGraph.Graph.average_degree
.. automethod:: pgraph.PGraph.Graph.coordinates
.. automethod:: pgraph.PGraph.Graph.closest
.. automethod:: pgraph.PGraph.Graph.near
.. automethod:: pgraph.PGraph.Graph.within
.. automethod:: pgraph.PGraph.Graph.build_kdtree
.. automethod:: pgraph.PGraph.Graph.subgraph
.. automethod:: pgraph.PGraph.Graph.validate

.. autoproperty:: pgraph.PGraph.Vertex.name
Expand Down
Loading
Loading