Skip to content

Set to default strategies if null is given #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pingpingy1 wants to merge 2 commits into
base: master
Choose a base branch
from
+17 −2
Open

Set to default strategies if null is given #236

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49857b6
Set to default strategies if null is given
pingpingy1 Feb 22, 2024
4e88264
Apply suggestions from code review
pingpingy1 Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...ath-legacy/src/main/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRanking.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Copy link
Contributor

@aherbert aherbert Feb 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Copy link
Author

@pingpingy1 pingpingy1 Feb 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. Let me modify the test case accordingly.

this.tiesStrategy = tiesStrategy != null ? tiesStrategy : DEFAULT_TIES_STRATEGY;
this.random = random;
}

Expand Down
11 changes: 11 additions & 0 deletions ...legacy/src/test/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRankingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,4 +279,15 @@ public void testNoNaNsFailed() {
double[] ranks = ranking.rank(data);
TestUtils.assertEquals(data, ranks, 0d);
}

/**
* Tests NaturalRanking constructor with null strategies as inputs.
* These should be switched to the default strategies.
*/
@Test
public void testNullStrategies() {
NaturalRanking ranking = new NaturalRanking((NaNStrategy) null, (TiesStrategy) null);
Assert.assertEquals(ranking.getNanStrategy(), NaturalRanking.DEFAULT_NAN_STRATEGY);
Assert.assertEquals(ranking.getTiesStrategy(), NaturalRanking.DEFAULT_TIES_STRATEGY);
}
}