Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc fixes (added missing parameter documentations, removed documentation for non-existing parameter, and newline cleanup) 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1085989 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mikkel Meyer Andersen 2011-03-27 17:07:30 +00:00
parent 87a8212704
commit 33959a8a4e
1 changed files with 11 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
src/main/java/org/apache/commons/math/stat/inference/MannWhitneyUTestImpl.java
View File

@ -104,13 +104,10 @@ public class MannWhitneyUTestImpl implements MannWhitneyUTest {
/** /**
* {@inheritDoc} * {@inheritDoc}
* *
* @param x * @param x the first sample
* the first sample * @param y the second sample
* @param y
* the second sample
* @return mannWhitneyU statistic U (maximum of U<sup>x</sup> and U<sup>y</sup>) * @return mannWhitneyU statistic U (maximum of U<sup>x</sup> and U<sup>y</sup>)
* @throws IllegalArgumentException * @throws IllegalArgumentException if preconditions are not met
* if preconditions are not met
*/ */
public double mannWhitneyU(final double[] x, final double[] y) public double mannWhitneyU(final double[] x, final double[] y)
throws IllegalArgumentException { throws IllegalArgumentException {
@ -145,13 +142,11 @@ public class MannWhitneyUTestImpl implements MannWhitneyUTest {
} }
/** /**
* @param Umin * @param Umin smallest Mann-Whitney U value
* smallest Mann-Whitney U value * @param n1 number of subjects in first sample
* @param N * @param n2 number of subjects in second sample
* number of subjects (corresponding to x.length)
* @return two-sided asymptotic p-value * @return two-sided asymptotic p-value
* @throws MathException * @throws MathException if an error occurs computing the p-value
* if an error occurs computing the p-value
*/ */
private double calculateAsymptoticPValue(final double Umin, final int n1, private double calculateAsymptoticPValue(final double Umin, final int n1,
final int n2) throws MathException { final int n2) throws MathException {
@ -177,15 +172,11 @@ public class MannWhitneyUTestImpl implements MannWhitneyUTest {
* *
* {@inheritDoc} * {@inheritDoc}
* *
* @param x * @param x the first sample
* the first sample * @param y the second sample
* @param y
* the second sample
* @return asymptotic p-value (biased for samples with ties) * @return asymptotic p-value (biased for samples with ties)
* @throws IllegalArgumentException * @throws IllegalArgumentException if preconditions are not met
* if preconditions are not met * @throws MathException if an error occurs computing the p-value
* @throws MathException
* if an error occurs computing the p-value
*/ */
public double mannWhitneyUTest(final double[] x, final double[] y) public double mannWhitneyUTest(final double[] x, final double[] y)
throws IllegalArgumentException, MathException { throws IllegalArgumentException, MathException {