File: class_quant_lib_1_1_constrained_evolver.html

package info (click to toggle)
quantlib-refman-html 1.20-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 103,140 kB
  • sloc: javascript: 13,408; makefile: 35
file content (148 lines) | stat: -rw-r--r-- 11,537 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: ConstrainedEvolver Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://quantlib.org">
       <img alt="QuantLib" src="QL-title.jpg"></a>
   <div id="projectbrief">A free/open-source library for quantitative finance</div>
   <div id="projectnumber">Reference manual - version 1.20</div>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_constrained_evolver.html">ConstrainedEvolver</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_quant_lib_1_1_constrained_evolver-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ConstrainedEvolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Constrained market-model evolver.  
 <a href="class_quant_lib_1_1_constrained_evolver.html#details">More...</a></p>

<p><code>#include &lt;ql/models/marketmodels/constrainedevolver.hpp&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ConstrainedEvolver:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_quant_lib_1_1_constrained_evolver__inherit__graph.png" border="0" usemap="#a_constrained_evolver_inherit__map" alt="Inheritance graph"/></div>
<map name="_constrained_evolver_inherit__map" id="a_constrained_evolver_inherit__map">
<area shape="rect" title="Constrained market&#45;model evolver." alt="" coords="57,80,193,107"/>
<area shape="rect" href="class_quant_lib_1_1_log_normal_fwd_rate_euler_constrained.html" title="euler stepping" alt="" coords="5,155,244,181"/>
<area shape="rect" href="class_quant_lib_1_1_market_model_evolver.html" title="Market&#45;model evolver." alt="" coords="54,5,195,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a72f1f210b87697658d04a4580e8d451c"><td class="memItemLeft" align="right" valign="top"><a id="a72f1f210b87697658d04a4580e8d451c"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constrained_evolver.html#a72f1f210b87697658d04a4580e8d451c">setConstraintType</a> (const std::vector&lt; <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> &gt; &amp;startIndexOfSwapRate, const std::vector&lt; <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> &gt; &amp;EndIndexOfSwapRate)=0</td></tr>
<tr class="memdesc:a72f1f210b87697658d04a4580e8d451c"><td class="mdescLeft">&#160;</td><td class="mdescRight">call once <br /></td></tr>
<tr class="separator:a72f1f210b87697658d04a4580e8d451c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39d0015d10b643e28baba86edcd66b0a"><td class="memItemLeft" align="right" valign="top"><a id="a39d0015d10b643e28baba86edcd66b0a"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constrained_evolver.html#a39d0015d10b643e28baba86edcd66b0a">setThisConstraint</a> (const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;rateConstraints, const std::valarray&lt; bool &gt; &amp;isConstraintActive)=0</td></tr>
<tr class="memdesc:a39d0015d10b643e28baba86edcd66b0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">call before each path <br /></td></tr>
<tr class="separator:a39d0015d10b643e28baba86edcd66b0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_market_model_evolver"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_market_model_evolver')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_market_model_evolver.html">MarketModelEvolver</a></td></tr>
<tr class="memitem:adb4ceea26c9274fc282a70be25a6b619 inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memItemLeft" align="right" valign="top"><a id="adb4ceea26c9274fc282a70be25a6b619"></a>
virtual const std::vector&lt; <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>numeraires</b> () const =0</td></tr>
<tr class="separator:adb4ceea26c9274fc282a70be25a6b619 inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1c69e6aa71f890350ca8abcb15b0763 inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memItemLeft" align="right" valign="top"><a id="ad1c69e6aa71f890350ca8abcb15b0763"></a>
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>startNewPath</b> ()=0</td></tr>
<tr class="separator:ad1c69e6aa71f890350ca8abcb15b0763 inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6aee9def9c9ccdc14907fb93fb96631c inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memItemLeft" align="right" valign="top"><a id="a6aee9def9c9ccdc14907fb93fb96631c"></a>
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>advanceStep</b> ()=0</td></tr>
<tr class="separator:a6aee9def9c9ccdc14907fb93fb96631c inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac01af761e87531c158e375b36520bdcf inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memItemLeft" align="right" valign="top"><a id="ac01af761e87531c158e375b36520bdcf"></a>
virtual <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>currentStep</b> () const =0</td></tr>
<tr class="separator:ac01af761e87531c158e375b36520bdcf inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7e44f09b21966a9dab1e65674346ecd inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memItemLeft" align="right" valign="top"><a id="ac7e44f09b21966a9dab1e65674346ecd"></a>
virtual const <a class="el" href="class_quant_lib_1_1_curve_state.html">CurveState</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>currentState</b> () const =0</td></tr>
<tr class="separator:ac7e44f09b21966a9dab1e65674346ecd inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5880f2c1b2a8457b76064ffe83e2590 inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memItemLeft" align="right" valign="top"><a id="ad5880f2c1b2a8457b76064ffe83e2590"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setInitialState</b> (const <a class="el" href="class_quant_lib_1_1_curve_state.html">CurveState</a> &amp;)=0</td></tr>
<tr class="separator:ad5880f2c1b2a8457b76064ffe83e2590 inherit pub_methods_class_quant_lib_1_1_market_model_evolver"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Constrained market-model evolver. </p>
<p>Abstract base class. Requires extra methods above that of marketmodelevolver to let you fix rates via importance sampling.</p>
<p>The evolver does the actual gritty work of evolving the forward rates from one time to the next.</p>
<p>This is intended to be used for the Fries-Joshi proxy simulation approach to <a class="el" href="class_quant_lib_1_1_greeks.html" title="additional option results">Greeks</a> </p>
</div></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>