diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html | 575 |
1 files changed, 575 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html new file mode 100644 index 0000000..437e4e7 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html @@ -0,0 +1,575 @@ +<!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/fitting/leastsquares/LeastSquaresProblem.Evaluation.html" title="interface in org.apache.commons.math3.fitting.leastsquares"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/MultivariateJacobianFunction.html" title="interface in org.apache.commons.math3.fitting.leastsquares"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/fitting/leastsquares/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>Field | </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.fitting.leastsquares</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>org.apache.commons.math3.fitting.leastsquares.LevenbergMarquardtOptimizer</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LevenbergMarquardtOptimizer</span> +extends <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> +implements <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer</a></pre> +<div class="block">This class solves a least-squares problem using the Levenberg-Marquardt + algorithm. + + <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>3.3</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.commons.math3.fitting.leastsquares.LeastSquaresOptimizer"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.commons.math3.fitting.leastsquares.<a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer</a></h3> +<code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.Optimum.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer.Optimum</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/fitting/leastsquares/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer()">LevenbergMarquardtOptimizer</a></strong>()</code> +<div class="block">Default constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#LevenbergMarquardtOptimizer(double,%20double,%20double,%20double,%20double)">LevenbergMarquardtOptimizer</a></strong>(double initialStepBoundFactor, + double costRelativeTolerance, + double parRelativeTolerance, + double orthoTolerance, + double qrRankingThreshold)</code> +<div class="block">Construct an instance with all parameters specified.</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>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#getCostRelativeTolerance()">getCostRelativeTolerance</a></strong>()</code> +<div class="block">Gets the value of a tuning parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#getInitialStepBoundFactor()">getInitialStepBoundFactor</a></strong>()</code> +<div class="block">Gets the value of a tuning parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#getOrthoTolerance()">getOrthoTolerance</a></strong>()</code> +<div class="block">Gets the value of a tuning parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#getParameterRelativeTolerance()">getParameterRelativeTolerance</a></strong>()</code> +<div class="block">Gets the value of a tuning parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#getRankingThreshold()">getRankingThreshold</a></strong>()</code> +<div class="block">Gets the value of a tuning parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.Optimum.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer.Optimum</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#optimize(org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem)">optimize</a></strong>(<a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresProblem.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresProblem</a> problem)</code> +<div class="block">Solve the non-linear least squares problem.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withCostRelativeTolerance(double)">withCostRelativeTolerance</a></strong>(double newCostRelativeTolerance)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withInitialStepBoundFactor(double)">withInitialStepBoundFactor</a></strong>(double newInitialStepBoundFactor)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withOrthoTolerance(double)">withOrthoTolerance</a></strong>(double newOrthoTolerance)</code> +<div class="block">Modifies the given parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withParameterRelativeTolerance(double)">withParameterRelativeTolerance</a></strong>(double newParRelativeTolerance)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withRankingThreshold(double)">withRankingThreshold</a></strong>(double newQRRankingThreshold)</code> </td> +</tr> +</table> +<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">Default constructor. + <p> + 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(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 qrRankingThreshold)</pre> +<div class="block">Construct an instance with all parameters specified.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialStepBoundFactor</code> - initial step bound factor</dd><dd><code>costRelativeTolerance</code> - cost relative tolerance</dd><dd><code>parRelativeTolerance</code> - parameters relative tolerance</dd><dd><code>orthoTolerance</code> - orthogonality tolerance</dd><dd><code>qrRankingThreshold</code> - threshold in the QR decomposition. Columns with a 2 + norm less than this threshold are considered to be + all 0s.</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="withInitialStepBoundFactor(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withInitialStepBoundFactor</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a> withInitialStepBoundFactor(double newInitialStepBoundFactor)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newInitialStepBoundFactor</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>newInitialStepBoundFactor</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. + of the matrix is reduced.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new instance.</dd></dl> +</li> +</ul> +<a name="withCostRelativeTolerance(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withCostRelativeTolerance</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a> withCostRelativeTolerance(double newCostRelativeTolerance)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newCostRelativeTolerance</code> - Desired relative error in the sum of squares.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new instance.</dd></dl> +</li> +</ul> +<a name="withParameterRelativeTolerance(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withParameterRelativeTolerance</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a> withParameterRelativeTolerance(double newParRelativeTolerance)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newParRelativeTolerance</code> - Desired relative error in the approximate solution + parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new instance.</dd></dl> +</li> +</ul> +<a name="withOrthoTolerance(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withOrthoTolerance</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a> withOrthoTolerance(double newOrthoTolerance)</pre> +<div class="block">Modifies the given parameter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newOrthoTolerance</code> - Desired max cosine on the orthogonality between + the function vector and the columns of the Jacobian.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new instance.</dd></dl> +</li> +</ul> +<a name="withRankingThreshold(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRankingThreshold</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html" title="class in org.apache.commons.math3.fitting.leastsquares">LevenbergMarquardtOptimizer</a> withRankingThreshold(double newQRRankingThreshold)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newQRRankingThreshold</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> +<dt><span class="strong">Returns:</span></dt><dd>a new instance.</dd></dl> +</li> +</ul> +<a name="getInitialStepBoundFactor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialStepBoundFactor</h4> +<pre>public double getInitialStepBoundFactor()</pre> +<div class="block">Gets the value of a tuning parameter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the parameter's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withInitialStepBoundFactor(double)"><code>withInitialStepBoundFactor(double)</code></a></dd></dl> +</li> +</ul> +<a name="getCostRelativeTolerance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCostRelativeTolerance</h4> +<pre>public double getCostRelativeTolerance()</pre> +<div class="block">Gets the value of a tuning parameter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the parameter's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withCostRelativeTolerance(double)"><code>withCostRelativeTolerance(double)</code></a></dd></dl> +</li> +</ul> +<a name="getParameterRelativeTolerance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterRelativeTolerance</h4> +<pre>public double getParameterRelativeTolerance()</pre> +<div class="block">Gets the value of a tuning parameter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the parameter's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withParameterRelativeTolerance(double)"><code>withParameterRelativeTolerance(double)</code></a></dd></dl> +</li> +</ul> +<a name="getOrthoTolerance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrthoTolerance</h4> +<pre>public double getOrthoTolerance()</pre> +<div class="block">Gets the value of a tuning parameter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the parameter's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withOrthoTolerance(double)"><code>withOrthoTolerance(double)</code></a></dd></dl> +</li> +</ul> +<a name="getRankingThreshold()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRankingThreshold</h4> +<pre>public double getRankingThreshold()</pre> +<div class="block">Gets the value of a tuning parameter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the parameter's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LevenbergMarquardtOptimizer.html#withRankingThreshold(double)"><code>withRankingThreshold(double)</code></a></dd></dl> +</li> +</ul> +<a name="optimize(org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>optimize</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.Optimum.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer.Optimum</a> optimize(<a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresProblem.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresProblem</a> problem)</pre> +<div class="block">Solve the non-linear least squares problem.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.html#optimize(org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem)">optimize</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/LeastSquaresOptimizer.html" title="interface in org.apache.commons.math3.fitting.leastsquares">LeastSquaresOptimizer</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>problem</code> - the problem definition, including model function and + convergence criteria.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The optimum.</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/fitting/leastsquares/LeastSquaresProblem.Evaluation.html" title="interface in org.apache.commons.math3.fitting.leastsquares"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/fitting/leastsquares/MultivariateJacobianFunction.html" title="interface in org.apache.commons.math3.fitting.leastsquares"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/fitting/leastsquares/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>Field | </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> |