http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/apt/userguide/special.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/userguide/special.apt b/src/site/apt/userguide/special.apt index b3da56d..420e055 100644 --- a/src/site/apt/userguide/special.apt +++ b/src/site/apt/userguide/special.apt @@ -28,7 +28,7 @@ * 5.2 Erf functions - {{{../apidocs/org/apache/commons/math3/special/Erf.html}Erf}} contains + {{{../apidocs/org/apache/commons/math4/special/Erf.html}Erf}} contains several useful functions involving the Error Function, Erf. *----------------+---------+-------------------------------------------------------------------+ @@ -39,7 +39,7 @@ * 5.3 Gamma functions - Class {{{../apidocs/org/apache/commons/math3/special/Gamma.html}<<<Gamma>>>}} + Class {{{../apidocs/org/apache/commons/math4/special/Gamma.html}<<<Gamma>>>}} contains several useful functions involving the Gamma Function. ** Gamma @@ -97,7 +97,7 @@ * 5.4 Beta functions - {{{../apidocs/org/apache/commons/math3/special/Beta.html}Beta}} contains + {{{../apidocs/org/apache/commons/math4/special/Beta.html}Beta}} contains several useful functions involving the Beta Function. ** Log Beta
http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/design/differentiation.puml ---------------------------------------------------------------------- diff --git a/src/site/design/differentiation.puml b/src/site/design/differentiation.puml index 418610c..ce24df7 100644 --- a/src/site/design/differentiation.puml +++ b/src/site/design/differentiation.puml @@ -24,7 +24,7 @@ skinparam NoteFontColor #691616 skinparam ClassFontSize 11 - package org.apache.commons.math3 #ECEBD8 + package org.apache.commons.math4 #ECEBD8 interface "FieldElement<T>" as FieldElement_T_ { T add(T a) http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/design/oneD.puml ---------------------------------------------------------------------- diff --git a/src/site/design/oneD.puml b/src/site/design/oneD.puml index 8e052cd..368e9ab 100644 --- a/src/site/design/oneD.puml +++ b/src/site/design/oneD.puml @@ -24,7 +24,7 @@ skinparam NoteFontColor #691616 skinparam ClassFontSize 11 - package org.apache.commons.math3.geometry #ECEBD8 + package org.apache.commons.math4.geometry #ECEBD8 interface Space { +int getDimension() http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/design/partitioning.puml ---------------------------------------------------------------------- diff --git a/src/site/design/partitioning.puml b/src/site/design/partitioning.puml index e2a356a..dedfe24 100644 --- a/src/site/design/partitioning.puml +++ b/src/site/design/partitioning.puml @@ -24,7 +24,7 @@ skinparam NoteFontColor #691616 skinparam ClassFontSize 11 - package org.apache.commons.math3.geometry #ECEBD8 + package org.apache.commons.math4.geometry #ECEBD8 package partitioning #DDEBD8 http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/design/solver.puml ---------------------------------------------------------------------- diff --git a/src/site/design/solver.puml b/src/site/design/solver.puml index d263a6c..929a46d 100644 --- a/src/site/design/solver.puml +++ b/src/site/design/solver.puml @@ -24,7 +24,7 @@ skinparam NoteFontColor #691616 skinparam ClassFontSize 11 - package org.apache.commons.math3.differentiation.solvers #ECEBD8 + package org.apache.commons.math4.differentiation.solvers #ECEBD8 enum AllowedSolution { ANY_SIDE http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/design/threeD.puml ---------------------------------------------------------------------- diff --git a/src/site/design/threeD.puml b/src/site/design/threeD.puml index 50ac6fe..81daf05 100644 --- a/src/site/design/threeD.puml +++ b/src/site/design/threeD.puml @@ -24,7 +24,7 @@ skinparam NoteFontColor #691616 skinparam ClassFontSize 11 - package org.apache.commons.math3.geometry #ECEBD8 + package org.apache.commons.math4.geometry #ECEBD8 interface Space { +int getDimension() http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/design/twoD.puml ---------------------------------------------------------------------- diff --git a/src/site/design/twoD.puml b/src/site/design/twoD.puml index 35cc6c5..3de2827 100644 --- a/src/site/design/twoD.puml +++ b/src/site/design/twoD.puml @@ -24,7 +24,7 @@ skinparam NoteFontColor #691616 skinparam ClassFontSize 11 - package org.apache.commons.math3.geometry #ECEBD8 + package org.apache.commons.math4.geometry #ECEBD8 interface Space { +int getDimension() http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/proposal.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.xml index c3df6a2..d277c5b 100644 --- a/src/site/xdoc/proposal.xml +++ b/src/site/xdoc/proposal.xml @@ -98,7 +98,7 @@ and mathematical algorithms such as the following: </p> <p>The proposed package name for the new component is -<code>org.apache.commons.math3</code>.</p> +<code>org.apache.commons.math</code>.</p> </subsection> <subsection name='(3) Required Jakarta-Commons Resources'> http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/analysis.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/analysis.xml b/src/site/xdoc/userguide/analysis.xml index 90187ac..58a854f 100644 --- a/src/site/xdoc/userguide/analysis.xml +++ b/src/site/xdoc/userguide/analysis.xml @@ -89,13 +89,13 @@ </subsection> <subsection name="4.3 Root-finding" href="rootfinding"> <p> - <a href="../apidocs/org/apache/commons/math3/analysis/solvers/UnivariateSolver.html"> - UnivariateSolver</a>, <a href="../apidocs/org/apache/commons/math3/analysis/solvers/UnivariateDifferentiableSolver.html"> - UnivariateDifferentiableSolver</a> and <a href="../apidocs/org/apache/commons/math3/analysis/solvers/PolynomialSolver.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/solvers/UnivariateSolver.html"> + UnivariateSolver</a>, <a href="../apidocs/org/apache/commons/math4/analysis/solvers/UnivariateDifferentiableSolver.html"> + UnivariateDifferentiableSolver</a> and <a href="../apidocs/org/apache/commons/math4/analysis/solvers/PolynomialSolver.html"> PolynomialSolver</a> provide means to find roots of - <a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a>, - <a href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiable.html">differentiable univariate real-valued functions</a>, - and <a href="../apidocs/org/apache/commons/math3/analysis/polynomials/PolynomialFunction.html">polynomial functions</a> respectively. + <a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a>, + <a href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateDifferentiable.html">differentiable univariate real-valued functions</a>, + and <a href="../apidocs/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.html">polynomial functions</a> respectively. A root is the value where the function takes the value 0. Commons-Math includes implementations of the several root-finding algorithms: </p> @@ -103,85 +103,85 @@ <tr BGCOLOR="#CCCCFF"><td colspan="5"><font size="+1">Root solvers</font></td></tr> <tr BGCOLOR="#EEEEFF"><font size="+1"><td>Name</td><td>Function type</td><td>Convergence</td><td>Needs initial bracketing</td><td>Bracket side selection</td></font></tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/BisectionSolver.html">Bisection</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/BisectionSolver.html">Bisection</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>linear, guaranteed</td> <td>yes</td> <td>yes</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/BrentSolver.html">Brent-Dekker</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/BrentSolver.html">Brent-Dekker</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>super-linear, guaranteed</td> <td>yes</td> <td>no</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/BracketingNthOrderBrentSolver.html">bracketing n<sup>th</sup> order Brent</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/BracketingNthOrderBrentSolver.html">bracketing n<sup>th</sup> order Brent</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>variable order, guaranteed</td> <td>yes</td> <td>yes</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/IllinoisSolver.html">Illinois Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/IllinoisSolver.html">Illinois Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>super-linear, guaranteed</td> <td>yes</td> <td>yes</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/LaguerreSolver.html">Laguerre's Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/polynomials/PolynomialFunction.html">polynomial functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/LaguerreSolver.html">Laguerre's Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.html">polynomial functions</a></td> <td>cubic for simple root, linear for multiple root</td> <td>yes</td> <td>no</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/MullerSolver.html">Muller's Method</a> using bracketing to deal with real-valued functions</td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/MullerSolver.html">Muller's Method</a> using bracketing to deal with real-valued functions</td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>quadratic close to roots</td> <td>yes</td> <td>no</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/MullerSolver2.html">Muller's Method</a> using modulus to deal with real-valued functions</td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/MullerSolver2.html">Muller's Method</a> using modulus to deal with real-valued functions</td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>quadratic close to root</td> <td>yes</td> <td>no</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/NewtonRaphsonSolver.html">Newton-Raphson's Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableFunction.html">differentiable univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/NewtonRaphsonSolver.html">Newton-Raphson's Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateDifferentiableFunction.html">differentiable univariate real-valued functions</a></td> <td>quadratic, non-guaranteed</td> <td>no</td> <td>no</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/PegasusSolver.html">Pegasus Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/PegasusSolver.html">Pegasus Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>super-linear, guaranteed</td> <td>yes</td> <td>yes</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/RegulaFalsiSolver.html">Regula Falsi (false position) Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/RegulaFalsiSolver.html">Regula Falsi (false position) Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>linear, guaranteed</td> <td>yes</td> <td>yes</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/RiddersSolver.html">Ridder's Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/RiddersSolver.html">Ridder's Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>super-linear</td> <td>yes</td> <td>no</td> </tr> <tr> - <td><a href="../apidocs/org/apache/commons/math3/analysis/solvers/SecantSolver.html">Secant Method</a></td> - <td><a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/solvers/SecantSolver.html">Secant Method</a></td> + <td><a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">univariate real-valued functions</a></td> <td>super-linear, non-guaranteed</td> <td>yes</td> <td>no</td> @@ -237,9 +237,9 @@ ill-conditioned problems is to be solved, this number can be decreased in order to avoid wasting time. <a - href="../apidocs/org/apache/commons/math3/analysis/solvers/BracketedUnivariateSolver.html">Bracketed + href="../apidocs/org/apache/commons/math4/analysis/solvers/BracketedUnivariateSolver.html">Bracketed solvers</a> also take an <a - href="../apidocs/org/apache/commons/math3/analysis/solvers/AllowedSolution.html">allowed solution</a> + href="../apidocs/org/apache/commons/math4/analysis/solvers/AllowedSolution.html">allowed solution</a> enum parameter to specify which side of the final convergence interval should be selected as the root. It can be <code>ANY_SIDE</code>, <code>LEFT_SIDE</code>, <code>RIGHT_SIDE</code>, <code>BELOW_SIDE</code> or <code>ABOVE_SIDE</code>. Left and right are used to specify the root along @@ -373,13 +373,13 @@ double c = UnivariateSolverUtils.forceSide(100, function, </subsection> <subsection name="4.4 Interpolation" href="interpolation"> <p> - A <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/UnivariateInterpolator.html"> + A <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/UnivariateInterpolator.html"> UnivariateInterpolator</a> is used to find a univariate real-valued function <code>f</code> which for a given set of ordered pairs (<code>x<sub>i</sub></code>,<code>y<sub>i</sub></code>) yields <code>f(x<sub>i</sub>)=y<sub>i</sub></code> to the best accuracy possible. The result is provided as an object implementing the <a - href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html"> + href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html"> UnivariateFunction</a> interface. It can therefore be evaluated at any point, including point not belonging to the original set. Currently, only an interpolator for generating natural cubic splines and a polynomial @@ -436,7 +436,7 @@ System.out println("f(" + interpolationX + ") = " + interpolatedY);</source> <p> <a href="http://en.wikipedia.org/wiki/Hermite_interpolation";>Hermite interpolation</a> is an interpolation method that can use derivatives in addition to function values at sample points. The <a - href="../apidocs/org/apache/commons/math3/analysis/interpolation/HermiteInterpolator.html">HermiteInterpolator</a> + href="../apidocs/org/apache/commons/math4/analysis/interpolation/HermiteInterpolator.html">HermiteInterpolator</a> class implements this method for vector-valued functions. The sampling points can have any spacing (there are no requirements for a regular grid) and some points may provide derivatives while others don't provide them (or provide derivatives to a smaller order). Points are added one at a time, as shown in the following example: @@ -455,13 +455,13 @@ System.out.println("derivative at x = 0.5: " + interpolator.derivative(0.5)[0]); // should print "interpolation polynomial: 1 + 2 x + 4 x^2 - 4 x^3 + x^4" System.out.println("interpolation polynomial: " + interpolator.getPolynomials()[0]);</source> <p> - A <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/BivariateGridInterpolator.html"> + A <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/BivariateGridInterpolator.html"> BivariateGridInterpolator</a> is used to find a bivariate real-valued function <code>f</code> which for a given set of tuples (<code>x<sub>i</sub></code>,<code>y<sub>j</sub></code>,<code>f<sub>ij</sub></code>) yields <code>f(x<sub>i</sub>,y<sub>j</sub>)=f<sub>ij</sub></code> to the best accuracy possible. The result is provided as an object implementing the - <a href="../apidocs/org/apache/commons/math3/analysis/BivariateFunction.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/BivariateFunction.html"> BivariateFunction</a> interface. It can therefore be evaluated at any point, including a point not belonging to the original set. The arrays <code>x<sub>i</sub></code> and <code>y<sub>j</sub></code> must be @@ -473,25 +473,25 @@ System.out.println("interpolation polynomial: " + interpolator.getPolynomials()[ are computed from the function values sampled on a grid, as well as the values of the partial derivatives of the function at those grid points. From two-dimensional data sampled on a grid, the - <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolator.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/BicubicSplineInterpolator.html"> BicubicSplineInterpolator</a> computes a - <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolatingFunction.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/BicubicSplineInterpolatingFunction.html"> bicubic interpolating function</a>. Prior to computing an interpolating function, the - <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/SmoothingPolynomialBicubicSplineInterpolator.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/SmoothingPolynomialBicubicSplineInterpolator.html"> SmoothingPolynomialBicubicSplineInterpolator</a> class performs smoothing of the data by computing the polynomial that best fits each of the one-dimensional curves along each of the coordinate axes. </p> <p> - A <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/TrivariateGridInterpolator.html"> + A <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/TrivariateGridInterpolator.html"> TrivariateGridInterpolator</a> is used to find a trivariate real-valued function <code>f</code> which for a given set of tuples (<code>x<sub>i</sub></code>,<code>y<sub>j</sub></code>,<code>z<sub>k</sub></code>, <code>f<sub>ijk</sub></code>) yields <code>f(x<sub>i</sub>,y<sub>j</sub>,z<sub>k</sub>)=f<sub>ijk</sub></code> to the best accuracy possible. The result is provided as an object implementing the - <a href="../apidocs/org/apache/commons/math3/analysis/TrivariateFunction.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/TrivariateFunction.html"> TrivariateFunction</a> interface. It can therefore be evaluated at any point, including a point not belonging to the original set. The arrays <code>x<sub>i</sub></code>, <code>y<sub>j</sub></code> and @@ -504,41 +504,41 @@ System.out.println("interpolation polynomial: " + interpolator.getPolynomials()[ are computed from the function values sampled on a grid, as well as the values of the partial derivatives of the function at those grid points. From three-dimensional data sampled on a grid, the - <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/TricubicSplineInterpolator.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/TricubicSplineInterpolator.html"> TricubicSplineInterpolator</a> computes a - <a href="../apidocs/org/apache/commons/math3/analysis/interpolation/TricubicSplineInterpolatingFunction.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/interpolation/TricubicSplineInterpolatingFunction.html"> tricubic interpolating function</a>. </p> </subsection> <subsection name="4.5 Integration" href="integration"> <p> - A <a href="../apidocs/org/apache/commons/math3/analysis/integration/UnivariateIntegrator.html"> + A <a href="../apidocs/org/apache/commons/math4/analysis/integration/UnivariateIntegrator.html"> UnivariateIntegrator</a> provides the means to numerically integrate - <a href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html"> univariate real-valued functions</a>. Commons-Math includes implementations of the following integration algorithms: <ul> - <li><a href="../apidocs/org/apache/commons/math3/analysis/integration/RombergIntegrator.html"> + <li><a href="../apidocs/org/apache/commons/math4/analysis/integration/RombergIntegrator.html"> Romberg's method</a></li> - <li><a href="../apidocs/org/apache/commons/math3/analysis/integration/SimpsonIntegrator.html"> + <li><a href="../apidocs/org/apache/commons/math4/analysis/integration/SimpsonIntegrator.html"> Simpson's method</a></li> - <li><a href="../apidocs/org/apache/commons/math3/analysis/integration/TrapezoidIntegrator.html"> + <li><a href="../apidocs/org/apache/commons/math4/analysis/integration/TrapezoidIntegrator.html"> trapezoid method</a></li> - <li><a href="../apidocs/org/apache/commons/math3/analysis/integration/LegendreGaussIntegrator.html"> + <li><a href="../apidocs/org/apache/commons/math4/analysis/integration/LegendreGaussIntegrator.html"> Legendre-Gauss method</a></li> </ul> </p> </subsection> <subsection name="4.6 Polynomials" href="polynomials"> <p> - The <a href="../apidocs/org/apache/commons/math3/analysis/polynomials/package-summary.html"> - org.apache.commons.math3.analysis.polynomials</a> package provides real + The <a href="../apidocs/org/apache/commons/math4/analysis/polynomials/package-summary.html"> + org.apache.commons.math4.analysis.polynomials</a> package provides real coefficients polynomials. </p> <p> - The <a href="../apidocs/org/apache/commons/math3/analysis/polynomials/PolynomialFunction.html"> + The <a href="../apidocs/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.html"> PolynomialFunction</a> class is the most general one, using traditional coefficients arrays. The - <a href="../apidocs/org/apache/commons/math3/analysis/polynomials/PolynomialsUtils.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/polynomials/PolynomialsUtils.html"> PolynomialsUtils</a> utility class provides static factory methods to build Chebyshev, Hermite, Jacobi, Laguerre and Legendre polynomials. Coefficients are computed using exact fractions so these factory methods can build polynomials @@ -547,21 +547,21 @@ System.out.println("interpolation polynomial: " + interpolator.getPolynomials()[ </subsection> <subsection name="4.7 Differentiation" href="differentiation"> <p> - The <a href="../apidocs/org/apache/commons/math3/analysis/differentiation/package-summary.html"> - org.apache.commons.math3.analysis.differentiation</a> package provides a general-purpose + The <a href="../apidocs/org/apache/commons/math4/analysis/differentiation/package-summary.html"> + org.apache.commons.math4.analysis.differentiation</a> package provides a general-purpose differentiation framework. </p> <p> - The core class is <a href="../apidocs/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.html"> + The core class is <a href="../apidocs/org/apache/commons/math4/analysis/differentiation/DerivativeStructure.html"> DerivativeStructure</a> which holds the value and the differentials of a function. This class handles some arbitrary number of free parameters and arbitrary derivation order. It is used both as the input and the output type for the <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableFunction.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateDifferentiableFunction.html"> UnivariateDifferentiableFunction</a> interface. Any differentiable function should implement this interface. </p> <p> - The main idea behind the <a href="../apidocs/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.html"> + The main idea behind the <a href="../apidocs/org/apache/commons/math4/analysis/differentiation/DerivativeStructure.html"> DerivativeStructure</a> class is that it can be used almost as a number (i.e. it can be added, multiplied, its square root can be extracted or its cosine computed... However, in addition to computed the value itself when doing these computations, the partial derivatives are also computed @@ -578,7 +578,7 @@ System.out.println("interpolation polynomial: " + interpolator.getPolynomials()[ <p> The workflow of computation of a derivatives of an expression <code>y=f(x)</code> is the following one. First we configure an input parameter <code>x</code> of type <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/DerivativeStructure.html"> DerivativeStructure</a> so it will drive the function to compute all derivatives up to order 3 for example. Then we compute <code>y=f(x)</code> normally by passing this parameter to the f function.At the end, we extract from <code>y</code> the value and the derivatives we want. As we have specified @@ -668,28 +668,28 @@ System.out.println("d2g/dxdy = " + g.getPartialDerivative(1, 1); System.out.println("d2g/dy2 = " + g.getPartialDerivative(0, 2);</source> <p> There are several ways a user can create an implementation of the <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableFunction.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateDifferentiableFunction.html"> UnivariateDifferentiableFunction</a> interface. The first method is to simply write it directly using - the appropriate methods from <a href="../apidocs/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.html"> + the appropriate methods from <a href="../apidocs/org/apache/commons/math4/analysis/differentiation/DerivativeStructure.html"> DerivativeStructure</a> to compute addition, subtraction, sine, cosine... This is often quite straigthforward and there is no need to remember the rules for differentiation: the user code only represent the function itself, the differentials will be computed automatically under the hood. The second method is to write a classical <a - href="../apidocs/org/apache/commons/math3/analysis/UnivariateFunction.html">UnivariateFunction</a> and to + href="../apidocs/org/apache/commons/math4/analysis/UnivariateFunction.html">UnivariateFunction</a> and to pass it to an existing implementation of the <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateFunctionDifferentiator.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateFunctionDifferentiator.html"> UnivariateFunctionDifferentiator</a> interface to retrieve a differentiated version of the same function. The first method is more suited to small functions for which user already control all the underlying code. The second method is more suited to either large functions that would be cumbersome to write using the - <a href="../apidocs/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/differentiation/DerivativeStructure.html"> DerivativeStructure</a> API, or functions for which user does not have control to the full underlying code (for example functions that call external libraries). </p> <p> Apache Commons Math provides one implementation of the <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateFunctionDifferentiator.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateFunctionDifferentiator.html"> UnivariateFunctionDifferentiator</a> interface: <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/FiniteDifferencesDifferentiator.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/FiniteDifferencesDifferentiator.html"> FiniteDifferencesDifferentiator</a>. This class creates a wrapper that will call the user-provided function on a grid sample and will use finite differences to compute the derivatives. It takes care of boundaries if the variable is not defined on the whole real line. It is possible to use more points than strictly @@ -700,7 +700,7 @@ System.out.println("d2g/dy2 = " + g.getPartialDerivative(0, 2);</source> </p> <p> Another implementation of the <a - href="../apidocs/org/apache/commons/math3/analysis/differentiation/UnivariateFunctionDifferentiator.html"> + href="../apidocs/org/apache/commons/math4/analysis/differentiation/UnivariateFunctionDifferentiator.html"> UnivariateFunctionDifferentiator</a> interface is under development in the related project <a href="http://commons.apache.org/sandbox/nabla/";>Apache Commons Nabla</a>. This implementation uses automatic code analysis and generation at binary level. However, at time of writing http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/complex.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/complex.xml b/src/site/xdoc/userguide/complex.xml index fa4a95e..f451ab1 100644 --- a/src/site/xdoc/userguide/complex.xml +++ b/src/site/xdoc/userguide/complex.xml @@ -33,7 +33,7 @@ </subsection> <subsection name="7.2 Complex Numbers" href="complex"> <p> - <a href="../apidocs/org/apache/commons/math3/complex/Complex.html"> + <a href="../apidocs/org/apache/commons/math4/complex/Complex.html"> Complex</a> provides a complex number type that forms the basis for the complex functionality found in commons-math. </p> @@ -44,9 +44,9 @@ handling infinite and <code>NaN</code> values. No attempt is made to comply with ANSII/IEC C99x Annex G or any other standard for Complex arithmetic. See the class and method javadocs for the - <a href="../apidocs/org/apache/commons/math3/complex/Complex.html"> + <a href="../apidocs/org/apache/commons/math4/complex/Complex.html"> Complex</a> and - <a href="../apidocs/org/apache/commons/math3/complex/ComplexUtils.html"> + <a href="../apidocs/org/apache/commons/math4/complex/ComplexUtils.html"> ComplexUtils</a> classes for details on computing formulas. </p> <p> @@ -77,7 +77,7 @@ Complex answer = lhs.add(rhs); // add two complex numbers </subsection> <subsection name="7.3 Complex Transcendental Functions" href="function"> <p> - <a href="../apidocs/org/apache/commons/math3/complex/Complex.html"> + <a href="../apidocs/org/apache/commons/math4/complex/Complex.html"> Complex</a> also provides implementations of serveral transcendental functions involving complex number arguments. These operations provide the means to compute the log, sine, tangent, @@ -93,7 +93,7 @@ Complex answer = first.log(); // natural logarithm. <subsection name="7.4 Complex Formatting and Parsing" href="formatting"> <p> <code>Complex</code> instances can be converted to and from strings - using the<a href="../apidocs/org/apache/commons/math3/complex/ComplexFormat.html"> + using the<a href="../apidocs/org/apache/commons/math4/complex/ComplexFormat.html"> ComplexFormat</a> class. <code>ComplexFormat</code> is a <code>java.text.Format</code> extension and, as such, is used like other formatting objects (e.g. http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/distribution.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/distribution.xml b/src/site/xdoc/userguide/distribution.xml index 2fc4605..6fa61f8 100644 --- a/src/site/xdoc/userguide/distribution.xml +++ b/src/site/xdoc/userguide/distribution.xml @@ -28,14 +28,14 @@ <p> The distributions package provides a framework and implementations for some commonly used probability distributions. Continuous univariate distributions are represented by implementations of - the <a href="../apidocs/org/apache/commons/math3/distribution/RealDistribution.html">RealDistribution</a> + the <a href="../apidocs/org/apache/commons/math4/distribution/RealDistribution.html">RealDistribution</a> interface. Discrete distributions implement - <a href="../apidocs/org/apache/commons/math3/distribution/IntegerDistribution.html">IntegerDistribution</a> + <a href="../apidocs/org/apache/commons/math4/distribution/IntegerDistribution.html">IntegerDistribution</a> (values must be mapped to integers) and there is an - <a href="../apidocs/org/apache/commons/math3/distribution/EnumeratedDistribution.html">EnumeratedDistribution</a> + <a href="../apidocs/org/apache/commons/math4/distribution/EnumeratedDistribution.html">EnumeratedDistribution</a> class representing discrete distributions with a finite, enumerated set of values. Finally, multivariate real-valued distributions can be represented via the - <a href="../apidocs/org/apache/commons/math3/distribution/MultiVariateRealDistribution.html">MultivariateRealDistribution</a> + <a href="../apidocs/org/apache/commons/math4/distribution/MultiVariateRealDistribution.html">MultivariateRealDistribution</a> interface. </p> <p> @@ -74,7 +74,7 @@ double upperTail = 1.0 - t.cumulativeProbability(2.75); // P(T(29) >= 2.75)</ <p> All distributions implement a <code>sample()</code> method to support random sampling from the distribution. Implementation classes expose constructors allowing the default - <a href="../apidocs/org/apache/commons/math3/random/RandomGenerator.html">RandomGenerator</a> + <a href="../apidocs/org/apache/commons/math4/random/RandomGenerator.html">RandomGenerator</a> used by the sampling algorithm to be overridden. If sampling is not going to be used, providing a null <code>RandomGenerator</code> constructor argument will avoid the overhead of initializing the default generator. @@ -98,14 +98,14 @@ double upperTail = 1.0 - t.cumulativeProbability(2.75); // P(T(29) >= 2.75)</ <subsection name="8.3 User Defined Distributions" href="userdefined"> <p> User-defined distributions can be implemented using - <a href="../apidocs/org/apache/commons/math3/distribution/RealDistribution.html">RealDistribution</a>, - <a href="../apidocs/org/apache/commons/math3/distribution/IntegerDistribution.html">IntegerDistribution</a> and - <a href="../apidocs/org/apache/commons/math3/distribution/MultivariateRealDistribution.html">MultivariateRealDistribution</a> + <a href="../apidocs/org/apache/commons/math4/distribution/RealDistribution.html">RealDistribution</a>, + <a href="../apidocs/org/apache/commons/math4/distribution/IntegerDistribution.html">IntegerDistribution</a> and + <a href="../apidocs/org/apache/commons/math4/distribution/MultivariateRealDistribution.html">MultivariateRealDistribution</a> interfaces serve as base types. These serve as the basis for all the distributions directly supported by Apache Commons Math. To aid in implementing distributions, - the <a href="../apidocs/org/apache/commons/math3/distribution/AbstractRealDistribution.html">AbstractRealDistribution</a>, - <a href="../apidocs/org/apache/commons/math3/distribution/AbstractIntegerDistribution.html">AbstractIntegerDistribution</a> and - <a href="../apidocs/org/apache/commons/math3/distribution/AbstractMultivariateRealDistribution.html">AbstractMultivariateRealDistribution</a> + the <a href="../apidocs/org/apache/commons/math4/distribution/AbstractRealDistribution.html">AbstractRealDistribution</a>, + <a href="../apidocs/org/apache/commons/math4/distribution/AbstractIntegerDistribution.html">AbstractIntegerDistribution</a> and + <a href="../apidocs/org/apache/commons/math4/distribution/AbstractMultivariateRealDistribution.html">AbstractMultivariateRealDistribution</a> provide implementation building blocks and offer basic distribution functionality. By extending these abstract classes directly, much of the repetitive distribution implementation is already developed and should save time and effort in developing http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/exceptions.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/exceptions.xml b/src/site/xdoc/userguide/exceptions.xml index 55dabf0..d16781a 100644 --- a/src/site/xdoc/userguide/exceptions.xml +++ b/src/site/xdoc/userguide/exceptions.xml @@ -54,28 +54,28 @@ <li> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html";> <code>IllegalArgumentException</code></a>: - A <a href="../apidocs/org/apache/commons/math3/exception/MathIllegalArgumentException.html"> + A <a href="../apidocs/org/apache/commons/math4/exception/MathIllegalArgumentException.html"> <code>MathIllegalArgumentException</code></a> is thrown when some input parameter fails a precondition check. </li> <li> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html";> <code>IllegalStateException</code></a>: - A <a href="../apidocs/org/apache/commons/math3/exception/MathIllegalStateException.html"> + A <a href="../apidocs/org/apache/commons/math4/exception/MathIllegalStateException.html"> <code>MathIllegalStateException</code></a> is thrown when some inconsistency has been detected. </li> <li> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/MathArithmeticException.html";> <code>ArithmeticException</code></a>: - A <a href="../apidocs/org/apache/commons/math3/exception/MathArithmeticException.html"> + A <a href="../apidocs/org/apache/commons/math4/exception/MathArithmeticException.html"> <code>MathArithmeticException</code></a> is thrown when conditions such as "division by zero" or "overflow" are encountered. </li> <li> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/MathUnsupportedOperationException.html";> <code>UnsupportedOperationException</code></a>: - A <a href="../apidocs/org/apache/commons/math3/exception/MathUnsupportedOperationException.html"> + A <a href="../apidocs/org/apache/commons/math4/exception/MathUnsupportedOperationException.html"> <code>MathUnsupportedOperationException</code></a> indicates that a feature is missing or does not make sense in the given context. </li> @@ -102,11 +102,11 @@ <li>Exception "context" <p> Every exception generated by Commons Math implements the - <a href="../apidocs/org/apache/commons/math3/exception/util/ExceptionContextProvider.html"> + <a href="../apidocs/org/apache/commons/math4/exception/util/ExceptionContextProvider.html"> ExceptionContextProvider</a> interface. A call to the - <a href="../apidocs/org/apache/commons/math3/exception/util/ExceptionContextProvider.html#getContext()"> + <a href="../apidocs/org/apache/commons/math4/exception/util/ExceptionContextProvider.html#getContext()"> getContext</a> method will return the - <a href="../apidocs/org/apache/commons/math3/exception/util/ExceptionContext.html"> + <a href="../apidocs/org/apache/commons/math4/exception/util/ExceptionContext.html"> ExceptionContext</a> instance stored in the exception, which the user can further customize by adding messages and/or any object. </p> http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/filter.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/filter.xml b/src/site/xdoc/userguide/filter.xml index c1919af..a241bea 100644 --- a/src/site/xdoc/userguide/filter.xml +++ b/src/site/xdoc/userguide/filter.xml @@ -31,12 +31,12 @@ </subsection> <subsection name="15.2 Kalman Filter" href="kalman"> <p> - <a href="../apidocs/org/apache/commons/math3/filter/KalmanFilter.html"> + <a href="../apidocs/org/apache/commons/math4/filter/KalmanFilter.html"> KalmanFilter</a> provides a discrete-time filter to estimate a stochastic linear process.</p> - <p>A Kalman filter is initialized with a <a href="../apidocs/org/apache/commons/math3/filter/ProcessModel.html"> - ProcessModel</a> and a <a href="../apidocs/org/apache/commons/math3/filter/MeasurementModel.html"> + <p>A Kalman filter is initialized with a <a href="../apidocs/org/apache/commons/math4/filter/ProcessModel.html"> + ProcessModel</a> and a <a href="../apidocs/org/apache/commons/math4/filter/MeasurementModel.html"> MeasurementModel</a>, which contain the corresponding transformation and noise covariance matrices. The parameter names used in the respective models correspond to the following names commonly used in the mathematical literature: http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/fitting.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/fitting.xml b/src/site/xdoc/userguide/fitting.xml index 2e38b20..c7c8bb1 100644 --- a/src/site/xdoc/userguide/fitting.xml +++ b/src/site/xdoc/userguide/fitting.xml @@ -47,15 +47,15 @@ appropriate class, </li> <li> - call the <a href="../apidocs/org/apache/commons/math3/fitting/AbstractCurveFitter">fit</a> - with a <code>Collection</code> of <a href="../apidocs/org/apache/commons/math3/fitting/WeightedObservedPoint.html"> + call the <a href="../apidocs/org/apache/commons/math4/fitting/AbstractCurveFitter">fit</a> + with a <code>Collection</code> of <a href="../apidocs/org/apache/commons/math4/fitting/WeightedObservedPoint.html"> observed data points</a> as argument, which will return an array with the parameters that best fit the given data points. </li> </ul> The list of observed data points to be passed to <code>fit</code> can be built by incrementally - adding instances to an instance of <a href="../apidocs/org/apache/commons/math3/fitting/WeightedObservedPoints.html">WeightedObservedPoints</a>, + adding instances to an instance of <a href="../apidocs/org/apache/commons/math4/fitting/WeightedObservedPoints.html">WeightedObservedPoints</a>, and then retrieve the list of <code>WeightedObservedPoint</code> by calling the <code>toList</code> method on that container. A weight can be associated with each observed point; it allows to take into account uncertainty @@ -82,25 +82,25 @@ Fitting of specific functions are provided through the following classes: <ul> <li> - <a href="../apidocs/org/apache/commons/math3/fitting/PolynomialCurveFitter.html"> + <a href="../apidocs/org/apache/commons/math4/fitting/PolynomialCurveFitter.html"> PolynomialFitter</a> fits a - <a href="../apidocs/org/apache/commons/math3/analysis/polynomials/PolynomialFunction.Parametric.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/polynomials/PolynomialFunction.Parametric.html"> polynomial</a> function. </li> <li> - <a href="../apidocs/org/apache/commons/math3/fitting/HarmonicCurveFitter.html"> + <a href="../apidocs/org/apache/commons/math4/fitting/HarmonicCurveFitter.html"> HarmonicFitter</a> fits a - <a href="../apidocs/org/apache/commons/math3/analysis/function/HarmonicOscillator.Parametric.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/function/HarmonicOscillator.Parametric.html"> harmonic</a> function. - An instance of the inner class <a href="../apidocs/org/apache/commons/math3/fitting/HarmonicCurveFitter.ParameterGuesser.html"> + An instance of the inner class <a href="../apidocs/org/apache/commons/math4/fitting/HarmonicCurveFitter.ParameterGuesser.html"> ParameterGuesser</a> can be used to retrieve initial values for the fitting procedure. </li> <li> - <a href="../apidocs/org/apache/commons/math3/fitting/GaussianCurveFitter.html"> + <a href="../apidocs/org/apache/commons/math4/fitting/GaussianCurveFitter.html"> GaussianFitter</a> fits a - <a href="../apidocs/org/apache/commons/math3/analysis/function/Gaussian.Parametric.html"> + <a href="../apidocs/org/apache/commons/math4/analysis/function/Gaussian.Parametric.html"> Gaussian</a> function. - An instance of the inner class <a href="../apidocs/org/apache/commons/math3/fitting/GaussianCurveFitter.ParameterGuesser.html"> + An instance of the inner class <a href="../apidocs/org/apache/commons/math4/fitting/GaussianCurveFitter.ParameterGuesser.html"> ParameterGuesser</a> can be used to retrieve initial values for the fitting procedure. </li> </ul> @@ -130,11 +130,11 @@ final double[] coeff = fitter.fit(obs.toList()); <subsection name="17.3 General Case" href="general"> <p> - The <a href="../apidocs/org/apache/commons/math3/fitting/AbstractCurveFitter.html"> + The <a href="../apidocs/org/apache/commons/math4/fitting/AbstractCurveFitter.html"> AbstractCurveFitter</a> class provides the basic functionality for implementing other curve fitting classes. Users must provide their own implementation of the curve template as a class that implements - the <a href="../apidocs/org/apache/commons/math3/analysis/ParametricUnivariateFunction.html"> + the <a href="../apidocs/org/apache/commons/math4/analysis/ParametricUnivariateFunction.html"> ParametricUnivariateFunction</a> interface. </p> </subsection> http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/fraction.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/fraction.xml b/src/site/xdoc/userguide/fraction.xml index beb96d3..3f8ae51 100644 --- a/src/site/xdoc/userguide/fraction.xml +++ b/src/site/xdoc/userguide/fraction.xml @@ -32,8 +32,8 @@ </subsection> <subsection name="9.2 Fraction Numbers" href="fraction"> <p> - <a href="../apidocs/org/apache/commons/math3/fraction/Fraction.html"> - Fraction</a> and <a href="../apidocs/org/apache/commons/math3/fraction/BigFraction.html"> + <a href="../apidocs/org/apache/commons/math4/fraction/Fraction.html"> + Fraction</a> and <a href="../apidocs/org/apache/commons/math4/fraction/BigFraction.html"> BigFraction</a> provide fraction number type that forms the basis for the fraction functionality found in Commons-Math. The former one can be used for fractions whose numerators and denominators are small enough @@ -70,7 +70,7 @@ Fraction answer = lhs.add(rhs); // add two fractions <subsection name="9.3 Fraction Formatting and Parsing" href="formatting"> <p> <code>Fraction</code> instances can be converted to and from strings - using the<a href="../apidocs/org/apache/commons/math3/fraction/FractionFormat.html"> + using the<a href="../apidocs/org/apache/commons/math4/fraction/FractionFormat.html"> FractionFormat</a> class. <code>FractionFormat</code> is a <code>java.text.Format</code> extension and, as such, is used like other formatting objects (e.g. <code>java.text.SimpleDateFormat</code>): http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/genetics.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/genetics.xml b/src/site/xdoc/userguide/genetics.xml index ed29867..49fb749 100644 --- a/src/site/xdoc/userguide/genetics.xml +++ b/src/site/xdoc/userguide/genetics.xml @@ -32,15 +32,15 @@ </subsection> <subsection name="14.2 GA Framework"> <p> - <a href="../apidocs/org/apache/commons/math3/genetics/GeneticAlgorithm.html"> + <a href="../apidocs/org/apache/commons/math4/genetics/GeneticAlgorithm.html"> GeneticAlgorithm</a> provides an execution framework for Genetic Algorithms (GA). - <a href="../apidocs/org/apache/commons/math3/genetics/Population.html"> - Populations,</a> consisting of <a href="../apidocs/org/apache/commons/math3/genetics/Chromosome.html"> + <a href="../apidocs/org/apache/commons/math4/genetics/Population.html"> + Populations,</a> consisting of <a href="../apidocs/org/apache/commons/math4/genetics/Chromosome.html"> Chromosomes</a> are evolved by the <code>GeneticAlgorithm</code> until a - <a href="../apidocs/org/apache/commons/math3/genetics/StoppingCondition.html"> - StoppingCondition</a> is reached. Evolution is determined by <a href="../apidocs/org/apache/commons/math3/genetics/SelectionPolicy.html"> - SelectionPolicy</a>, <a href="../apidocs/org/apache/commons/math3/genetics/MutationPolicy.html"> - MutationPolicy</a> and <a href="../apidocs/org/apache/commons/math3/genetics/Fitness.html"> + <a href="../apidocs/org/apache/commons/math4/genetics/StoppingCondition.html"> + StoppingCondition</a> is reached. Evolution is determined by <a href="../apidocs/org/apache/commons/math4/genetics/SelectionPolicy.html"> + SelectionPolicy</a>, <a href="../apidocs/org/apache/commons/math4/genetics/MutationPolicy.html"> + MutationPolicy</a> and <a href="../apidocs/org/apache/commons/math4/genetics/Fitness.html"> Fitness</a>. </p> <p> @@ -63,10 +63,10 @@ <ul><li>Apply configured <code>SelectionPolicy</code> to select a pair of parents from <code>current</code></li> <li>With probability = - <a href="../apidocs/org/apache/commons/math3/genetics/GeneticAlgorithm.html#getCrossoverRate()"> + <a href="../apidocs/org/apache/commons/math4/genetics/GeneticAlgorithm.html#getCrossoverRate()"> getCrossoverRate()</a>, apply configured <code>CrossoverPolicy</code> to parents</li> <li>With probability = - <a href="../apidocs/org/apache/commons/math3/genetics/GeneticAlgorithm.html#getMutationRate()"> + <a href="../apidocs/org/apache/commons/math4/genetics/GeneticAlgorithm.html#getMutationRate()"> getMutationRate()</a>, apply configured <code>MutationPolicy</code> to each of the offspring</li> <li>Add offspring individually to nextGeneration, @@ -105,27 +105,27 @@ Chromosome bestFinal = finalPopulation.getFittestChromosome(); <table> <tr><th>Parameter</th><th>value in example</th><th>meaning</th></tr> <tr><td>crossoverPolicy</td> - <td><a href="../apidocs/org/apache/commons/math3/genetics/OnePointCrossover.html">OnePointCrossover</a></td> + <td><a href="../apidocs/org/apache/commons/math4/genetics/OnePointCrossover.html">OnePointCrossover</a></td> <td>A random crossover point is selected and the first part from each parent is copied to the corresponding child, and the second parts are copied crosswise.</td></tr> <tr><td>crossoverRate</td> <td>1</td> <td>Always apply crossover</td></tr> <tr><td>mutationPolicy</td> - <td><a href="../apidocs/org/apache/commons/math3/genetics/RandomKeyMutation.html">RandomKeyMutation</a></td> + <td><a href="../apidocs/org/apache/commons/math4/genetics/RandomKeyMutation.html">RandomKeyMutation</a></td> <td>Changes a randomly chosen element of the array representation to a random value uniformly distributed in [0,1].</td></tr> <tr><td>mutationRate</td> <td>.1</td> <td>Apply mutation with probability 0.1 - that is, 10% of the time.</td></tr> <tr><td>selectionPolicy</td> - <td><a href="../apidocs/org/apache/commons/math3/genetics/TournamentSelection.html">TournamentSelection</a></td> + <td><a href="../apidocs/org/apache/commons/math4/genetics/TournamentSelection.html">TournamentSelection</a></td> <td>Each of the two selected chromosomes is selected based on an n-ary tournament -- this is done by drawing n random chromosomes without replacement from the population, and then selecting the fittest chromosome among them.</td></tr> </table><br/> The algorithm starts with an <code>initial</code> population of <code>Chromosomes.</code> and executes until - the specified <a href="../apidocs/org/apache/commons/math3/genetics/StoppingCondition.html">StoppingCondition</a> + the specified <a href="../apidocs/org/apache/commons/math4/genetics/StoppingCondition.html">StoppingCondition</a> is reached. In the example above, a - <a href="../apidocs/org/apache/commons/math3/genetics/FixedGenerationCount.html">FixedGenerationCount</a> + <a href="../apidocs/org/apache/commons/math4/genetics/FixedGenerationCount.html">FixedGenerationCount</a> stopping condition is used, which means the algorithm proceeds through a fixed number of generations. </p> </subsection> http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/geometry.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/geometry.xml b/src/site/xdoc/userguide/geometry.xml index c05620e..7f7b6b3 100644 --- a/src/site/xdoc/userguide/geometry.xml +++ b/src/site/xdoc/userguide/geometry.xml @@ -42,11 +42,11 @@ <table border="1" align="center"> <tr BGCOLOR="#CCCCFF"><td colspan="2"><font size="+1">Regions</font></td></tr> <tr BGCOLOR="#EEEEFF"><font size="+1"><td>Space</td><td>Region</td></font></tr> - <tr><td>Euclidean 1D</td><td><a href="../apidocs/org/apache/commons/math3/geometry/euclidean/oned/IntervalsSet.html">IntervalsSet</a></td></tr> - <tr><td>Euclidean 2D</td><td><a href="../apidocs/org/apache/commons/math3/geometry/euclidean/twod/PolygonsSet.html">PolygonsSet</a></td></tr> - <tr><td>Euclidean 3D</td><td><a href="../apidocs/org/apache/commons/math3/geometry/euclidean/threed/PolyhedronsSet.html">PolyhedronsSet</a></td></tr> - <tr><td>1-Sphere</td><td><a href="../apidocs/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html">ArcsSet</a></td></tr> - <tr><td>2-Sphere</td><td><a href="../apidocs/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.html">SphericalPolygonsSet</a></td></tr> + <tr><td>Euclidean 1D</td><td><a href="../apidocs/org/apache/commons/math4/geometry/euclidean/oned/IntervalsSet.html">IntervalsSet</a></td></tr> + <tr><td>Euclidean 2D</td><td><a href="../apidocs/org/apache/commons/math4/geometry/euclidean/twod/PolygonsSet.html">PolygonsSet</a></td></tr> + <tr><td>Euclidean 3D</td><td><a href="../apidocs/org/apache/commons/math4/geometry/euclidean/threed/PolyhedronsSet.html">PolyhedronsSet</a></td></tr> + <tr><td>1-Sphere</td><td><a href="../apidocs/org/apache/commons/math4/geometry/spherical/oned/ArcsSet.html">ArcsSet</a></td></tr> + <tr><td>2-Sphere</td><td><a href="../apidocs/org/apache/commons/math4/geometry/spherical/twod/SphericalPolygonsSet.html">SphericalPolygonsSet</a></td></tr> </table> </p> <p> @@ -75,9 +75,9 @@ <subsection name="11.2 Euclidean spaces" href="euclidean"> <p> - <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/oned/Vector1D.html"> - Vector1D</a>, <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/twod/Vector2D.html"> - Vector2D</a> and <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html"> + <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/oned/Vector1D.html"> + Vector1D</a>, <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/twod/Vector2D.html"> + Vector2D</a> and <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/threed/Vector3D.html"> Vector3D</a> provide simple vector types. One important feature is that instances of these classes are guaranteed to be immutable, this greatly simplifies modelling dynamical systems @@ -99,14 +99,14 @@ is of course also implemented. </p> <p> - <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/oned/Vector1DFormat.html"> - Vector1DFormat</a>, <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/twod/Vector2DFormat.html"> - Vector2DFormat</a> and <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/threed/Vector3DFormat.html"> + <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/oned/Vector1DFormat.html"> + Vector1DFormat</a>, <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/twod/Vector2DFormat.html"> + Vector2DFormat</a> and <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/threed/Vector3DFormat.html"> Vector3DFormat</a> are specialized classes for formatting output or parsing input with text representation of vectors. </p> <p> - <a href="../apidocs/org/apache/commons/math3/geometry/euclidean/threed/Rotation.html"> + <a href="../apidocs/org/apache/commons/math4/geometry/euclidean/threed/Rotation.html"> Rotation</a> represents 3D rotations. Rotation instances are also immutable objects, as Vector3D instances. </p> @@ -185,13 +185,13 @@ a two-dimensional disc) and the 2-sphere (i.e. the two dimensional sphere surface corresponding to the boundary of a three-dimensional ball). The main classes in this package corresopnd to the region explained above, i.e. - <a href="../apidocs/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html">ArcsSet</a> - and <a href="../apidocs/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.html">SphericalPolygonsSet</a>. + <a href="../apidocs/org/apache/commons/math4/geometry/spherical/oned/ArcsSet.html">ArcsSet</a> + and <a href="../apidocs/org/apache/commons/math4/geometry/spherical/twod/SphericalPolygonsSet.html">SphericalPolygonsSet</a>. </p> </subsection> <subsection name="11.4 Binary Space Partitioning" href="partitioning"> <p> - <a href="../apidocs/org/apache/commons/math3/geometry/partitioning/BSPTree.html"> + <a href="../apidocs/org/apache/commons/math4/geometry/partitioning/BSPTree.html"> BSP trees</a> are an efficient way to represent space partitions and to associate attributes with each cell. Each node in a BSP tree represents a convex region which is partitioned in two convex http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/linear.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/linear.xml b/src/site/xdoc/userguide/linear.xml index acfd4b1..3a061e3 100644 --- a/src/site/xdoc/userguide/linear.xml +++ b/src/site/xdoc/userguide/linear.xml @@ -36,7 +36,7 @@ </subsection> <subsection name="3.2 Real matrices" href="real_matrices"> <p> - The <a href="../apidocs/org/apache/commons/math3/linear/RealMatrix.html"> + The <a href="../apidocs/org/apache/commons/math4/linear/RealMatrix.html"> RealMatrix</a> interface represents a matrix with real numbers as entries. The following basic matrix operations are supported: <ul> @@ -73,18 +73,18 @@ RealMatrix pInverse = new LUDecomposition(p).getSolver().getInverse(); </p> <p> The three main implementations of the interface are <a - href="../apidocs/org/apache/commons/math3/linear/Array2DRowRealMatrix.html"> + href="../apidocs/org/apache/commons/math4/linear/Array2DRowRealMatrix.html"> Array2DRowRealMatrix</a> and <a - href="../apidocs/org/apache/commons/math3/linear/BlockRealMatrix.html"> + href="../apidocs/org/apache/commons/math4/linear/BlockRealMatrix.html"> BlockRealMatrix</a> for dense matrices (the second one being more suited to dimensions above 50 or 100) and <a - href="../apidocs/org/apache/commons/math3/linear/SparseRealMatrix.html"> + href="../apidocs/org/apache/commons/math4/linear/SparseRealMatrix.html"> SparseRealMatrix</a> for sparse matrices. </p> </subsection> <subsection name="3.3 Real vectors" href="real_vectors"> <p> - The <a href="../apidocs/org/apache/commons/math3/linear/RealVector.html"> + The <a href="../apidocs/org/apache/commons/math4/linear/RealVector.html"> RealVector</a> interface represents a vector with real numbers as entries. The following basic matrix operations are supported: <ul> @@ -97,7 +97,7 @@ RealMatrix pInverse = new LUDecomposition(p).getSolver().getInverse(); </ul> </p> <p> - The <a href="../apidocs/org/apache/commons/math3/linear/RealVectorFormat.html"> + The <a href="../apidocs/org/apache/commons/math4/linear/RealVectorFormat.html"> RealVectorFormat</a> class handles input/output of vectors in a customizable textual format. </p> @@ -105,7 +105,7 @@ RealMatrix pInverse = new LUDecomposition(p).getSolver().getInverse(); <subsection name="3.4 Solving linear systems" href="solve"> <p> The <code>solve()</code> methods of the <a - href="../apidocs/org/apache/commons/math3/linear/DecompositionSolver.html">DecompositionSolver</a> + href="../apidocs/org/apache/commons/math4/linear/DecompositionSolver.html">DecompositionSolver</a> interface support solving linear systems of equations of the form AX=B, either in linear sense or in least square sense. A <code>RealMatrix</code> instance is used to represent the coefficient matrix of the system. Solving the system is a @@ -158,11 +158,11 @@ RealVector solution = solver.solve(constants); <table border="1" align="center"> <tr BGCOLOR="#CCCCFF"><td colspan="3"><font size="+1">Decomposition algorithms</font></td></tr> <tr BGCOLOR="#EEEEFF"><font size="+1"><td>Name</td><td>coefficients matrix</td><td>problem type</td></font></tr> - <tr><td><a href="../apidocs/org/apache/commons/math3/linear/LUDecomposition.html">LU</a></td><td>square</td><td>exact solution only</td></tr> - <tr><td><a href="../apidocs/org/apache/commons/math3/linear/CholeskyDecomposition.html">Cholesky</a></td><td>symmetric positive definite</td><td>exact solution only</td></tr> - <tr><td><a href="../apidocs/org/apache/commons/math3/linear/QRDecomposition.html">QR</a></td><td>any</td><td>least squares solution</td></tr> - <tr><td><a href="../apidocs/org/apache/commons/math3/linear/EigenDecomposition.html">eigen decomposition</a></td><td>square</td><td>exact solution only</td></tr> - <tr><td><a href="../apidocs/org/apache/commons/math3/linear/SingularValueDecomposition.html">SVD</a></td><td>any</td><td>least squares solution</td></tr> + <tr><td><a href="../apidocs/org/apache/commons/math4/linear/LUDecomposition.html">LU</a></td><td>square</td><td>exact solution only</td></tr> + <tr><td><a href="../apidocs/org/apache/commons/math4/linear/CholeskyDecomposition.html">Cholesky</a></td><td>symmetric positive definite</td><td>exact solution only</td></tr> + <tr><td><a href="../apidocs/org/apache/commons/math4/linear/QRDecomposition.html">QR</a></td><td>any</td><td>least squares solution</td></tr> + <tr><td><a href="../apidocs/org/apache/commons/math4/linear/EigenDecomposition.html">eigen decomposition</a></td><td>square</td><td>exact solution only</td></tr> + <tr><td><a href="../apidocs/org/apache/commons/math4/linear/SingularValueDecomposition.html">SVD</a></td><td>any</td><td>least squares solution</td></tr> </table> </p> <p> @@ -197,13 +197,13 @@ RealVector solution = solver.solve(constants); <subsection name="3.6 Non-real fields (complex, fractions ...)" href="field"> <p> In addition to the real field, matrices and vectors using non-real <a - href="../apidocs/org/apache/commons/math3/FieldElement.html">field elements</a> can be used. + href="../apidocs/org/apache/commons/math4/FieldElement.html">field elements</a> can be used. The fields already supported by the library are: <ul> - <li><a href="../apidocs/org/apache/commons/math3/complex/Complex.html">Complex</a></li> - <li><a href="../apidocs/org/apache/commons/math3/fraction/Fraction.html">Fraction</a></li> - <li><a href="../apidocs/org/apache/commons/math3/fraction/BigFraction.html">BigFraction</a></li> - <li><a href="../apidocs/org/apache/commons/math3/util/BigReal.html">BigReal</a></li> + <li><a href="../apidocs/org/apache/commons/math4/complex/Complex.html">Complex</a></li> + <li><a href="../apidocs/org/apache/commons/math4/fraction/Fraction.html">Fraction</a></li> + <li><a href="../apidocs/org/apache/commons/math4/fraction/BigFraction.html">BigFraction</a></li> + <li><a href="../apidocs/org/apache/commons/math4/util/BigReal.html">BigReal</a></li> </ul> </p> </subsection> http://git-wip-us.apache.org/repos/asf/commons-math/blob/e4e1ac23/src/site/xdoc/userguide/ml.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide/ml.xml b/src/site/xdoc/userguide/ml.xml index 1ba7b65..bc3f2c2 100644 --- a/src/site/xdoc/userguide/ml.xml +++ b/src/site/xdoc/userguide/ml.xml @@ -34,30 +34,30 @@ </subsection> <subsection name="16.2 Clustering algorithms and distance measures" href="clustering"> <p> - The <a href="../apidocs/org/apache/commons/math3/ml/clustering/Clusterer.html"> + The <a href="../apidocs/org/apache/commons/math4/ml/clustering/Clusterer.html"> Clusterer</a> class represents a clustering algorithm. The following algorithms are available: <ul> - <li><a href="../apidocs/org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html">KMeans++</a>: + <li><a href="../apidocs/org/apache/commons/math4/ml/clustering/KMeansPlusPlusClusterer.html">KMeans++</a>: It is based on the well-known kMeans algorithm, but uses a different method for choosing the initial values (or "seeds") and thus avoids cases where KMeans sometimes results in poor clusterings. KMeans/KMeans++ clustering aims to partition n observations into k clusters in such that each point belongs to the cluster with the nearest center. </li> - <li><a href="../apidocs/org/apache/commons/math3/ml/clustering/FuzzyKMeansClusterer.html">Fuzzy-KMeans</a>: + <li><a href="../apidocs/org/apache/commons/math4/ml/clustering/FuzzyKMeansClusterer.html">Fuzzy-KMeans</a>: A variation of the classical K-Means algorithm, with the major difference that a single data point is not uniquely assigned to a single cluster. Instead, each point i has a set of weights u<sub>ij</sub> which indicate the degree of membership to the cluster j. The fuzzy variant does not require initial values for the cluster centers and is thus more robust, although slower than the original kMeans algorithm. </li> - <li><a href="../apidocs/org/apache/commons/math3/ml/clustering/DBSCANClusterer.html">DBSCAN</a>: + <li><a href="../apidocs/org/apache/commons/math4/ml/clustering/DBSCANClusterer.html">DBSCAN</a>: Density-based spatial clustering of applications with noise (DBSCAN) finds a number of clusters starting from the estimated density distribution of corresponding nodes. The main advantages over KMeans/KMeans++ are that DBSCAN does not require the specification of an initial number of clusters and can find arbitrarily shaped clusters. </li> - <li><a href="../apidocs/org/apache/commons/math3/ml/clustering/MultiKMeansPlusPlusClusterer.html">Multi-KMeans++</a>: + <li><a href="../apidocs/org/apache/commons/math4/ml/clustering/MultiKMeansPlusPlusClusterer.html">Multi-KMeans++</a>: Multi-KMeans++ is a meta algorithm that basically performs n runs using KMeans++ and then chooses the best clustering (i.e., the one with the lowest distance variance over all clusters) from those runs. @@ -75,11 +75,11 @@ between two points (either data points or cluster centers). The following distance measures are available: <ul> - <li><a href="../apidocs/org/apache/commons/math3/ml/distance/CanberraDistance.html">Canberra distance</a></li> - <li><a href="../apidocs/org/apache/commons/math3/ml/distance/ChebyshevDistance.html">ChebyshevDistance distance</a></li> - <li><a href="../apidocs/org/apache/commons/math3/ml/distance/EuclideanDistance.html">EuclideanDistance distance</a></li> - <li><a href="../apidocs/org/apache/commons/math3/ml/distance/ManhattanDistance.html">ManhattanDistance distance</a></li> - <li><a href="../apidocs/org/apache/commons/math3/ml/distance/EarthMoversDistance.html">Earth Mover's distance</a></li> + <li><a href="../apidocs/org/apache/commons/math4/ml/distance/CanberraDistance.html">Canberra distance</a></li> + <li><a href="../apidocs/org/apache/commons/math4/ml/distance/ChebyshevDistance.html">ChebyshevDistance distance</a></li> + <li><a href="../apidocs/org/apache/commons/math4/ml/distance/EuclideanDistance.html">EuclideanDistance distance</a></li> + <li><a href="../apidocs/org/apache/commons/math4/ml/distance/ManhattanDistance.html">ManhattanDistance distance</a></li> + <li><a href="../apidocs/org/apache/commons/math4/ml/distance/EarthMoversDistance.html">Earth Mover's distance</a></li> </ul> </p> </subsection> @@ -91,7 +91,7 @@ 10 different clusters based on their euclidean distance. </p> <p> - The cluster algorithms expect a list of <a href="../apidocs/org/apache/commons/math3/ml/cluster/Clusterable.html">Clusterable</a> + The cluster algorithms expect a list of <a href="../apidocs/org/apache/commons/math4/ml/cluster/Clusterable.html">Clusterable</a> as input. Typically, we don't want to pollute our domain objects with interfaces from helper APIs. Hence, we first create a wrapper object: <source>
