You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2015/09/01 14:43:05 UTC

[1/3] [math] Javadoc.

Repository: commons-math
Updated Branches:
  refs/heads/master 67a7fdc19 -> 1f7b1c12f


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/5f06b728
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/5f06b728
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/5f06b728

Branch: refs/heads/master
Commit: 5f06b728457988135fa86f2a484768914f145a92
Parents: 67a7fdc
Author: Gilles <er...@apache.org>
Authored: Tue Sep 1 14:35:48 2015 +0200
Committer: Gilles <er...@apache.org>
Committed: Tue Sep 1 14:35:48 2015 +0200

----------------------------------------------------------------------
 .../commons/math4/optim/package-info.java       | 24 +++-----------------
 1 file changed, 3 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/5f06b728/src/main/java/org/apache/commons/math4/optim/package-info.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/optim/package-info.java b/src/main/java/org/apache/commons/math4/optim/package-info.java
index f49f3f9..8f3d99c 100644
--- a/src/main/java/org/apache/commons/math4/optim/package-info.java
+++ b/src/main/java/org/apache/commons/math4/optim/package-info.java
@@ -33,27 +33,9 @@
  *
  * <p>
  *  Some problems are solved more efficiently by algorithms that, instead of an
- *  objective function, need access to a
- *  {@link org.apache.commons.math4.optim.nonlinear.vector.ModelFunction
- *  <em>model function</em>}: such a model predicts a set of values which the
- *  algorithm tries to match with a set of given
- *  {@link org.apache.commons.math4.optim.nonlinear.vector.Target target values}.
- *  Those algorithms are located in the
- *  {@link org.apache.commons.math4.optim.nonlinear.vector} package.
- *  <br/>
- *  Algorithms that also require the
- *  {@link org.apache.commons.math4.optim.nonlinear.vector.ModelFunctionJacobian
- *  Jacobian matrix of the model} are located in the
- *  {@link org.apache.commons.math4.optim.nonlinear.vector.jacobian} package.
- *  <br/>
- *  The {@link org.apache.commons.math4.optim.nonlinear.vector.jacobian.AbstractLeastSquaresOptimizer
- *  non-linear least-squares optimizers} are a specialization of the the latter,
- *  that minimize the distance (called <em>cost</em> or <em>&chi;<sup>2</sup></em>)
- *  between model and observations.
- *  <br/>
- *  For cases where the Jacobian cannot be provided, a utility class will
- *  {@link org.apache.commons.math4.optim.nonlinear.scalar.LeastSquaresConverter
- *  convert} a (vector) model into a (scalar) objective function.
+ *  objective function, need access to all the observations.
+ *  Such methods are implemented in the {@link org.apache.commons.math4.fitting}
+ *  package.
  * </p>
  *
  * <p>


[3/3] [math] Javadoc.

Posted by er...@apache.org.
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/1f7b1c12
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/1f7b1c12
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/1f7b1c12

Branch: refs/heads/master
Commit: 1f7b1c12ff7182b40966f10f09584feda76daacd
Parents: ede62af
Author: Gilles <er...@apache.org>
Authored: Tue Sep 1 14:42:32 2015 +0200
Committer: Gilles <er...@apache.org>
Committed: Tue Sep 1 14:42:32 2015 +0200

----------------------------------------------------------------------
 .../commons/math4/analysis/solvers/BaseUnivariateSolver.java     | 4 ++--
 .../java/org/apache/commons/math4/ml/neuralnet/MapUtils.java     | 2 ++
 2 files changed, 4 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/1f7b1c12/src/main/java/org/apache/commons/math4/analysis/solvers/BaseUnivariateSolver.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/analysis/solvers/BaseUnivariateSolver.java b/src/main/java/org/apache/commons/math4/analysis/solvers/BaseUnivariateSolver.java
index d5b90dc..7441029 100644
--- a/src/main/java/org/apache/commons/math4/analysis/solvers/BaseUnivariateSolver.java
+++ b/src/main/java/org/apache/commons/math4/analysis/solvers/BaseUnivariateSolver.java
@@ -28,13 +28,13 @@ import org.apache.commons.math4.exception.TooManyEvaluationsException;
  * This class is not intended for use outside of the Apache Commons Math
  * library, regular user should rely on more specific interfaces like
  * {@link UnivariateSolver}, {@link PolynomialSolver} or {@link
- * DifferentiableUnivariateSolver}.
+ * UnivariateDifferentiableSolver}.
  * @param <FUNC> Type of function to solve.
  *
  * @since 3.0
  * @see UnivariateSolver
  * @see PolynomialSolver
- * @see DifferentiableUnivariateSolver
+ * @see UnivariateDifferentiableSolver
  */
 public interface BaseUnivariateSolver<FUNC extends UnivariateFunction> {
     /**

http://git-wip-us.apache.org/repos/asf/commons-math/blob/1f7b1c12/src/main/java/org/apache/commons/math4/ml/neuralnet/MapUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/MapUtils.java b/src/main/java/org/apache/commons/math4/ml/neuralnet/MapUtils.java
index 6683f25..b8efce1 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/MapUtils.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/MapUtils.java
@@ -123,6 +123,8 @@ public class MapUtils {
      *
      * @see #findBest(double[],Iterable,DistanceMeasure)
      * @see #findBestAndSecondBest(double[],Iterable,DistanceMeasure)
+     *
+     * @since 3.6
      */
     public static Neuron[] sort(double[] features,
                                 Iterable<Neuron> neurons,


[2/3] [math] Javadoc (wrong syntax for "@see" tag).

Posted by er...@apache.org.
Javadoc (wrong syntax for "@see" tag).


Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/ede62afa
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/ede62afa
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/ede62afa

Branch: refs/heads/master
Commit: ede62afa2ca30ae620978cba4db27a83142c0263
Parents: 5f06b72
Author: Gilles <er...@apache.org>
Authored: Tue Sep 1 14:38:37 2015 +0200
Committer: Gilles <er...@apache.org>
Committed: Tue Sep 1 14:38:37 2015 +0200

----------------------------------------------------------------------
 .../commons/math4/analysis/polynomials/PolynomialFunction.java   | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/ede62afa/src/main/java/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.java b/src/main/java/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.java
index 5c8c097..9d40a1b 100644
--- a/src/main/java/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.java
+++ b/src/main/java/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.java
@@ -85,8 +85,8 @@ public class PolynomialFunction implements UnivariateDifferentiableFunction, Ser
      *
      * @param x Argument for which the function value should be computed.
      * @return the value of the polynomial at the given point.
-     * @see {@link org.apache.commons.math4.analysis.UnivariateFunction#value(double)
-     * UnivariateFunction#value(double)}
+     *
+     * @see org.apache.commons.math4.analysis.UnivariateFunction#value(double)
      */
     @Override
     public double value(double x) {