You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ra...@apache.org on 2017/05/13 14:41:12 UTC
[09/15] [math] Fix javadoc issues
Fix javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/7c7a1c2a
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/7c7a1c2a
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/7c7a1c2a
Branch: refs/heads/master
Commit: 7c7a1c2a4f886bcb2a09e21ad9ab7c5b96123d65
Parents: a5b4763
Author: Ray DeCampo <ra...@decampo.org>
Authored: Sat May 13 10:27:35 2017 -0400
Committer: Ray DeCampo <ra...@decampo.org>
Committed: Sat May 13 10:27:35 2017 -0400
----------------------------------------------------------------------
.../java/org/apache/commons/math4/genetics/CycleCrossover.java | 1 -
.../org/apache/commons/math4/genetics/GeneticAlgorithm.java | 4 ++--
src/main/java/org/apache/commons/math4/genetics/RandomKey.java | 2 +-
src/main/java/org/apache/commons/math4/special/Gamma.java | 5 ++---
4 files changed, 5 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-math/blob/7c7a1c2a/src/main/java/org/apache/commons/math4/genetics/CycleCrossover.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/genetics/CycleCrossover.java b/src/main/java/org/apache/commons/math4/genetics/CycleCrossover.java
index 0de8371..1b78ab8 100644
--- a/src/main/java/org/apache/commons/math4/genetics/CycleCrossover.java
+++ b/src/main/java/org/apache/commons/math4/genetics/CycleCrossover.java
@@ -41,7 +41,6 @@ import org.apache.commons.math4.exception.util.LocalizedFormats;
* The indices that form a cycle are then used to form the children in alternating order, i.e.
* in cycle 1, the genes of parent 1 are copied to child 1, while in cycle 2 the genes of parent 1
* are copied to child 2, and so forth ...
- * </p>
*
* Example (zero-start cycle):
* <pre>
http://git-wip-us.apache.org/repos/asf/commons-math/blob/7c7a1c2a/src/main/java/org/apache/commons/math4/genetics/GeneticAlgorithm.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/genetics/GeneticAlgorithm.java b/src/main/java/org/apache/commons/math4/genetics/GeneticAlgorithm.java
index 5dd2be2..24f1e9f 100644
--- a/src/main/java/org/apache/commons/math4/genetics/GeneticAlgorithm.java
+++ b/src/main/java/org/apache/commons/math4/genetics/GeneticAlgorithm.java
@@ -128,7 +128,7 @@ public class GeneticAlgorithm {
* <ol>
* <li>Get nextGeneration population to fill from <code>current</code>
* generation, using its nextGeneration method</li>
- * <li>Loop until new generation is filled:</li>
+ * <li>Loop until new generation is filled:
* <ul><li>Apply configured SelectionPolicy to select a pair of parents
* from <code>current</code></li>
* <li>With probability = {@link #getCrossoverRate()}, apply
@@ -137,7 +137,7 @@ public class GeneticAlgorithm {
* configured {@link MutationPolicy} to each of the offspring</li>
* <li>Add offspring individually to nextGeneration,
* space permitting</li>
- * </ul>
+ * </ul></li>
* <li>Return nextGeneration</li>
* </ol>
*
http://git-wip-us.apache.org/repos/asf/commons-math/blob/7c7a1c2a/src/main/java/org/apache/commons/math4/genetics/RandomKey.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/genetics/RandomKey.java b/src/main/java/org/apache/commons/math4/genetics/RandomKey.java
index ea0a401..fe4b178 100644
--- a/src/main/java/org/apache/commons/math4/genetics/RandomKey.java
+++ b/src/main/java/org/apache/commons/math4/genetics/RandomKey.java
@@ -249,7 +249,7 @@ public abstract class RandomKey<T> extends AbstractListChromosome<Double> implem
* @param originalData the original, unpermuted data
* @param permutedData the data, somehow permuted
* @return representation of a permutation corresponding to the permutation
- * <code>originalData -> permutedData</code>
+ * {@code originalData -> permutedData}
* @throws DimensionMismatchException iff the length of <code>originalData</code>
* and <code>permutedData</code> lists are not equal
* @throws MathIllegalArgumentException iff the <code>permutedData</code> and
http://git-wip-us.apache.org/repos/asf/commons-math/blob/7c7a1c2a/src/main/java/org/apache/commons/math4/special/Gamma.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/special/Gamma.java b/src/main/java/org/apache/commons/math4/special/Gamma.java
index b38ea05..3c4ff97 100644
--- a/src/main/java/org/apache/commons/math4/special/Gamma.java
+++ b/src/main/java/org/apache/commons/math4/special/Gamma.java
@@ -47,7 +47,6 @@ import org.apache.commons.math4.util.FastMath;
* indicates that unless otherwise stated in the code, all FORTRAN functions in
* this library are license free. Since no such notice appears in the code these
* functions can safely be ported to Commons-Math.
- * </p>
*
*/
public class Gamma {
@@ -435,14 +434,14 @@ public class Gamma {
*
* <p>Some of the constants have been changed to increase accuracy at the moderate
* expense of run-time. The result should be accurate to within \( 10^{-8} \)
- * relative tolerance for \( 0 < x < 10^{-5} \) and within \( 10^{-8} \) absolute
+ * relative tolerance for \( 0 \le x \le 10^{-5} \) and within \( 10^{-8} \) absolute
* tolerance otherwise.</p>
*
* @param x Argument.
* @return digamma(x) to within \( 10^{-8} \) relative or absolute error whichever is larger.
*
* @see <a href="http://en.wikipedia.org/wiki/Digamma_function">Digamma</a>
- * @see <a href="http://www.uv.es/~bernardo/1976AppStatist.pdf">Bernardo's original article</a>
+ * @see <a href="http://www.uv.es/~bernardo/1976AppStatist.pdf">Bernardo's original article</a>
*
* @since 2.0
*/