Qiskit / rustworkx / 29439951702

95%

Build Type

push

github

Committed by web-flow

Commit Message

Return neighbors in a deterministic order (#1638)

* Return neighbors in a deterministic order

PyGraph.neighbors, PyDiGraph.neighbors and PyDiGraph.neighbors_undirected
deduplicated their results through a HashSet and returned them via
`drain()`. The HashSet iteration order is randomized, so the order of the
returned node indices could change between runs and even between calls.

Deduplicate while preserving the graph's edge iteration order by filtering
through a `seen` set instead of draining a HashSet. This keeps the
multigraph deduplication behaviour but makes the ordering stable.

Also update the now-deterministic neighbors_undirected docstring example
and add regression tests asserting a stable order and correct dedup.

Fixes #1501

* Use IndexSet for deterministic ordering

---------

Co-authored-by: Ivan Carvalho <ivancarvalho@gatech.edu>

Coverage Stats

6 of 6 new or added lines in 2 files covered. (100.0%)

3 existing lines in 1 file now uncovered.

19227 of 20307 relevant lines covered (94.68%)

921596.36 hits per line