Repository: commons-math Updated Branches: refs/heads/task-MATH-1366 [created] cede12d45
Javadoc. Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/ade7e6d9 Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/ade7e6d9 Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/ade7e6d9 Branch: refs/heads/task-MATH-1366 Commit: ade7e6d96fc813e80568e7b62a1326b0aa532366 Parents: a8c6d43 Author: Gilles <er...@apache.org> Authored: Tue May 17 19:25:01 2016 +0200 Committer: Gilles <er...@apache.org> Committed: Tue May 17 19:25:01 2016 +0200 ---------------------------------------------------------------------- .../apache/commons/math4/stat/ranking/NaturalRanking.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/ade7e6d9/src/main/java/org/apache/commons/math4/stat/ranking/NaturalRanking.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/stat/ranking/NaturalRanking.java b/src/main/java/org/apache/commons/math4/stat/ranking/NaturalRanking.java index 404ac00..9b28a8e 100644 --- a/src/main/java/org/apache/commons/math4/stat/ranking/NaturalRanking.java +++ b/src/main/java/org/apache/commons/math4/stat/ranking/NaturalRanking.java @@ -31,13 +31,15 @@ import org.apache.commons.math4.util.FastMath; /** - * <p> Ranking based on the natural ordering on doubles.</p> + * Ranking based on the natural ordering on doubles. + * * <p>NaNs are treated according to the configured {@link NaNStrategy} and ties * are handled using the selected {@link TiesStrategy}. * Configuration settings are supplied in optional constructor arguments. * Defaults are {@link NaNStrategy#FAILED} and {@link TiesStrategy#AVERAGE}, * respectively. When using {@link TiesStrategy#RANDOM}, a - * {@link RandomGenerator} may be supplied as a constructor argument.</p> + * {@link UniformRandomProvider random generator} may be supplied as a + * constructor argument.</p> * <p>Examples: * <table border="1" cellpadding="3"> * <tr><th colspan="3"> @@ -127,7 +129,7 @@ public class NaturalRanking implements RankingAlgorithm { /** * Create a NaturalRanking with TiesStrategy.RANDOM and the given - * RandomGenerator as the source of random data. + * random generator as the source of random data. * * @param randomGenerator source of random data */
