~ubuntu-branches/ubuntu/wily/quantlib-refman-html/wily

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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<!-- HTML header for doxygen 1.8.9.1-->
<!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.9.1"/>
<title>QuantLib: LMMCurveState Class Reference</title>
<link href='http://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/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() {
    if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); }
  });
</script>
<link rel="search" href="search_opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="QuantLib"/>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="file://usr/share/javascript/mathjax/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 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.6</div>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
          <div class="left">
            <form id="FSearchBox" action="search.php" method="get">
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
            </form>
          </div><div class="right"></div>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </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_l_m_m_curve_state.html">LMMCurveState</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_l_m_m_curve_state-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">LMMCurveState Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Curve state for Libor market models  
 <a href="class_quant_lib_1_1_l_m_m_curve_state.html#details">More...</a></p>

<p><code>#include &lt;ql/models/marketmodels/curvestates/lmmcurvestate.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 LMMCurveState:</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_l_m_m_curve_state__inherit__graph.png" border="0" usemap="#_l_m_m_curve_state_inherit__map" alt="Inheritance graph"/></div>
<map name="_l_m_m_curve_state_inherit__map" id="_l_m_m_curve_state_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_curve_state.html" title="Curve state for market&#45;model simulations " alt="" coords="20,5,108,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:aa16287775199c7833a917a13056d6ba3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa16287775199c7833a917a13056d6ba3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LMMCurveState</b> (const std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;rateTimes)</td></tr>
<tr class="separator:aa16287775199c7833a917a13056d6ba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c46c0cde27036afcca8fe94bf19101d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c46c0cde27036afcca8fe94bf19101d"></a>
std::auto_ptr&lt; <a class="el" href="class_quant_lib_1_1_curve_state.html">CurveState</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>clone</b> () const </td></tr>
<tr class="separator:a8c46c0cde27036afcca8fe94bf19101d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Modifiers</div></td></tr>
<tr class="memitem:a2a7efc69b227a42bdd3f004156bdfe4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a7efc69b227a42bdd3f004156bdfe4e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setOnForwardRates</b> (const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;fwdRates, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> firstValidIndex=0)</td></tr>
<tr class="separator:a2a7efc69b227a42bdd3f004156bdfe4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d678ab710d9435a15077fe053ed758b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d678ab710d9435a15077fe053ed758b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setOnDiscountRatios</b> (const std::vector&lt; <a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> &gt; &amp;discRatios, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> firstValidIndex=0)</td></tr>
<tr class="separator:a2d678ab710d9435a15077fe053ed758b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr class="memitem:aba827b05a0086533a68c6c2862351d08"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba827b05a0086533a68c6c2862351d08"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>discountRatio</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> j) const </td></tr>
<tr class="separator:aba827b05a0086533a68c6c2862351d08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac1391a5c503e87b171babebba6d4a60"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac1391a5c503e87b171babebba6d4a60"></a>
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>forwardRate</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>
<tr class="separator:aac1391a5c503e87b171babebba6d4a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abec96ff6545d6cd3be5d3eaef0dbd0a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abec96ff6545d6cd3be5d3eaef0dbd0a8"></a>
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>coterminalSwapRate</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>
<tr class="separator:abec96ff6545d6cd3be5d3eaef0dbd0a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea7368686f038e0fdbc9341faf4003a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea7368686f038e0fdbc9341faf4003a6"></a>
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>coterminalSwapAnnuity</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> numeraire, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>
<tr class="separator:aea7368686f038e0fdbc9341faf4003a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee06bd7c4e552385a9f4e9720b5e6b01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee06bd7c4e552385a9f4e9720b5e6b01"></a>
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cmSwapRate</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> spanningForwards) const </td></tr>
<tr class="separator:aee06bd7c4e552385a9f4e9720b5e6b01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae62cf5e5050a7c480b620a7ec2d104d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae62cf5e5050a7c480b620a7ec2d104d1"></a>
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cmSwapAnnuity</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> numeraire, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> spanningForwards) const </td></tr>
<tr class="separator:ae62cf5e5050a7c480b620a7ec2d104d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc6fb17a2d2d3c52a5cb79ff094d184"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cc6fb17a2d2d3c52a5cb79ff094d184"></a>
const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>forwardRates</b> () const </td></tr>
<tr class="separator:a5cc6fb17a2d2d3c52a5cb79ff094d184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe78d2bc9f2687c5e31baa486ad2ace5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe78d2bc9f2687c5e31baa486ad2ace5"></a>
const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>coterminalSwapRates</b> () const </td></tr>
<tr class="separator:abe78d2bc9f2687c5e31baa486ad2ace5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2d3c56715486e94144c87531f19fcc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c2d3c56715486e94144c87531f19fcc"></a>
const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>cmSwapRates</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> spanningForwards) const </td></tr>
<tr class="separator:a2c2d3c56715486e94144c87531f19fcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_curve_state"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_curve_state')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_curve_state.html">CurveState</a></td></tr>
<tr class="memitem:a88fd3af37567d6296eb23d2712a9079a inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88fd3af37567d6296eb23d2712a9079a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>CurveState</b> (const std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;rateTimes)</td></tr>
<tr class="separator:a88fd3af37567d6296eb23d2712a9079a inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4f4847a3bfe9c8a8ea499a4e20643cf inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4f4847a3bfe9c8a8ea499a4e20643cf"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>numberOfRates</b> () const </td></tr>
<tr class="separator:ab4f4847a3bfe9c8a8ea499a4e20643cf inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2d70b43df80ed4117064171d7a09cc3 inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2d70b43df80ed4117064171d7a09cc3"></a>
const std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>rateTimes</b> () const </td></tr>
<tr class="separator:ab2d70b43df80ed4117064171d7a09cc3 inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a354ca1793c355a773e185886211db03a inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a354ca1793c355a773e185886211db03a"></a>
const std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>rateTaus</b> () const </td></tr>
<tr class="separator:a354ca1793c355a773e185886211db03a inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cabb9353f71c83cffb42b0fc489a5c2 inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cabb9353f71c83cffb42b0fc489a5c2"></a>
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>swapRate</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> begin, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> end) const </td></tr>
<tr class="separator:a7cabb9353f71c83cffb42b0fc489a5c2 inherit pub_methods_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_curve_state"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_curve_state')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_curve_state.html">CurveState</a></td></tr>
<tr class="memitem:a9c042abcd446925e95dde36619f5bf6d inherit pro_attribs_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c042abcd446925e95dde36619f5bf6d"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>numberOfRates_</b></td></tr>
<tr class="separator:a9c042abcd446925e95dde36619f5bf6d inherit pro_attribs_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c5eaa190a38d0d5e7e28ce0a5dafc6f inherit pro_attribs_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c5eaa190a38d0d5e7e28ce0a5dafc6f"></a>
std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>rateTimes_</b></td></tr>
<tr class="separator:a7c5eaa190a38d0d5e7e28ce0a5dafc6f inherit pro_attribs_class_quant_lib_1_1_curve_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa688289997396acdd1ad9b7c64735213 inherit pro_attribs_class_quant_lib_1_1_curve_state"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa688289997396acdd1ad9b7c64735213"></a>
std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>rateTaus_</b></td></tr>
<tr class="separator:aa688289997396acdd1ad9b7c64735213 inherit pro_attribs_class_quant_lib_1_1_curve_state"><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>Curve state for Libor market models </p>
<p>This class stores the state of the yield curve associated to the fixed calendar times within the simulation. This is the workhorse discounting object associated to the rate times of the simulation. It's important to pass the rates via an object like this to the product rather than directly to make it easier to switch to other engines such as a coterminal swap rate engine. Many products will not need expired rates and others will only require the first rate. </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.9.1
</small></address>
</body>
</html>