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
|
<!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>MakeCms 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_cms.html">MakeCms</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">MakeCms Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::MakeCms" -->
<p>helper class for instantiating CMS
<a href="class_quant_lib_1_1_make_cms.html#details">More...</a></p>
<p><code>#include <ql/instruments/makecms.hpp></code></p>
<p><a href="class_quant_lib_1_1_make_cms-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="a5e9642c6c47bfe0eb04fb5f6557e15c7"></a><!-- doxytag: member="QuantLib::MakeCms::MakeCms" ref="a5e9642c6c47bfe0eb04fb5f6557e15c7" args="(const Period &swapTenor, const boost::shared_ptr< SwapIndex > &swapIndex, const boost::shared_ptr< IborIndex > &iborIndex, Spread iborSpread=0.0, const Period &forwardStart=0 *Days)" -->
 </td><td class="memItemRight" valign="bottom"><b>MakeCms</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &swapTenor, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_swap_index.html">SwapIndex</a> > &swapIndex, 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#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> iborSpread=0.0, 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="a9666dcaf183598006687827bf7fefc50"></a><!-- doxytag: member="QuantLib::MakeCms::MakeCms" ref="a9666dcaf183598006687827bf7fefc50" args="(const Period &swapTenor, const boost::shared_ptr< SwapIndex > &swapIndex, Spread iborSpread=0.0, const Period &forwardStart=0 *Days)" -->
 </td><td class="memItemRight" valign="bottom"><b>MakeCms</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &swapTenor, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_swap_index.html">SwapIndex</a> > &swapIndex, <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> iborSpread=0.0, 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="ac6bc3d78d2015982e1279472d84c86d6"></a><!-- doxytag: member="QuantLib::MakeCms::operator Swap" ref="ac6bc3d78d2015982e1279472d84c86d6" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><b>operator Swap</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a488a88c3a9889296ca7258294717279c"></a><!-- doxytag: member="QuantLib::MakeCms::operator boost::shared_ptr< Swap >" ref="a488a88c3a9889296ca7258294717279c" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><b>operator boost::shared_ptr< Swap ></b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f7faf86e9261f9597b46876e79b466"></a><!-- doxytag: member="QuantLib::MakeCms::receiveCms" ref="ab0f7faf86e9261f9597b46876e79b466" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>receiveCms</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7d5d6165064265534afd842e0fe6804"></a><!-- doxytag: member="QuantLib::MakeCms::withNominal" ref="ad7d5d6165064265534afd842e0fe6804" args="(Real n)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</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="a11915b9c508bb8e88b00a744e82b2f51"></a><!-- doxytag: member="QuantLib::MakeCms::withEffectiveDate" ref="a11915b9c508bb8e88b00a744e82b2f51" args="(const Date &)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withEffectiveDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad203ea727caeaec318015647b2a7cdd3"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegTenor" ref="ad203ea727caeaec318015647b2a7cdd3" args="(const Period &t)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegTenor</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="a5cd26d419ef5cd1cb7460bcc0e757226"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegCalendar" ref="a5cd26d419ef5cd1cb7460bcc0e757226" args="(const Calendar &cal)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegCalendar</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="a1ab033853e762d6e427211423dde3b75"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegConvention" ref="a1ab033853e762d6e427211423dde3b75" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegConvention</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="a72d52c7d144264547e403cd5714923aa"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegTerminationDateConvention" ref="a72d52c7d144264547e403cd5714923aa" args="(BusinessDayConvention)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegTerminationDateConvention</b> (<a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cb91870cf48558daa02d3e464dae62a"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegRule" ref="a0cb91870cf48558daa02d3e464dae62a" args="(DateGeneration::Rule r)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegRule</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="a071d34edc3bfce03d79441517643593a"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegEndOfMonth" ref="a071d34edc3bfce03d79441517643593a" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegEndOfMonth</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa614d90057ae970e19f5403feab6036e"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegFirstDate" ref="aa614d90057ae970e19f5403feab6036e" args="(const Date &d)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegFirstDate</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="afbb3d30c7e669b6ffcbdddb7baa67eda"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegNextToLastDate" ref="afbb3d30c7e669b6ffcbdddb7baa67eda" args="(const Date &d)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegNextToLastDate</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="a20faf83065f1513b16f95e20f6b1fe8a"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsLegDayCount" ref="a20faf83065f1513b16f95e20f6b1fe8a" args="(const DayCounter &dc)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsLegDayCount</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="aa39eec8e08d6dfdd6379e367c0d83d72"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegTenor" ref="aa39eec8e08d6dfdd6379e367c0d83d72" args="(const Period &t)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegTenor</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="a44d17e40c70f63f9432dd001dc0f7312"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegCalendar" ref="a44d17e40c70f63f9432dd001dc0f7312" args="(const Calendar &cal)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegCalendar</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="a5c18064997ea1476e6b403c9653bc92a"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegConvention" ref="a5c18064997ea1476e6b403c9653bc92a" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegConvention</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="ac983f2ea03c1d729cc1f3c1cd84b8358"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegTerminationDateConvention" ref="ac983f2ea03c1d729cc1f3c1cd84b8358" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegTerminationDateConvention</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="a686ed516427ed95da47589913b5332a4"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegRule" ref="a686ed516427ed95da47589913b5332a4" args="(DateGeneration::Rule r)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegRule</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="a147d945b75fa0206ec5e602f52e34821"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegEndOfMonth" ref="a147d945b75fa0206ec5e602f52e34821" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegEndOfMonth</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab88c7e4f80ccf3739f8b6704f6f93300"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegFirstDate" ref="ab88c7e4f80ccf3739f8b6704f6f93300" args="(const Date &d)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegFirstDate</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="a98c1a2d5b56897a6a45e3b495ce1f513"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegNextToLastDate" ref="a98c1a2d5b56897a6a45e3b495ce1f513" args="(const Date &d)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegNextToLastDate</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="a37a3bca070fbeff246a23d7ae1d9db16"></a><!-- doxytag: member="QuantLib::MakeCms::withFloatingLegDayCount" ref="a37a3bca070fbeff246a23d7ae1d9db16" args="(const DayCounter &dc)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withFloatingLegDayCount</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="a684ebc404def403468bc17600d5765c3"></a><!-- doxytag: member="QuantLib::MakeCms::withAtmSpread" ref="a684ebc404def403468bc17600d5765c3" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withAtmSpread</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac65c5a07ac7e03607acd9da8cf67d938"></a><!-- doxytag: member="QuantLib::MakeCms::withDiscountingTermStructure" ref="ac65c5a07ac7e03607acd9da8cf67d938" args="(const Handle< YieldTermStructure > &discountingTermStructure)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withDiscountingTermStructure</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &discountingTermStructure)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e649eb23ca49fea2b250b120fa1ec4"></a><!-- doxytag: member="QuantLib::MakeCms::withCmsCouponPricer" ref="a37e649eb23ca49fea2b250b120fa1ec4" args="(const boost::shared_ptr< CmsCouponPricer > &couponPricer)" -->
<a class="el" href="class_quant_lib_1_1_make_cms.html">MakeCms</a> & </td><td class="memItemRight" valign="bottom"><b>withCmsCouponPricer</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_cms_coupon_pricer.html">CmsCouponPricer</a> > &couponPricer)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>helper class for instantiating CMS </p>
<p>This class provides a more comfortable way to instantiate standard market constant maturity swap. </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>
|
