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>MakeCapFloor 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_make_cap_floor.html">MakeCapFloor</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">MakeCapFloor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::MakeCapFloor" -->
<p>helper class
<a href="class_quant_lib_1_1_make_cap_floor.html#details">More...</a></p>
<p><code>#include <ql/instruments/makecapfloor.hpp></code></p>
<p><a href="class_quant_lib_1_1_make_cap_floor-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="ab701fbc7fe43af2644d4d2eb35bf76c0"></a><!-- doxytag: member="QuantLib::MakeCapFloor::MakeCapFloor" ref="ab701fbc7fe43af2644d4d2eb35bf76c0" args="(CapFloor::Type capFloorType, const Period &capFloorTenor, const boost::shared_ptr< IborIndex > &iborIndex, Rate strike=Null< Rate >(), const Period &forwardStart=0 *Days)" -->
 </td><td class="memItemRight" valign="bottom"><b>MakeCapFloor</b> (CapFloor::Type capFloorType, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &capFloorTenor, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> > &iborIndex, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> strike=Null< <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> >(), const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &forwardStart=0 *Days)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bea6c0ff7c450cbb59ef34df4bffe99"></a><!-- doxytag: member="QuantLib::MakeCapFloor::operator CapFloor" ref="a7bea6c0ff7c450cbb59ef34df4bffe99" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><b>operator CapFloor</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51e4bc45473f4975db2c2e7cee76d3e1"></a><!-- doxytag: member="QuantLib::MakeCapFloor::operator boost::shared_ptr< CapFloor >" ref="a51e4bc45473f4975db2c2e7cee76d3e1" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><b>operator boost::shared_ptr< CapFloor ></b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49da727eac49aa25b7049d97f450add8"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withNominal" ref="a49da727eac49aa25b7049d97f450add8" args="(Real n)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withNominal</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90ba16b56f1b503216c771b350995be5"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withEffectiveDate" ref="a90ba16b56f1b503216c771b350995be5" args="(const Date &effectiveDate, bool firstCapletExcluded)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withEffectiveDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &effectiveDate, bool firstCapletExcluded)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1bd69239e87e1c167e9cfa744e5587f"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withTenor" ref="ae1bd69239e87e1c167e9cfa744e5587f" args="(const Period &t)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withTenor</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5964e56d440144efcdbdfa13a5283e4"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withCalendar" ref="ac5964e56d440144efcdbdfa13a5283e4" args="(const Calendar &cal)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withCalendar</b> (const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &cal)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a886920e731cacfa311f5695959e87d3d"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withConvention" ref="a886920e731cacfa311f5695959e87d3d" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withConvention</b> (<a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99bbc690fab22b6b152102edfa90a6c5"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withTerminationDateConvention" ref="a99bbc690fab22b6b152102edfa90a6c5" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withTerminationDateConvention</b> (<a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55c3222d9f533a17c06d0113ac1c6561"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withRule" ref="a55c3222d9f533a17c06d0113ac1c6561" args="(DateGeneration::Rule r)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withRule</b> (<a class="el" href="struct_quant_lib_1_1_date_generation.html#a11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a> r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad96a772f128ed68485e6a9c8126fb861"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withEndOfMonth" ref="ad96a772f128ed68485e6a9c8126fb861" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withEndOfMonth</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65af3e47e417392a087d62e00cc14cb7"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withFirstDate" ref="a65af3e47e417392a087d62e00cc14cb7" args="(const Date &d)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withFirstDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbc7ed2ce81e3a290410c4d3c9719b5e"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withNextToLastDate" ref="acbc7ed2ce81e3a290410c4d3c9719b5e" args="(const Date &d)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withNextToLastDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a413b379fc70f316436cb7f5895d1262d"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withDayCount" ref="a413b379fc70f316436cb7f5895d1262d" args="(const DayCounter &dc)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withDayCount</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cf891fc8ae3104c048a54e50b329e41"></a><!-- doxytag: member="QuantLib::MakeCapFloor::asOptionlet" ref="a0cf891fc8ae3104c048a54e50b329e41" args="(bool b=true)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_make_cap_floor.html#a0cf891fc8ae3104c048a54e50b329e41">asOptionlet</a> (bool b=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">only get last coupon <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13eea987eb1967c837d05e392bfe34b1"></a><!-- doxytag: member="QuantLib::MakeCapFloor::withPricingEngine" ref="a13eea987eb1967c837d05e392bfe34b1" args="(const boost::shared_ptr< PricingEngine > &engine)" -->
<a class="el" href="class_quant_lib_1_1_make_cap_floor.html">MakeCapFloor</a> & </td><td class="memItemRight" valign="bottom"><b>withPricingEngine</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a> > &engine)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>helper class </p>
<p>This class provides a more comfortable way to instantiate standard market cap and floor. </p>
</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>
|
