Redesign GenericNamedGraph type
#73
Merged
Conversation
This file contains 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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #73 +/- ##
==========================================
+ Coverage 78.82% 82.75% +3.93%
==========================================
Files 34 44 +10
Lines 1190 1508 +318
==========================================
+ Hits 938 1248 +310
- Misses 252 260 +8 ☔ View full report in Codecov by Sentry. |
mtfishman
changed the title
GenericNamedGraph typeGenericNamedGraph type
This was referenced Apr 24, 2024
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.
Closes #70.
The new design is:
vertices(::GenericNamedGraph)returns anI::OrderedIndicesobject. Iterating over those returns the vertices in the order corresponding to the underlying simple graph. Additionally,I::OrderedIndicesstores a hash map so it has fast vertex lookup, and has positional indexing with syntax inspired by OrdinalIndexing.jl asI[4th]to get the 4th index/element of the set. That is needed since it is anAbstractIndicessubtype based on theAbstractIndicesinterface of Dictionaries.jl, where the interface is that indexing intoAbstractIndicesmaps the index back to itself if it is an element of the set.position_graph(::GenericNamedGraph)outputs the underlying simple graph of the named graph.ordered_vertices(::GenericNamedGraph)outputs an ordered list of the (named) vertices that can be indexed by integer positions to get the corresponding vertex.vertex_positions(::GenericNamedGraph)outputs a dictionary that maps from a (named) vertex to the position of that vertex.