File: class_quant_lib_1_1_levenberg_marquardt.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (178 lines) | stat: -rw-r--r-- 8,396 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: LevenbergMarquardt Class Reference</title>
<link rel="stylesheet" href="quantlib.css" type="text/css">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link rel="icon" href="favicon.ico" type="image/x-icon">
</head>
<body>

<div id="container">
<div id="header">
<img class="titleimage"
 src="QL-title.jpg" width="212" height="47" border="0"
 alt="QuantLib">
<br>
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
</div>
<div id="menu">

<h3 class="navbartitle">Version 0.3.14</h3>

<hr>

<h3 class="navbartitle">Getting started</h3>
<ul class="navbarlist">
<li class="navlink"><a href="index.html">Introduction</a></li>
<li class="navlink"><a href="overview.html">Project overview</a></li>
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
<li class="navlink"><a href="install.html">Installation</a></li>
<li class="navlink"><a href="config.html">Configuration</a></li>
<li class="navlink"><a href="usage.html">Usage</a></li>
<li class="navlink"><a href="faq.html">Frequently asked questions</a></li>
<li class="navlink"><a href="history.html">Version history</a></li>
<li class="navlink"><a href="resources.html">Additional resources</a></li>
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
<li class="navlink"><a href="license.html">Copyright and license</a></li>
</ul>

<hr>

<h3 class="navbartitle">Reference manual</h3>
<ul class="navbarlist">
<li class="navlink"><a href="modules.html">Modules</a></li>
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
<li class="navlink"><a href="annotated.html">Compound List</a></li>
<li class="navlink"><a href="files.html">File List</a></li>
<li class="navlink"><a href="functions.html">Compound Members</a></li>
<li class="navlink"><a href="globals.html">File Members</a></li>
<li class="navlink"><a href="todo.html">Todo List</a></li>
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
<li class="navlink"><a href="caveats.html">Caveats</a></li>
<li class="navlink"><a href="test.html">Test Suite</a></li>
<li class="navlink"><a href="deprecated.html">Deprecated Features</a></li>
<li class="navlink"><a href="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_levenberg_marquardt.html">LevenbergMarquardt</a></div>
<h1>LevenbergMarquardt Class Reference</h1><!-- doxytag: class="QuantLib::LevenbergMarquardt" --><!-- doxytag: inherits="QuantLib::OptimizationMethod" --><code>#include &lt;ql/Optimization/levenbergmarquardt.hpp&gt;</code>
<p>
Inheritance diagram for LevenbergMarquardt:<p><center><img src="class_quant_lib_1_1_levenberg_marquardt__inherit__graph.png" border="0" usemap="#_levenberg_marquardt__inherit__map" alt="Inheritance graph"></center>
<map name="_levenberg_marquardt__inherit__map">
<area href="class_quant_lib_1_1_optimization_method.html" shape="rect" coords="8,7,165,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_levenberg_marquardt-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Levenberg-Marquardt optimization method. 
<p>
This implementation is based on MINPACK (&lt;<a href="http://www.netlib.org/minpack">http://www.netlib.org/minpack</a>&gt;, &lt;<a href="http://www.netlib.org/cephes/linalg.tgz">http://www.netlib.org/cephes/linalg.tgz</a>&gt;) <dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_bermudan_swaption_8cpp-example.html#_a3">BermudanSwaption.cpp</a>.</dl>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_levenberg_marquardt.html#b1c197af8e9dc343350c377103ba9fa1">LevenbergMarquardt</a> (Real epsfcn=1e-8, Real ftol=1e-8, Real xtol=1e-8, Real gtol=1e-8, Size maxfev=400)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3f9dd62978bc253c48a3cb831bea2d6"></a><!-- doxytag: member="QuantLib::LevenbergMarquardt::minimize" ref="d3f9dd62978bc253c48a3cb831bea2d6" args="(const Problem &amp;P) const" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_levenberg_marquardt.html#d3f9dd62978bc253c48a3cb831bea2d6">minimize</a> (const <a class="el" href="class_quant_lib_1_1_problem.html">Problem</a> &amp;P) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">minimize the optimization problem P <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f159c4e477c16928952a4bcbac911bc8"></a><!-- doxytag: member="QuantLib::LevenbergMarquardt::getInfo" ref="f159c4e477c16928952a4bcbac911bc8" args="() const" -->
virtual Integer&nbsp;</td><td class="memItemRight" valign="bottom"><b>getInfo</b> () const</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2c3a42172981cfb5dde0967142d27d1"></a><!-- doxytag: member="QuantLib::LevenbergMarquardt::fcn" ref="d2c3a42172981cfb5dde0967142d27d1" args="(int m, int n, double *x, double *fvec, int *iflag)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>fcn</b> (int m, int n, double *x, double *fvec, int *iflag)</td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b1c197af8e9dc343350c377103ba9fa1"></a><!-- doxytag: member="QuantLib::LevenbergMarquardt::LevenbergMarquardt" ref="b1c197af8e9dc343350c377103ba9fa1" args="(Real epsfcn=1e-8, Real ftol=1e-8, Real xtol=1e-8, Real gtol=1e-8, Size maxfev=400)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_quant_lib_1_1_levenberg_marquardt.html">LevenbergMarquardt</a>           </td>
          <td>(</td>
          <td class="paramtype">Real&nbsp;</td>
          <td class="paramname"> <em>epsfcn</em> = <code>1e-8</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&nbsp;</td>
          <td class="paramname"> <em>ftol</em> = <code>1e-8</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&nbsp;</td>
          <td class="paramname"> <em>xtol</em> = <code>1e-8</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&nbsp;</td>
          <td class="paramname"> <em>gtol</em> = <code>1e-8</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Size&nbsp;</td>
          <td class="paramname"> <em>maxfev</em> = <code>400</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor taking as input the characteristic length and tolerance 
</div>
</div><p>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>