Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixed package documentation that still referenced mantissa 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@790381 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe 2009-07-01 21:04:20 +00:00
parent 6d10d47af1
commit e4a5900147
1 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/java/org/apache/commons/math/optimization/fitting/package.html
View File

@ -19,25 +19,12 @@
<body> <body>
This package provides classes to perform curve fitting. This package provides classes to perform curve fitting.
<p>Curve fitting is a special case of an {@link <p>Curve fitting is a special case of a least squares problem
org.spaceroots.mantissa.estimation.EstimationProblem estimation problem}
were the parameters are the coefficients of a function <code>f</code> 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 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>yi=f(xi)</code>.</p> <code>f(x<sub>i</sub>)-y<sub>i</sub></code> for observed points
(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
</body> </body>
</html> </html>