File: class_quant_lib_1_1_optionlet_stripper2.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (138 lines) | stat: -rw-r--r-- 8,047 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
<!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>OptionletStripper2 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="185" height="50" 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 1.2</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="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="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="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_optionlet_stripper2.html">OptionletStripper2</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">OptionletStripper2 Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::OptionletStripper2" --><!-- doxytag: inherits="QuantLib::OptionletStripper" -->
<p><code>#include &lt;ql/termstructures/volatility/optionlet/optionletstripper2.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OptionletStripper2:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_optionlet_stripper2__inherit__graph.png" border="0" usemap="#_optionlet_stripper2_inherit__map" alt="Inheritance graph"/></div>
<map name="_optionlet_stripper2_inherit__map" id="_optionlet_stripper2_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_optionlet_stripper.html" title="OptionletStripper" alt="" coords="9,6,127,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_optionlet_stripper2-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66a507e7be07efad7c13ef1caa92a9c4"></a><!-- doxytag: member="QuantLib::OptionletStripper2::OptionletStripper2" ref="a66a507e7be07efad7c13ef1caa92a9c4" args="(const boost::shared_ptr&lt; OptionletStripper1 &gt; &amp;optionletStripper1, const Handle&lt; CapFloorTermVolCurve &gt; &amp;atmCapFloorTermVolCurve)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>OptionletStripper2</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_optionlet_stripper1.html">OptionletStripper1</a> &gt; &amp;optionletStripper1, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_cap_floor_term_vol_curve.html">CapFloorTermVolCurve</a> &gt; &amp;atmCapFloorTermVolCurve)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a001790f551d32100e8098a76d12e5cd9"></a><!-- doxytag: member="QuantLib::OptionletStripper2::atmCapFloorStrikes" ref="a001790f551d32100e8098a76d12e5cd9" args="() const " -->
std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>atmCapFloorStrikes</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaebdf5a0002fce7fd614b57066562684"></a><!-- doxytag: member="QuantLib::OptionletStripper2::atmCapFloorPrices" ref="aaebdf5a0002fce7fd614b57066562684" args="() const " -->
std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>atmCapFloorPrices</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6befe85f9d38ab74922bc50f8a9370c"></a><!-- doxytag: member="QuantLib::OptionletStripper2::spreadsVol" ref="ad6befe85f9d38ab74922bc50f8a9370c" args="() const " -->
std::vector&lt; <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>spreadsVol</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">LazyObject interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_optionlet_stripper2.html#a02b90bbfee3ee29627939544fb59ec93">performCalculations</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Helper class to extend an <a class="el" href="class_quant_lib_1_1_optionlet_stripper1.html">OptionletStripper1</a> object stripping additional optionlet (i.e. caplet/floorlet) volatilities (a.k.a. forward-forward volatilities) from the (cap/floor) At-The-Money term volatilities of a <a class="el" href="class_quant_lib_1_1_cap_floor_term_vol_curve.html" title="Cap/floor at-the-money term-volatility vector.">CapFloorTermVolCurve</a>. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a02b90bbfee3ee29627939544fb59ec93"></a><!-- doxytag: member="QuantLib::OptionletStripper2::performCalculations" ref="a02b90bbfee3ee29627939544fb59ec93" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_optionlet_stripper2.html#a02b90bbfee3ee29627939544fb59ec93">performCalculations</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method must implement any calculations which must be (re)done in order to calculate the desired results. </p>

<p>Implements <a class="el" href="class_quant_lib_1_1_lazy_object.html#a572dbe926524786c64db01e31dba7ab8">LazyObject</a>.</p>

</div>
</div>
</div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>