Settle the interface names and the return-type caveats - #191
Merged
Merged
Conversation
Renames the four per-element encode and decode functions to participle form, so every name in the interface reads as the vertex or edge of the encoded graph, matching `encoded_graph` and the `encoded_vertices` and `decoded_vertices` fields.
`AbstractTreeGraph` and `QuotientView` both answer with the graph they wrap, so the two independent functions of that name become one generic in `NamedGraphs` that `PartitionedGraphs` extends.
mtfishman
changed the title
The functions returning a vector of names or edges carried caveats in four wordings, mostly over-specifying what the result is. Their plain descriptions already promise nothing about the concrete type, so the caveats go, leaving one note where the result really does alias the graph.
mtfishman
force-pushed
the
mf/encoded-decoded-naming
branch
from
August 28, 2026 22:01
8a7bc53 to
c19b9b6
Compare
mtfishman
changed the title
mtfishman
enabled auto-merge (squash)
August 28, 2026 22:04
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
1 participant
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.
Summary
Renames the four encode and decode functions to participle form, so every name reads as the vertex or edge of the encoded graph. Also unifies the two
parent_graph_typefunctions, one concept split across two submodules, and trims the return-type caveats on the vector-returning functions, which had grown into four wordings that over-specified the result.