Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 0B9F89266 for ; Tue, 21 Feb 2012 14:32:35 +0000 (UTC) Received: (qmail 94339 invoked by uid 500); 21 Feb 2012 14:32:34 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 94257 invoked by uid 500); 21 Feb 2012 14:32:34 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 94249 invoked by uid 99); 21 Feb 2012 14:32:34 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 21 Feb 2012 14:32:34 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 21 Feb 2012 14:32:21 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id E5C8B2388A68 for ; Tue, 21 Feb 2012 14:31:58 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1291806 [1/2] - /commons/proper/math/trunk/src/site/xdoc/userguide/ Date: Tue, 21 Feb 2012 14:31:58 -0000 To: commits@commons.apache.org From: erans@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120221143158.E5C8B2388A68@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: erans Date: Tue Feb 21 14:31:56 2012 New Revision: 1291806 URL: http://svn.apache.org/viewvc?rev=1291806&view=rev Log: Base package name: Changed "math" -> "math3" in userguide links. Modified: commons/proper/math/trunk/src/site/xdoc/userguide/analysis.xml commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml commons/proper/math/trunk/src/site/xdoc/userguide/filter.xml commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml commons/proper/math/trunk/src/site/xdoc/userguide/geometry.xml commons/proper/math/trunk/src/site/xdoc/userguide/linear.xml commons/proper/math/trunk/src/site/xdoc/userguide/ode.xml commons/proper/math/trunk/src/site/xdoc/userguide/optimization.xml commons/proper/math/trunk/src/site/xdoc/userguide/overview.xml commons/proper/math/trunk/src/site/xdoc/userguide/random.xml commons/proper/math/trunk/src/site/xdoc/userguide/special.xml commons/proper/math/trunk/src/site/xdoc/userguide/stat.xml commons/proper/math/trunk/src/site/xdoc/userguide/transform.xml commons/proper/math/trunk/src/site/xdoc/userguide/utilities.xml Modified: commons/proper/math/trunk/src/site/xdoc/userguide/analysis.xml URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/analysis.xml?rev=1291806&r1=1291805&r2=1291806&view=diff ============================================================================== --- commons/proper/math/trunk/src/site/xdoc/userguide/analysis.xml (original) +++ commons/proper/math/trunk/src/site/xdoc/userguide/analysis.xml Tue Feb 21 14:31:56 2012 @@ -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.for

- 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 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 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 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 Modified: commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml?rev=1291806&r1=1291805&r2=1291806&view=diff ============================================================================== --- commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml (original) +++ commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml Tue Feb 21 14:31:56 2012 @@ -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); //

- + 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(); //

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. Modified: commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml?rev=1291806&r1=1291805&r2=1291806&view=diff ============================================================================== --- commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml (original) +++ commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml Tue Feb 21 14:31:56 2012 @@ -70,19 +70,19 @@ double upperTail = 1.0 - t.cumulativePro Since there are numerous distributions and Commons-Math only directly supports a handful, it may be necessary to extend the distribution framework to satisfy individual needs. It is recommended that the - 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 Modified: commons/proper/math/trunk/src/site/xdoc/userguide/filter.xml URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/filter.xml?rev=1291806&r1=1291805&r2=1291806&view=diff ============================================================================== --- commons/proper/math/trunk/src/site/xdoc/userguide/filter.xml (original) +++ commons/proper/math/trunk/src/site/xdoc/userguide/filter.xml Tue Feb 21 14:31:56 2012 @@ -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: Modified: commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml?rev=1291806&r1=1291805&r2=1291806&view=diff ============================================================================== --- commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml (original) +++ commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml Tue Feb 21 14:31:56 2012 @@ -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); // a

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): Modified: commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml?rev=1291806&r1=1291805&r2=1291806&view=diff ============================================================================== --- commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml (original) +++ commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml Tue Feb 21 14:31:56 2012 @@ -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 @@