diff --git a/src/site/xdoc/userguide/index.xml b/src/site/xdoc/userguide/index.xml index 475b054c2..4c5088c10 100644 --- a/src/site/xdoc/userguide/index.xml +++ b/src/site/xdoc/userguide/index.xml @@ -43,7 +43,10 @@
+ Some statistical algorithms require that input data be replaced by ranks. + The + org.apache.commons.math.stat.ranking package provides rank transformation. + + RankingAlgorithm defines the interface for ranking. + + NaturalRanking provides an implementation that has two configuration options. +
+ Examples:
+
+ results in ranks
containing {6, 5, 7, 8, 5, 9, 2, 2, 5}.
+
+ returns {5, 2, 6, 7, 3, 8, 1, 4}.
+
+ The default NaNStrategy
is NaNStrategy.MAXIMAL. This makes NaN
+ values larger than any other value (including Double.POSITIVE_INFINITY
). The
+ default TiesStrategy
is TiesStrategy.AVERAGE,
which assigns tied
+ values the average of the ranks applicable to the sequence of ties. See the
+
+ NaturalRanking for more examples and
+ TiesStrategy and NaNStrategy
+ for details on these configuration options.
+
The org.apache.commons.math.stat.correlation package computes covariances @@ -617,7 +660,7 @@ new PearsonsCorrelation(data).getCorrelationPValues().getEntry(0,1)