From 66ea7501d475649e9f8d944460b3159777209a28 Mon Sep 17 00:00:00 2001 From: Gilles Sadowski Date: Tue, 21 Feb 2012 14:31:56 +0000 Subject: [PATCH] Base package name: Changed "math" -> "math3" in userguide links. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1291806 13f79535-47bb-0310-9956-ffa450edef68 --- src/site/xdoc/userguide/analysis.xml | 102 +++++++++++------------ src/site/xdoc/userguide/complex.xml | 12 +-- src/site/xdoc/userguide/distribution.xml | 14 ++-- src/site/xdoc/userguide/filter.xml | 6 +- src/site/xdoc/userguide/fraction.xml | 6 +- src/site/xdoc/userguide/genetics.xml | 28 +++---- src/site/xdoc/userguide/geometry.xml | 16 ++-- src/site/xdoc/userguide/linear.xml | 34 ++++---- src/site/xdoc/userguide/ode.xml | 60 ++++++------- src/site/xdoc/userguide/optimization.xml | 62 +++++++------- src/site/xdoc/userguide/overview.xml | 6 +- src/site/xdoc/userguide/random.xml | 62 +++++++------- src/site/xdoc/userguide/special.xml | 6 +- src/site/xdoc/userguide/stat.xml | 98 +++++++++++----------- src/site/xdoc/userguide/transform.xml | 8 +- src/site/xdoc/userguide/utilities.xml | 16 ++-- 16 files changed, 268 insertions(+), 268 deletions(-) diff --git a/src/site/xdoc/userguide/analysis.xml b/src/site/xdoc/userguide/analysis.xml index 75eb6c76b..d0ce3de88 100644 --- a/src/site/xdoc/userguide/analysis.xml +++ b/src/site/xdoc/userguide/analysis.xml @@ -93,13 +93,13 @@

- - UnivariateRealSolver, - DifferentiableUnivariateRealSolver and + + UnivariateRealSolver, + DifferentiableUnivariateRealSolver and PolynomialSolver provide means to find roots of - univariate real-valued functions, - differentiable univariate real-valued functions, - and polynomial functions respectively. + univariate real-valued functions, + differentiable univariate real-valued functions, + and polynomial functions respectively. A root is the value where the function takes the value 0. Commons-Math includes implementations of the several root-finding algorithms:

