Rename and tighten type definitions #112
Merged
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.
We had conflicting definitions of what a hyperedge is in different parts of code and documentation.
This PR defines a hyperedge as a 2-tuple of tuples (in-nodes, out-nodes). Documentation updated to reflect this.
There is now a
TrackGraph.is_hyperedge
that can be used to test whether an edge is a hyperedge (should be preferred over manualisinstance
calls). This function will also yell if a tuple is neither a normal edge nor a hyperedge as defined above.Renamed type definitions while at it as well to be shorter and more descriptive.