reachqDocumentation
GitHub
reachq/API reference/API reference
02 / supported surface

API reference

The small set of graph, construction, query, and invariant APIs intended for ordinary reachq users.

Edit this pageUpdated with the source

Start with the top-level imports

The supported surface is intentionally explicit. Use graph primitives and construction functions from the package modules below; treat reachq.research and reachq.accel as experimental.

from reachq import Digraph, WeightedDigraph
from reachq.shortcut import build_shortcut_set_for_reachability
from reachq.hopset import build_hopset_for_sssp
from reachq.reachability import bfs_reachability, parallel_bfs
from reachq.shortest_paths import dijkstra, shortest_path_hopbound

Primary modules

  • Graph primitives: reachq.graph
  • Reachability: reachq.reachability and reachq.shortcut
  • Shortest paths: reachq.shortest_paths and reachq.hopset
  • Validation: reachq.invariants
  • Serialization: reachq.io

Read the signatures

The implementation docstrings are the authoritative signature source. Browse the top-level exports and the maintained modules on GitHub.

There is no promise of API stability before 1.0. Breaking changes are recorded in CHANGELOG.md.