commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r790381 - /commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/fitting/package.html
Date Wed, 01 Jul 2009 21:04:20 GMT
Author: luc
Date: Wed Jul  1 21:04:20 2009
New Revision: 790381

fixed package documentation that still referenced mantissa


Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/fitting/package.html
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/fitting/package.html
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/fitting/package.html
Wed Jul  1 21:04:20 2009
@@ -19,25 +19,12 @@
 This package provides classes to perform curve fitting.
-<p>Curve fitting is a special case of an {@link
-org.spaceroots.mantissa.estimation.EstimationProblem estimation problem}
+<p>Curve fitting is a special case of a least squares problem
 were the parameters are the coefficients of a function <code>f</code>
 whose graph <code>y=f(x)</code> should pass through sample points, and
-were the measurements are the ordinates of the curve
+were the objective function is the squared sum of residuals
+<code>f(x<sub>i</sub>)-y<sub>i</sub></code> for observed
+(x<sub>i</sub>, y<sub>i</sub>).</p>
-<p>The organisation of this package is explained in the class diagram
-below. The {@link org.spaceroots.mantissa.fitting.AbstractCurveFitter
-AbstractCurveFitter} class is the base class for all curve fitting
-classes, it handles all common features like sample points
-handling. Each specific curve fitting class should sub-class this
-abstract class and implement the {@link
-org.spaceroots.mantissa.fitting.AbstractCurveFitter#valueAt valueAt} and
-{@link org.spaceroots.mantissa.fitting.AbstractCurveFitter#partial
-partial} methods.</p>
-<img src="doc-files/org_spaceroots_mantissa_fitting_classes.png" />
-@author L. Maisonobe

View raw message