You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2013/08/13 23:38:23 UTC
svn commit: r1513660 -
/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.java
Author: erans
Date: Tue Aug 13 21:38:23 2013
New Revision: 1513660
URL: http://svn.apache.org/r1513660
Log:
Javadoc.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.java
Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.java?rev=1513660&r1=1513659&r2=1513660&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.java Tue Aug 13 21:38:23 2013
@@ -103,7 +103,7 @@ import org.apache.commons.math3.util.Fas
* </table>
*
* @version $Id$
- * @since 2.0
+ * @since 3.3
*/
public class LevenbergMarquardtOptimizer extends AbstractLeastSquaresOptimizer<LevenbergMarquardtOptimizer> {
/** Twice the "epsilon machine". */
@@ -112,10 +112,12 @@ public class LevenbergMarquardtOptimizer
private double initialStepBoundFactor = 100;
/** Desired relative error in the sum of squares. */
private double costRelativeTolerance = 1e-10;
- /** Desired relative error in the approximate solution parameters. */
+ /** Desired relative error in the approximate solution parameters. */
private double parRelativeTolerance = 1e-10;
- /** Desired max cosine on the orthogonality between the function vector
- * and the columns of the jacobian. */
+ /**
+ * Desired max cosine on the orthogonality between the function vector
+ * and the columns of the jacobian.
+ */
private double orthoTolerance = 1e-10;
/** Threshold for QR ranking. */
private double qrRankingThreshold = Precision.SAFE_MIN;
@@ -160,6 +162,8 @@ public class LevenbergMarquardtOptimizer
}
/**
+ * Modifies the given parameter.
+ *
* @param costRelativeTolerance Desired relative error in the sum of squares.
* @return this instance.
*/
@@ -169,6 +173,8 @@ public class LevenbergMarquardtOptimizer
}
/**
+ * Modifies the given parameter.
+ *
* @param parameterRelativeTolerance Desired relative error in the approximate solution
* parameters.
* @return this instance.
@@ -179,6 +185,8 @@ public class LevenbergMarquardtOptimizer
}
/**
+ * Modifies the given parameter.
+ *
* @param orthoTolerance Desired max cosine on the orthogonality between
* the function vector and the columns of the Jacobian.
* @return this instance.
@@ -189,6 +197,8 @@ public class LevenbergMarquardtOptimizer
}
/**
+ * Modifies the given parameter.
+ *
* @param rankingThreshold Desired threshold for QR ranking.
* If the squared norm of a column vector is smaller or equal to this
* threshold during QR decomposition, it is considered to be a zero vector