Author: erans
Date: Thu Sep 1 11:35:49 2011
New Revision: 1164022
URL: http://svn.apache.org/viewvc?rev=1164022&view=rev
Log:
Javadoc: indicated the assumed layout of the Jacobian matrix.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractLeastSquaresOptimizer.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractLeastSquaresOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractLeastSquaresOptimizer.java?rev=1164022&r1=1164021&r2=1164022&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractLeastSquaresOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractLeastSquaresOptimizer.java
Thu Sep 1 11:35:49 2011
@@ -35,10 +35,18 @@ import org.apache.commons.math.util.Fast
* Base class for implementing least squares optimizers.
* It handles the boilerplate methods associated to thresholds settings,
* jacobian and error estimation.
+ * <br/>
+ * This class uses the {@link
DifferentiableMultivariateVectorialFunction#jacobian()}
+ * of the function argument in method
+ * {@link
#optimize(int,DifferentiableMultivariateVectorialFunction,double[],double[],double[])
+ * optimize} and assumes that, in the matrix returned by the
+ * {@link MultivariateMatrixFunction#value(double[]) value} method, the rows
+ * iterate on the model functions while the columns iterate on the parameters;
thus,
+ * the numbers of rows is equal to the length of the {@code target} array
while the
+ * number of columns is equal to the length of the {@code startPoint} array.
*
* @version $Id$
* @since 1.2
- *
*/
public abstract class AbstractLeastSquaresOptimizer
extends
BaseAbstractVectorialOptimizer<DifferentiableMultivariateVectorialFunction>
