Repository: commons-math Updated Branches: refs/heads/MATH_3_X 523774aa8 -> 41642aaaa
Javadoc fixes. Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/41642aaa Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/41642aaa Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/41642aaa Branch: refs/heads/MATH_3_X Commit: 41642aaaad45bb883ba833b91544ed499bfe393d Parents: 523774a Author: Phil Steitz <phil.ste...@gmail.com> Authored: Sat Dec 26 09:05:36 2015 -0700 Committer: Phil Steitz <phil.ste...@gmail.com> Committed: Sat Dec 26 09:05:36 2015 -0700 ---------------------------------------------------------------------- .../commons/math3/util/CombinatoricsUtils.java | 48 ++++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/41642aaa/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java b/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java index e43d549..62025ad 100644 --- a/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java +++ b/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java @@ -57,20 +57,20 @@ public final class CombinatoricsUtils { * <p> * <Strong>Preconditions</strong>: * <ul> - * <li> {@code 0 <= k <= n } (otherwise + * <li> {@code 0 ≤ k ≤ n } (otherwise * {@code MathIllegalArgumentException} is thrown)</li> * <li> The result is small enough to fit into a {@code long}. The * largest value of {@code n} for which all coefficients are * {@code < Long.MAX_VALUE} is 66. If the computed value exceeds - * {@code Long.MAX_VALUE} an {@code ArithMeticException} is + * {@code Long.MAX_VALUE} a {@code MathArithMeticException} is * thrown.</li> * </ul></p> * * @param n the size of the set * @param k the size of the subsets to be counted * @return {@code n choose k} - * @throws NotPositiveException if {@code n < 0}. - * @throws NumberIsTooLargeException if {@code k > n}. + * @throws NotPositiveException if {@code n < 0}. + * @throws NumberIsTooLargeException if {@code k > n}. * @throws MathArithmeticException if the result is too large to be * represented by a long integer. */ @@ -139,7 +139,7 @@ public final class CombinatoricsUtils { * <p> * <Strong>Preconditions</strong>: * <ul> - * <li> {@code 0 <= k <= n } (otherwise + * <li> {@code 0 ≤ k ≤ n } (otherwise * {@code IllegalArgumentException} is thrown)</li> * <li> The result is small enough to fit into a {@code double}. The * largest value of {@code n} for which all coefficients are < @@ -150,8 +150,8 @@ public final class CombinatoricsUtils { * @param n the size of the set * @param k the size of the subsets to be counted * @return {@code n choose k} - * @throws NotPositiveException if {@code n < 0}. - * @throws NumberIsTooLargeException if {@code k > n}. + * @throws NotPositiveException if {@code n < 0}. + * @throws NumberIsTooLargeException if {@code k > n}. * @throws MathArithmeticException if the result is too large to be * represented by a long integer. */ @@ -188,8 +188,8 @@ public final class CombinatoricsUtils { * <p> * <Strong>Preconditions</strong>: * <ul> - * <li> {@code 0 <= k <= n } (otherwise - * {@code IllegalArgumentException} is thrown)</li> + * <li> {@code 0 ≤ k ≤ n } (otherwise + * {@code MathIllegalArgumentException} is thrown)</li> * </ul></p> * * @param n the size of the set @@ -255,12 +255,12 @@ public final class CombinatoricsUtils { * <p> * <Strong>Preconditions</strong>: * <ul> - * <li> {@code n >= 0} (otherwise - * {@code IllegalArgumentException} is thrown)</li> + * <li> {@code n ≥ 0} (otherwise + * {@code MathIllegalArgumentException} is thrown)</li> * <li> The result is small enough to fit into a {@code long}. The - * largest value of {@code n} for which {@code n!} < + * largest value of {@code n} for which {@code n!} does not exceed * Long.MAX_VALUE} is 20. If the computed value exceeds {@code Long.MAX_VALUE} - * an {@code ArithMeticException } is thrown.</li> + * an {@code MathArithMeticException } is thrown.</li> * </ul> * </p> * @@ -268,8 +268,8 @@ public final class CombinatoricsUtils { * @return {@code n!} * @throws MathArithmeticException if the result is too large to be represented * by a {@code long}. - * @throws NotPositiveException if {@code n < 0}. - * @throws MathArithmeticException if {@code n > 20}: The factorial value is too + * @throws NotPositiveException if {@code n < 0}. + * @throws MathArithmeticException if {@code n > 20}: The factorial value is too * large to fit in a {@code long}. */ public static long factorial(final int n) throws NotPositiveException, MathArithmeticException { @@ -288,9 +288,9 @@ public final class CombinatoricsUtils { * factorial</a> of {@code n} (the product of the numbers 1 to n), as a * {@code double}. * The result should be small enough to fit into a {@code double}: The - * largest {@code n} for which {@code n! < Double.MAX_VALUE} is 170. - * If the computed value exceeds {@code Double.MAX_VALUE}, - * {@code Double.POSITIVE_INFINITY} is returned. + * largest {@code n} for which {@code n!} does not exceed + * {@code Double.MAX_VALUE} is 170. If the computed value exceeds + * {@code Double.MAX_VALUE}, {@code Double.POSITIVE_INFINITY} is returned. * * @param n Argument. * @return {@code n!} @@ -312,7 +312,7 @@ public final class CombinatoricsUtils { * * @param n Argument. * @return {@code n!} - * @throws NotPositiveException if {@code n < 0}. + * @throws NotPositiveException if {@code n < 0}. */ public static double factorialLog(final int n) throws NotPositiveException { if (n < 0) { @@ -423,11 +423,11 @@ public final class CombinatoricsUtils { * they are visited in lexicographic order with significance from right to * left. For example, combinationsIterator(4, 2) returns an Iterator that * will generate the following sequence of arrays on successive calls to - * {@code next()}:<br/> + * {@code next()}:</p><p> * {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]} - * </p> + * </p><p> * If {@code k == 0} an Iterator containing an empty array is returned and - * if {@code k == n} an Iterator containing [0, ..., n -1] is returned. + * if {@code k == n} an Iterator containing [0, ..., n -1] is returned.</p> * * @param n Size of the set from which subsets are selected. * @param k Size of the subsets to be enumerated. @@ -444,8 +444,8 @@ public final class CombinatoricsUtils { * * @param n Size of the set. * @param k Size of the subsets to be counted. - * @throws NotPositiveException if {@code n < 0}. - * @throws NumberIsTooLargeException if {@code k > n}. + * @throws NotPositiveException if {@code n < 0}. + * @throws NumberIsTooLargeException if {@code k > n}. */ public static void checkBinomial(final int n, final int k)
