diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html | 587 |
1 files changed, 587 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html new file mode 100644 index 0000000..33b272c --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html @@ -0,0 +1,587 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LevenbergMarquardtOptimizer (Apache Commons Math 3.6.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="LevenbergMarquardtOptimizer (Apache Commons Math 3.6.1 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LevenbergMarquardtOptimizer.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/GaussNewtonOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector.jacobian"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../../index.html?org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html" target="_top">Frames</a></li> +<li><a href="LevenbergMarquardtOptimizer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#fields_inherited_from_class_org.apache.commons.math3.optim.BaseOptimizer">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.math3.optim.nonlinear.vector.jacobian</div> +<h2 title="Class LevenbergMarquardtOptimizer" class="title">Class LevenbergMarquardtOptimizer</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html" title="class in org.apache.commons.math3.optim">org.apache.commons.math3.optim.BaseOptimizer</a><PAIR></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/BaseMultivariateOptimizer.html" title="class in org.apache.commons.math3.optim">org.apache.commons.math3.optim.BaseMultivariateOptimizer</a><<a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a>></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector">org.apache.commons.math3.optim.nonlinear.vector.MultivariateVectorOptimizer</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector">org.apache.commons.math3.optim.nonlinear.vector.JacobianMultivariateVectorOptimizer</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector.jacobian">org.apache.commons.math3.optim.nonlinear.vector.jacobian.AbstractLeastSquaresOptimizer</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.optim.nonlinear.vector.jacobian.LevenbergMarquardtOptimizer</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>All classes and interfaces in this package are deprecated. + The optimizers that were provided here were moved to the + <a href="../../../../../../../../org/apache/commons/math3/fitting/leastsquares/package-summary.html"><code>org.apache.commons.math3.fitting.leastsquares</code></a> package + (cf. MATH-1008).</i></div> +</div> +<br> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public class <span class="strong">LevenbergMarquardtOptimizer</span> +extends <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector.jacobian">AbstractLeastSquaresOptimizer</a></pre> +<div class="block">This class solves a least-squares problem using the Levenberg-Marquardt + algorithm. + <br/> + Constraints are not supported: the call to + <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#optimize(org.apache.commons.math3.optim.OptimizationData...)"><code>optimize</code></a> will throw + <a href="../../../../../../../../org/apache/commons/math3/exception/MathUnsupportedOperationException.html" title="class in org.apache.commons.math3.exception"><code>MathUnsupportedOperationException</code></a> if bounds are passed to it. + + <p>This implementation <em>should</em> work even for over-determined systems + (i.e. systems having more point than equations). Over-determined systems + are solved by ignoring the point which have the smallest impact according + to their jacobian column norm. Only the rank of the matrix and some loop bounds + are changed to implement this.</p> + + <p>The resolution engine is a simple translation of the MINPACK <a + href="http://www.netlib.org/minpack/lmder.f">lmder</a> routine with minor + changes. The changes include the over-determined resolution, the use of + inherited convergence checker and the Q.R. decomposition which has been + rewritten following the algorithm described in the + P. Lascaux and R. Theodor book <i>Analyse numérique matricielle + appliquée à l'art de l'ingénieur</i>, Masson 1986.</p> + <p>The authors of the original fortran version are: + <ul> + <li>Argonne National Laboratory. MINPACK project. March 1980</li> + <li>Burton S. Garbow</li> + <li>Kenneth E. Hillstrom</li> + <li>Jorge J. More</li> + </ul> + The redistribution policy for MINPACK is available <a + href="http://www.netlib.org/minpack/disclaimer">here</a>, for convenience, it + is reproduced below.</p> + + <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0"> + <tr><td> + Minpack Copyright Notice (1999) University of Chicago. + All rights reserved + </td></tr> + <tr><td> + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + <ol> + <li>Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer.</li> + <li>Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution.</li> + <li>The end-user documentation included with the redistribution, if any, + must include the following acknowledgment: + <code>This product includes software developed by the University of + Chicago, as Operator of Argonne National Laboratory.</code> + Alternately, this acknowledgment may appear in the software itself, + if and wherever such third-party acknowledgments normally appear.</li> + <li><strong>WARRANTY DISCLAIMER. THE SOFTWARE IS SUPPLIED "AS IS" + WITHOUT WARRANTY OF ANY KIND. THE COPYRIGHT HOLDER, THE + UNITED STATES, THE UNITED STATES DEPARTMENT OF ENERGY, AND + THEIR EMPLOYEES: (1) DISCLAIM ANY WARRANTIES, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE + OR NON-INFRINGEMENT, (2) DO NOT ASSUME ANY LEGAL LIABILITY + OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR + USEFULNESS OF THE SOFTWARE, (3) DO NOT REPRESENT THAT USE OF + THE SOFTWARE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS, (4) + DO NOT WARRANT THAT THE SOFTWARE WILL FUNCTION + UNINTERRUPTED, THAT IT IS ERROR-FREE OR THAT ANY ERRORS WILL + BE CORRECTED.</strong></li> + <li><strong>LIMITATION OF LIABILITY. IN NO EVENT WILL THE COPYRIGHT + HOLDER, THE UNITED STATES, THE UNITED STATES DEPARTMENT OF + ENERGY, OR THEIR EMPLOYEES: BE LIABLE FOR ANY INDIRECT, + INCIDENTAL, CONSEQUENTIAL, SPECIAL OR PUNITIVE DAMAGES OF + ANY KIND OR NATURE, INCLUDING BUT NOT LIMITED TO LOSS OF + PROFITS OR LOSS OF DATA, FOR ANY REASON WHATSOEVER, WHETHER + SUCH LIABILITY IS ASSERTED ON THE BASIS OF CONTRACT, TORT + (INCLUDING NEGLIGENCE OR STRICT LIABILITY), OR OTHERWISE, + EVEN IF ANY OF SAID PARTIES HAS BEEN WARNED OF THE + POSSIBILITY OF SUCH LOSS OR DAMAGES.</strong></li> + <ol></td></tr> + </table></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.math3.optim.BaseOptimizer"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.commons.math3.optim.<a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html" title="class in org.apache.commons.math3.optim">BaseOptimizer</a></h3> +<code><a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#evaluations">evaluations</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#iterations">iterations</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer()">LevenbergMarquardtOptimizer</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Build an optimizer for least squares problems with default values + for all the tuning parameters (see the <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double,%20double,%20double)"><code>other contructor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(org.apache.commons.math3.optim.ConvergenceChecker)">LevenbergMarquardtOptimizer</a></strong>(<a href="../../../../../../../../org/apache/commons/math3/optim/ConvergenceChecker.html" title="interface in org.apache.commons.math3.optim">ConvergenceChecker</a><<a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a>> checker)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Constructor that allows the specification of a custom convergence + checker.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20org.apache.commons.math3.optim.ConvergenceChecker,%20double,%20double,%20double,%20double)">LevenbergMarquardtOptimizer</a></strong>(double initialStepBoundFactor, + <a href="../../../../../../../../org/apache/commons/math3/optim/ConvergenceChecker.html" title="interface in org.apache.commons.math3.optim">ConvergenceChecker</a><<a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a>> checker, + double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance, + double threshold)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Constructor that allows the specification of a custom convergence + checker, in addition to the standard ones.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double)">LevenbergMarquardtOptimizer</a></strong>(double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Build an optimizer for least squares problems with default values + for some of the tuning parameters (see the <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double,%20double,%20double)"><code>other contructor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double,%20double,%20double)">LevenbergMarquardtOptimizer</a></strong>(double initialStepBoundFactor, + double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance, + double threshold)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">The arguments control the behaviour of the default convergence checking + procedure.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#doOptimize()">doOptimize</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Performs the bulk of the optimization algorithm.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.optim.nonlinear.vector.jacobian.AbstractLeastSquaresOptimizer"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.optim.nonlinear.vector.jacobian.<a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector.jacobian">AbstractLeastSquaresOptimizer</a></h3> +<code><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#computeCost(double[])">computeCost</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#computeCovariances(double[],%20double)">computeCovariances</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#computeResiduals(double[])">computeResiduals</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#computeSigma(double[],%20double)">computeSigma</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#computeWeightedJacobian(double[])">computeWeightedJacobian</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#getChiSquare()">getChiSquare</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#getRMS()">getRMS</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#getWeightSquareRoot()">getWeightSquareRoot</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#optimize(org.apache.commons.math3.optim.OptimizationData...)">optimize</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#parseOptimizationData(org.apache.commons.math3.optim.OptimizationData...)">parseOptimizationData</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.html#setCost(double)">setCost</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.optim.nonlinear.vector.JacobianMultivariateVectorOptimizer"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.optim.nonlinear.vector.<a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector">JacobianMultivariateVectorOptimizer</a></h3> +<code><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.html#computeJacobian(double[])">computeJacobian</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.optim.nonlinear.vector.MultivariateVectorOptimizer"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.optim.nonlinear.vector.<a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector">MultivariateVectorOptimizer</a></h3> +<code><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html#computeObjectiveValue(double[])">computeObjectiveValue</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html#getTarget()">getTarget</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html#getTargetSize()">getTargetSize</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html#getWeight()">getWeight</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.optim.BaseMultivariateOptimizer"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.optim.<a href="../../../../../../../../org/apache/commons/math3/optim/BaseMultivariateOptimizer.html" title="class in org.apache.commons.math3.optim">BaseMultivariateOptimizer</a></h3> +<code><a href="../../../../../../../../org/apache/commons/math3/optim/BaseMultivariateOptimizer.html#getLowerBound()">getLowerBound</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseMultivariateOptimizer.html#getStartPoint()">getStartPoint</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseMultivariateOptimizer.html#getUpperBound()">getUpperBound</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.optim.BaseOptimizer"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.optim.<a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html" title="class in org.apache.commons.math3.optim">BaseOptimizer</a></h3> +<code><a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#getConvergenceChecker()">getConvergenceChecker</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#getEvaluations()">getEvaluations</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#getIterations()">getIterations</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#getMaxEvaluations()">getMaxEvaluations</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#getMaxIterations()">getMaxIterations</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#incrementEvaluationCount()">incrementEvaluationCount</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#incrementIterationCount()">incrementIterationCount</a>, <a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#optimize()">optimize</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LevenbergMarquardtOptimizer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LevenbergMarquardtOptimizer</h4> +<pre>public LevenbergMarquardtOptimizer()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Build an optimizer for least squares problems with default values + for all the tuning parameters (see the <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double,%20double,%20double)"><code>other contructor</code></a>. + The default values for the algorithm settings are: + <ul> + <li>Initial step bound factor: 100</li> + <li>Cost relative tolerance: 1e-10</li> + <li>Parameters relative tolerance: 1e-10</li> + <li>Orthogonality tolerance: 1e-10</li> + <li>QR ranking threshold: <a href="../../../../../../../../org/apache/commons/math3/util/Precision.html#SAFE_MIN"><code>Precision.SAFE_MIN</code></a></li> + </ul></div> +</li> +</ul> +<a name="LevenbergMarquardtOptimizer(org.apache.commons.math3.optim.ConvergenceChecker)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LevenbergMarquardtOptimizer</h4> +<pre>public LevenbergMarquardtOptimizer(<a href="../../../../../../../../org/apache/commons/math3/optim/ConvergenceChecker.html" title="interface in org.apache.commons.math3.optim">ConvergenceChecker</a><<a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a>> checker)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Constructor that allows the specification of a custom convergence + checker. + Note that all the usual convergence checks will be <em>disabled</em>. + The default values for the algorithm settings are: + <ul> + <li>Initial step bound factor: 100</li> + <li>Cost relative tolerance: 1e-10</li> + <li>Parameters relative tolerance: 1e-10</li> + <li>Orthogonality tolerance: 1e-10</li> + <li>QR ranking threshold: <a href="../../../../../../../../org/apache/commons/math3/util/Precision.html#SAFE_MIN"><code>Precision.SAFE_MIN</code></a></li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>checker</code> - Convergence checker.</dd></dl> +</li> +</ul> +<a name="LevenbergMarquardtOptimizer(double, org.apache.commons.math3.optim.ConvergenceChecker, double, double, double, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LevenbergMarquardtOptimizer</h4> +<pre>public LevenbergMarquardtOptimizer(double initialStepBoundFactor, + <a href="../../../../../../../../org/apache/commons/math3/optim/ConvergenceChecker.html" title="interface in org.apache.commons.math3.optim">ConvergenceChecker</a><<a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a>> checker, + double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance, + double threshold)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Constructor that allows the specification of a custom convergence + checker, in addition to the standard ones.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialStepBoundFactor</code> - Positive input variable used in + determining the initial step bound. This bound is set to the + product of initialStepBoundFactor and the euclidean norm of + <code>diag * x</code> if non-zero, or else to <code>initialStepBoundFactor</code> + itself. In most cases factor should lie in the interval + <code>(0.1, 100.0)</code>. <code>100</code> is a generally recommended value.</dd><dd><code>checker</code> - Convergence checker.</dd><dd><code>costRelativeTolerance</code> - Desired relative error in the sum of + squares.</dd><dd><code>parRelativeTolerance</code> - Desired relative error in the approximate + solution parameters.</dd><dd><code>orthoTolerance</code> - Desired max cosine on the orthogonality between + the function vector and the columns of the Jacobian.</dd><dd><code>threshold</code> - 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 and hence the rank + of the matrix is reduced.</dd></dl> +</li> +</ul> +<a name="LevenbergMarquardtOptimizer(double, double, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LevenbergMarquardtOptimizer</h4> +<pre>public LevenbergMarquardtOptimizer(double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Build an optimizer for least squares problems with default values + for some of the tuning parameters (see the <a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double,%20double,%20double)"><code>other contructor</code></a>. + The default values for the algorithm settings are: + <ul> + <li>Initial step bound factor}: 100</li> + <li>QR ranking threshold}: <a href="../../../../../../../../org/apache/commons/math3/util/Precision.html#SAFE_MIN"><code>Precision.SAFE_MIN</code></a></li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>costRelativeTolerance</code> - Desired relative error in the sum of + squares.</dd><dd><code>parRelativeTolerance</code> - Desired relative error in the approximate + solution parameters.</dd><dd><code>orthoTolerance</code> - Desired max cosine on the orthogonality between + the function vector and the columns of the Jacobian.</dd></dl> +</li> +</ul> +<a name="LevenbergMarquardtOptimizer(double, double, double, double, double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LevenbergMarquardtOptimizer</h4> +<pre>public LevenbergMarquardtOptimizer(double initialStepBoundFactor, + double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance, + double threshold)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">The arguments control the behaviour of the default convergence checking + procedure. + Additional criteria can defined through the setting of a <a href="../../../../../../../../org/apache/commons/math3/optim/ConvergenceChecker.html" title="interface in org.apache.commons.math3.optim"><code>ConvergenceChecker</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialStepBoundFactor</code> - Positive input variable used in + determining the initial step bound. This bound is set to the + product of initialStepBoundFactor and the euclidean norm of + <code>diag * x</code> if non-zero, or else to <code>initialStepBoundFactor</code> + itself. In most cases factor should lie in the interval + <code>(0.1, 100.0)</code>. <code>100</code> is a generally recommended value.</dd><dd><code>costRelativeTolerance</code> - Desired relative error in the sum of + squares.</dd><dd><code>parRelativeTolerance</code> - Desired relative error in the approximate + solution parameters.</dd><dd><code>orthoTolerance</code> - Desired max cosine on the orthogonality between + the function vector and the columns of the Jacobian.</dd><dd><code>threshold</code> - 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 and hence the rank + of the matrix is reduced.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="doOptimize()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>doOptimize</h4> +<pre>protected <a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a> doOptimize()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Performs the bulk of the optimization algorithm.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html#doOptimize()">doOptimize</a></code> in class <code><a href="../../../../../../../../org/apache/commons/math3/optim/BaseOptimizer.html" title="class in org.apache.commons.math3.optim">BaseOptimizer</a><<a href="../../../../../../../../org/apache/commons/math3/optim/PointVectorValuePair.html" title="class in org.apache.commons.math3.optim">PointVectorValuePair</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the point/value pair giving the optimal value of the + objective function.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LevenbergMarquardtOptimizer.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../../../org/apache/commons/math3/optim/nonlinear/vector/jacobian/GaussNewtonOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector.jacobian"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../../index.html?org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.html" target="_top">Frames</a></li> +<li><a href="LevenbergMarquardtOptimizer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#fields_inherited_from_class_org.apache.commons.math3.optim.BaseOptimizer">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |