File: class_quant_lib_1_1_least_square_function.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 (139 lines) | stat: -rw-r--r-- 8,786 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
<!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: LeastSquareFunction 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_least_square_function.html">LeastSquareFunction</a></div>
<h1>LeastSquareFunction Class Reference</h1><!-- doxytag: class="QuantLib::LeastSquareFunction" --><!-- doxytag: inherits="QuantLib::CostFunction" --><code>#include &lt;ql/Optimization/leastsquare.hpp&gt;</code>
<p>
Inheritance diagram for LeastSquareFunction:<p><center><img src="class_quant_lib_1_1_least_square_function__inherit__graph.png" border="0" usemap="#_least_square_function__inherit__map" alt="Inheritance graph"></center>
<map name="_least_square_function__inherit__map">
<area href="class_quant_lib_1_1_cost_function.html" shape="rect" coords="32,7,141,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_least_square_function-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Cost function for least-square problems. 
<p>
Implements a cost function using the interface provided by the <a class="el" href="class_quant_lib_1_1_least_square_problem.html">LeastSquareProblem</a> class. 
<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"><a class="anchor" name="91ae7b7c34f4f00ae7272c5e5cbf8ead"></a><!-- doxytag: member="QuantLib::LeastSquareFunction::LeastSquareFunction" ref="91ae7b7c34f4f00ae7272c5e5cbf8ead" args="(LeastSquareProblem &amp;lsp)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_least_square_function.html#91ae7b7c34f4f00ae7272c5e5cbf8ead">LeastSquareFunction</a> (<a class="el" href="class_quant_lib_1_1_least_square_problem.html">LeastSquareProblem</a> &amp;lsp)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c9195cf76ac701b3e3e667d568dec6c"></a><!-- doxytag: member="QuantLib::LeastSquareFunction::~LeastSquareFunction" ref="4c9195cf76ac701b3e3e667d568dec6c" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_least_square_function.html#4c9195cf76ac701b3e3e667d568dec6c">~LeastSquareFunction</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5ab0d029d0c5f74be2bb060e7e8aa2b"></a><!-- doxytag: member="QuantLib::LeastSquareFunction::value" ref="a5ab0d029d0c5f74be2bb060e7e8aa2b" args="(const Array &amp;x) const" -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_least_square_function.html#a5ab0d029d0c5f74be2bb060e7e8aa2b">value</a> (const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute value of the least square function <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7794b074efe8cdfec946cf2c1230198f"></a><!-- doxytag: member="QuantLib::LeastSquareFunction::gradient" ref="7794b074efe8cdfec946cf2c1230198f" args="(Array &amp;grad_f, const Array &amp;x) const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_least_square_function.html#7794b074efe8cdfec946cf2c1230198f">gradient</a> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;grad_f, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute vector of derivatives of the least square function <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bda0182739a19b9db365d89a647bf13e"></a><!-- doxytag: member="QuantLib::LeastSquareFunction::valueAndGradient" ref="bda0182739a19b9db365d89a647bf13e" args="(Array &amp;grad_f, const Array &amp;x) const " -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_least_square_function.html#bda0182739a19b9db365d89a647bf13e">valueAndGradient</a> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;grad_f, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute value and gradient of the least square function <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ca97a82dfecae75d32b5bbbf9e8f6db"></a><!-- doxytag: member="QuantLib::LeastSquareFunction::lsp_" ref="9ca97a82dfecae75d32b5bbbf9e8f6db" args="" -->
<a class="el" href="class_quant_lib_1_1_least_square_problem.html">LeastSquareProblem</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_least_square_function.html#9ca97a82dfecae75d32b5bbbf9e8f6db">lsp_</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">least square problem <br></td></tr>
</table>

</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>