@@ -107,84 +107,84 @@ Root solvers NameFunction typeConvergenceNeeds initial bracketingBracket side selection - Bisection - univariate real-valued functions + Bisection + univariate real-valued functions linear, guaranteed yes yes - Brent-Dekker - univariate real-valued functions + Brent-Dekker + univariate real-valued functions super-linear, guaranteed yes no - bracketing nth order Brent + bracketing nth order Brent variable order, guaranteed yes yes - Illinois Method - univariate real-valued functions + Illinois Method + univariate real-valued functions super-linear, guaranteed yes yes - Laguerre's Method - polynomial functions + Laguerre's Method + polynomial functions cubic for simple root, linear for multiple root yes no - Muller's Method using bracketing to deal with real-valued functions - univariate real-valued functions + Muller's Method using bracketing to deal with real-valued functions + univariate real-valued functions quadratic close to roots yes no - Muller's Method using modulus to deal with real-valued functions - univariate real-valued functions + Muller's Method using modulus to deal with real-valued functions + univariate real-valued functions quadratic close to root yes no - Newton's Method - differentiable univariate real-valued functions + Newton's Method + differentiable univariate real-valued functions quadratic, non-guaranteed no no - Pegasus Method - univariate real-valued functions + Pegasus Method + univariate real-valued functions super-linear, guaranteed yes yes - Regula Falsi (false position) Method - univariate real-valued functions + Regula Falsi (false position) Method + univariate real-valued functions linear, guaranteed yes yes - Ridder's Method - univariate real-valued functions + Ridder's Method + univariate real-valued functions super-linear yes no - Secant Method - univariate real-valued functions + Secant Method + univariate real-valued functions super-linear, non-guaranteed yes no @@ -240,9 +240,9 @@ ill-conditioned problems is to be solved, this number can be decreased in order to avoid wasting time. Bracketed + href="../apidocs/org/apache/commons/math3/analysis/solvers/BracketedUnivariateRealSolver.html">Bracketed solvers also take an allowedSolutions + href="../apidocs/org/apache/commons/math3/analysis/solvers/AllowedSolutions.html">allowedSolutions enum parameter to specify which side of the final convergence interval should be selected as the root. It can be ANY_SIDE, LEFT_SIDE, RIGHT_SIDE, BELOW_SIDE or ABOVE_SIDE. Left and right are used to specify the root along @@ -376,13 +376,13 @@ double c = UnivariateRealSolverUtils.forceSide(100, function,

- A + A UnivariateRealInterpolator is used to find a univariate real-valued function f which for a given set of ordered pairs (xi,yi) yields f(xi)=yi to the best accuracy possible. The result is provided as an object implementing the + href="../apidocs/org/apache/commons/math3/analysis/UnivariateRealFunction.html"> UnivariateRealFunction 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 @@ -437,13 +437,13 @@ System.out println("f(" + interpolationX + ") = " + interpolatedY); href="http://www.dudziak.com/microsphere.pdf">MS thesis.

- A + A BivariateRealGridInterpolator is used to find a bivariate real-valued function f which for a given set of tuples (xi,yj,fij) yields f(xi,yj)=fij to the best accuracy possible. The result is provided as an object implementing the - + BivariateRealFunction interface. It can therefore be evaluated at any point, including a point not belonging to the original set. The arrays xi and yj must be @@ -455,25 +455,25 @@ System.out println("f(" + interpolationX + ") = " + interpolatedY); 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 - + BicubicSplineInterpolator computes a - + bicubic interpolating function. Prior to computing an interpolating function, the - + SmoothingPolynomialBicubicSplineInterpolator 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.

- A + A TrivariateRealGridInterpolator is used to find a trivariate real-valued function f which for a given set of tuples (xi,yj,zk, fijk) yields f(xi,yj,zk)=fijk to the best accuracy possible. The result is provided as an object implementing the - + TrivariateRealFunction interface. It can therefore be evaluated at any point, including a point not belonging to the original set. The arrays xi, yj and @@ -486,41 +486,41 @@ System.out println("f(" + interpolationX + ") = " + interpolatedY); 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 - + TricubicSplineInterpolator computes a - + tricubic interpolating function.

- A + A UnivariateRealIntegrator provides the means to numerically integrate - + univariate real-valued functions. Commons-Math includes implementations of the following integration algorithms:

- The + The org.apache.commons.math3.analysis.polynomials package provides real coefficients polynomials.

- The + The PolynomialFunction class is the most general one, using traditional coefficients arrays. The - + PolynomialsUtils 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 diff --git a/src/site/xdoc/userguide/complex.xml b/src/site/xdoc/userguide/complex.xml index 17ff99752..7c37626a8 100644 --- a/src/site/xdoc/userguide/complex.xml +++ b/src/site/xdoc/userguide/complex.xml @@ -34,7 +34,7 @@

- + Complex provides a complex number type that forms the basis for the complex functionality found in commons-math.

@@ -45,9 +45,9 @@ handling infinite and NaN 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 - + Complex and - + ComplexUtils classes for details on computing formulas.

@@ -78,11 +78,11 @@ Complex answer = lhs.add(rhs); // add two complex numbers

- + Complex also provides implementations of serveral transcendental functions involving complex number arguments. Prior to version 1.2, these functions were provided - by + by ComplexUtils in a way similar to the real number functions found in java.lang.Math, but this has been deprecated. These operations provide the means to compute the log, sine, tangent, @@ -98,7 +98,7 @@ Complex answer = first.log(); // natural logarithm.

Complex instances can be converted to and from strings - using the + using the ComplexFormat class. ComplexFormat is a java.text.Format extension and, as such, is used like other formatting objects (e.g. diff --git a/src/site/xdoc/userguide/distribution.xml b/src/site/xdoc/userguide/distribution.xml index 7d2af6519..09035b557 100644 --- a/src/site/xdoc/userguide/distribution.xml +++ b/src/site/xdoc/userguide/distribution.xml @@ -70,19 +70,19 @@ double upperTail = 1.0 - t.cumulativeProbability(2.75); // P(T >= 2.75)Distribution, - + Distribution, + ContinuousDistribution, - - DiscreteDistribution, and + + DiscreteDistribution, and IntegerDistribution interfaces serve as base types for any extension. These serve as the basis for all the distributions directly supported by Commons-Math and using those interfaces for implementation purposes will ensure any extension is compatible with the remainder of Commons-Math. To aid in implementing a distribution extension, - the - AbstractDistribution, - AbstractContinuousDistribution, and + the + AbstractDistribution, + AbstractContinuousDistribution, and AbstractIntegerDistribution provide implementation building blocks and offer basic distribution functionality. By extending these abstract classes directly, much of the repetitive distribution implementation is already diff --git a/src/site/xdoc/userguide/filter.xml b/src/site/xdoc/userguide/filter.xml index 5e4df9361..79fbc47b8 100644 --- a/src/site/xdoc/userguide/filter.xml +++ b/src/site/xdoc/userguide/filter.xml @@ -32,12 +32,12 @@

- + KalmanFilter provides a discrete-time filter to estimate a stochastic linear process.

-

A Kalman filter is initialized with a - ProcessModel and a +

A Kalman filter is initialized with a + ProcessModel and a MeasurementModel, 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: diff --git a/src/site/xdoc/userguide/fraction.xml b/src/site/xdoc/userguide/fraction.xml index f7d64daf4..e798dfbea 100644 --- a/src/site/xdoc/userguide/fraction.xml +++ b/src/site/xdoc/userguide/fraction.xml @@ -33,8 +33,8 @@

- - Fraction and + + Fraction and BigFraction 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 @@ -71,7 +71,7 @@ Fraction answer = lhs.add(rhs); // add two fractions

Fraction instances can be converted to and from strings - using the + using the FractionFormat class. FractionFormat is a java.text.Format extension and, as such, is used like other formatting objects (e.g. java.text.SimpleDateFormat): diff --git a/src/site/xdoc/userguide/genetics.xml b/src/site/xdoc/userguide/genetics.xml index 50b77a70f..06ce57b9d 100644 --- a/src/site/xdoc/userguide/genetics.xml +++ b/src/site/xdoc/userguide/genetics.xml @@ -33,15 +33,15 @@

- + GeneticAlgorithm provides an execution framework for Genetic Algorithms (GA). - - Populations, consisting of + + Populations, consisting of Chromosomes are evolved by the GeneticAlgorithm until a - - StoppingCondition is reached. Evolution is determined by - SelectionPolicy, - MutationPolicy and + + StoppingCondition is reached. Evolution is determined by + SelectionPolicy, + MutationPolicy and Fitness.

@@ -64,10 +64,10 @@