Set to default strategies if null is given #236
Conversation
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
In the current implementation, it is possible to set the `nanStrategy` and `tiesStrategy` of `NaturalRanking` to `null`, even though they will inevitably throw NPEs upon any calls to `rank` or `resolveTie`. This commit modifies the constructor such that if `null` is given to either of the strategies, then they are set to the default strategies.
aherbert
reviewed
Feb 22, 2024
| @@ -158,8 +158,8 @@ public NaturalRanking(NaNStrategy nanStrategy, | |||
| private NaturalRanking(NaNStrategy nanStrategy, | |||
| TiesStrategy tiesStrategy, | |||
| UniformRandomProvider random) { | |||
| this.nanStrategy = nanStrategy; | |||
| this.tiesStrategy = tiesStrategy; | |||
| this.nanStrategy = nanStrategy != null ? nanStrategy : DEFAULT_NAN_STRATEGY; | |||
There was a problem hiding this comment.
If the user-supplied parameter is null then this is an error. I think it may be preferable to throw a NPE here:
this.nanStrategy = Objects.requireNonNull(nanStrategy, "nanStrategy");
this.tiesStrategy = Objects.requireNonNull(tiesStrategy, "tiesStrategy");Note: This class has been ported to the Commons Statistics project and will be released in version 1.1.
See: https://github.com/apache/commons-statistics/blob/master/commons-statistics-ranking/src/main/java/org/apache/commons/statistics/ranking/NaturalRanking.java
I updated that implementation to throw NPE for user-supplied arguments. Thanks for the prompting.
You can test the current implementation using the apache snapshots repo using e.g.:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-statistics-ranking</artifactId>
<version>1.1-SNAPSHOT</version>
</dependency>There was a problem hiding this comment.
Sounds good. Let me modify the test case accordingly.
As suggested by @aherbert, replaces the default strategies with fail-fast `null` guards.
|
@aherbert Just pushed the suggested changes; PTAL. |
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.
In the current implementation, it is possible to set the
nanStrategyandtiesStrategyofNaturalRankingtonull, even though they will inevitably throw NPEs upon any calls torankorresolveTie. This commit modifies the constructor such that ifnullis given to either of the strategies, then they are set to the default strategies.