Algorithm standardisation #1896
Open
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
ljeub-pometry
requested changes
Dec 12, 2024
Comment on lines
+49
to
52
| /// The largest degree | ||
| pub fn max_degree<'graph, G: GraphViewOps<'graph>>(graph: &G) -> usize { | ||
| graph.nodes().degree().max().unwrap_or(0) | ||
| } |
There was a problem hiding this comment.
this algorithm is fairly useless now that it's just graph.nodes().degree().max()...
There was a problem hiding this comment.
Agreed. I'll just take it out.
There was a problem hiding this comment.
Actually, to be fair, all of these 'max_in_degree', 'max_out_degree'... etc do not really rise to the level of algorithms, imo. They're all just one-liners.
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.
What changes were proposed in this pull request?
Standardization of docstrings, method signatures, and return types of many of the algorithms.
Why are the changes needed?
Improves developer experience of the platform.
Does this PR introduce any user-facing change? If yes is this documented?
All docstrings have been updated to reflect changes to method signatures in the Python and Rust functions.
raphtory-graphql/src/model/algorithms/algorithms.rs featured a small internal change to reflect the updates to Dijkstra's algorithm. The code is functionally equivalent, Dijkstra's algorithm just returns an AlgorithmResult which needed to be unpacked properly in the surrounding code.
How was this patch tested?
All Rust and Python tests pass with idempotent results.
Are there any further changes required?
The AlgorithmResults will soon be changed to NodeState results. This PR is still worth it, imo, since it will be easier to mechanically change AlgorithmResult outputs to NodeState outputs and all of the documentation and signature normalizations are valuable.