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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta name="robots" content="none">
<title>QuantLib: CostFunction 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.9.0</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="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="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="examples.html">Examples</a></li>
</ul>
</div>
<div id="content">
<!--Doxygen-generated content-->
<!-- Generated by Doxygen 1.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_cost_function.html">CostFunction</a></div>
<h1>CostFunction Class Reference</h1><!-- doxytag: class="QuantLib::CostFunction" --><code>#include <ql/math/optimization/costfunction.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for CostFunction:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_cost_function__inherit__graph.png" border="0" usemap="#_cost_function__inherit__map" alt="Inheritance graph"></center>
<map name="_cost_function__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_least_square_function.html" title="Cost function for least-square problems." alt="" coords="5,84,163,111"><area shape="rect" href="class_quant_lib_1_1_projected_cost_function.html" title="Parameterized cost function." alt="" coords="187,84,352,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_cost_function-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Cost function abstract class for optimization problem. <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="132cbe03016a6e22c2ad3eaef6baf6a1"></a><!-- doxytag: member="QuantLib::CostFunction::value" ref="132cbe03016a6e22c2ad3eaef6baf6a1" args="(const Array &x) const =0" -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_cost_function.html#132cbe03016a6e22c2ad3eaef6baf6a1">value</a> (const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">method to overload to compute the cost function value in x <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81d6a6e85cd18eea72bb0b7d6c6fd8ff"></a><!-- doxytag: member="QuantLib::CostFunction::values" ref="81d6a6e85cd18eea72bb0b7d6c6fd8ff" args="(const Array &x) const =0" -->
virtual <a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_cost_function.html#81d6a6e85cd18eea72bb0b7d6c6fd8ff">values</a> (const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">method to overload to compute the cost function values in x <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6eb1b006aa9ceb4327ec7d4dd56f899"></a><!-- doxytag: member="QuantLib::CostFunction::gradient" ref="b6eb1b006aa9ceb4327ec7d4dd56f899" args="(Array &grad, const Array &x) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_cost_function.html#b6eb1b006aa9ceb4327ec7d4dd56f899">gradient</a> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &grad, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">method to overload to compute grad_f, the first derivative of <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74bd7b501afc6cf31871d208ef57fe0a"></a><!-- doxytag: member="QuantLib::CostFunction::valueAndGradient" ref="74bd7b501afc6cf31871d208ef57fe0a" args="(Array &grad, const Array &x) const " -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_cost_function.html#74bd7b501afc6cf31871d208ef57fe0a">valueAndGradient</a> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &grad, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">method to overload to compute grad_f, the first derivative of <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="66ef2bf7179eda5017589d6f8fc90ed7"></a><!-- doxytag: member="QuantLib::CostFunction::finiteDifferenceEpsilon" ref="66ef2bf7179eda5017589d6f8fc90ed7" args="() const " -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_cost_function.html#66ef2bf7179eda5017589d6f8fc90ed7">finiteDifferenceEpsilon</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default epsilon for finite difference method :. <br></td></tr>
</table>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|