File: class_quant_lib_1_1_curve_state.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (152 lines) | stat: -rw-r--r-- 13,882 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
<!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: CurveState 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_curve_state.html">CurveState</a></div>
<h1>CurveState Class Reference</h1><!-- doxytag: class="QuantLib::CurveState" --><code>#include &lt;ql/models/marketmodels/curvestate.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for CurveState:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_curve_state__inherit__graph.png" border="0" usemap="#_curve_state__inherit__map" alt="Inheritance graph"></center>
<map name="_curve_state__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_c_m_swap_curve_state.html" title="Curve state for constant&#45;maturity&#45;swap market models" alt="" coords="5,84,160,111"><area shape="rect" href="class_quant_lib_1_1_coterminal_swap_curve_state.html" title="Curve state for coterminal&#45;swap market models" alt="" coords="184,84,389,111"><area shape="rect" href="class_quant_lib_1_1_l_m_m_curve_state.html" title="Curve state for Libor market models" alt="" coords="413,84,541,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_curve_state-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Curve state for market-model simulations 
<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. <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="88fd3af37567d6296eb23d2712a9079a"></a><!-- doxytag: member="QuantLib::CurveState::CurveState" ref="88fd3af37567d6296eb23d2712a9079a" args="(const std::vector&lt; Time &gt; &amp;rateTimes)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>CurveState</b> (const std::vector&lt; <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;rateTimes)</td></tr>

<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4f4847a3bfe9c8a8ea499a4e20643cf"></a><!-- doxytag: member="QuantLib::CurveState::numberOfRates" ref="b4f4847a3bfe9c8a8ea499a4e20643cf" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>numberOfRates</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2d70b43df80ed4117064171d7a09cc3"></a><!-- doxytag: member="QuantLib::CurveState::rateTimes" ref="b2d70b43df80ed4117064171d7a09cc3" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>rateTimes</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="354ca1793c355a773e185886211db03a"></a><!-- doxytag: member="QuantLib::CurveState::rateTaus" ref="354ca1793c355a773e185886211db03a" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>rateTaus</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1be6d8a46ccb12032638385f87d737a"></a><!-- doxytag: member="QuantLib::CurveState::discountRatio" ref="e1be6d8a46ccb12032638385f87d737a" args="(Size i, Size j) const =0" -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>discountRatio</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> j) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42852cb51178279c92bd2398c86bf7f0"></a><!-- doxytag: member="QuantLib::CurveState::forwardRate" ref="42852cb51178279c92bd2398c86bf7f0" args="(Size i) const =0" -->
virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>forwardRate</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1feea35a2e0a42dfc806cb124b569128"></a><!-- doxytag: member="QuantLib::CurveState::coterminalSwapAnnuity" ref="1feea35a2e0a42dfc806cb124b569128" args="(Size numeraire, Size i) const =0" -->
virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>coterminalSwapAnnuity</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> numeraire, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d510c8b5f658567dff23eb907d118b5"></a><!-- doxytag: member="QuantLib::CurveState::coterminalSwapRate" ref="9d510c8b5f658567dff23eb907d118b5" args="(Size i) const =0" -->
virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>coterminalSwapRate</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad39df5f2eb1d2e82e27bfd7cbf7bfde"></a><!-- doxytag: member="QuantLib::CurveState::cmSwapAnnuity" ref="ad39df5f2eb1d2e82e27bfd7cbf7bfde" args="(Size numeraire, Size i, Size spanningForwards) const =0" -->
virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmSwapAnnuity</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> numeraire, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> spanningForwards) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26ad3c6d5d3c59dace9997d18251f733"></a><!-- doxytag: member="QuantLib::CurveState::cmSwapRate" ref="26ad3c6d5d3c59dace9997d18251f733" args="(Size i, Size spanningForwards) const =0" -->
virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmSwapRate</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> spanningForwards) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="943f9270e4109d9730df315863246349"></a><!-- doxytag: member="QuantLib::CurveState::forwardRates" ref="943f9270e4109d9730df315863246349" args="() const =0" -->
virtual const std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>forwardRates</b> () const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f917754216210a5e5ffca04bff64bebd"></a><!-- doxytag: member="QuantLib::CurveState::coterminalSwapRates" ref="f917754216210a5e5ffca04bff64bebd" args="() const =0" -->
virtual const std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>coterminalSwapRates</b> () const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dc0f55707fcc9c01bd6a8610b0da7c5"></a><!-- doxytag: member="QuantLib::CurveState::cmSwapRates" ref="7dc0f55707fcc9c01bd6a8610b0da7c5" args="(Size spanningForwards) const =0" -->
virtual const std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmSwapRates</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> spanningForwards) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7cabb9353f71c83cffb42b0fc489a5c2"></a><!-- doxytag: member="QuantLib::CurveState::swapRate" ref="7cabb9353f71c83cffb42b0fc489a5c2" args="(Size begin, Size end) const " -->
<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>swapRate</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> begin, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> end) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4251f8df2d9997d128346d29af2080a"></a><!-- doxytag: member="QuantLib::CurveState::clone" ref="c4251f8df2d9997d128346d29af2080a" args="() const =0" -->
virtual std::auto_ptr&lt; <a class="el" href="class_quant_lib_1_1_curve_state.html">CurveState</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>clone</b> () const =0</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="9c042abcd446925e95dde36619f5bf6d"></a><!-- doxytag: member="QuantLib::CurveState::numberOfRates_" ref="9c042abcd446925e95dde36619f5bf6d" args="" -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>numberOfRates_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c5eaa190a38d0d5e7e28ce0a5dafc6f"></a><!-- doxytag: member="QuantLib::CurveState::rateTimes_" ref="7c5eaa190a38d0d5e7e28ce0a5dafc6f" args="" -->
std::vector&lt; <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>rateTimes_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a688289997396acdd1ad9b7c64735213"></a><!-- doxytag: member="QuantLib::CurveState::rateTaus_" ref="a688289997396acdd1ad9b7c64735213" args="" -->
std::vector&lt; <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>rateTaus_</b></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>