Added higher-level API for querying a node's degree in a graph #75
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
goccy
approved these changes
Dec 13, 2023
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.
As pointed out in #74, the current method for getting a node's degree in a graph (
Degree(n *Node, in, out int)) is unergonomic for most use cases and unnecessarily mimics its C counterpart.This PR introduces higher-level API methods (
Indegree(n *Node),Outdegree(n *Node), andTotalDegree(n *Node))** that simplify retrieving a node's indegree, outdegree, or sum of both. It also adds documentation to the relevant methods to communicate better how they should be used.** I'm open to changing these names if they're unclear or don't follow the naming convention.