File: class_quant_lib_1_1_make_vanilla_swap.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 (170 lines) | stat: -rw-r--r-- 17,944 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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!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: MakeVanillaSwap 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_make_vanilla_swap.html">MakeVanillaSwap</a></div>
<h1>MakeVanillaSwap Class Reference</h1><!-- doxytag: class="QuantLib::MakeVanillaSwap" --><code>#include &lt;ql/instruments/makevanillaswap.hpp&gt;</code>
<p>

<p>
<a href="class_quant_lib_1_1_make_vanilla_swap-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
helper class 
<p>
This class provides a more comfortable way to instantiate standard market swap. <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="11394a249b26d0a09ad155c225296f9c"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::MakeVanillaSwap" ref="11394a249b26d0a09ad155c225296f9c" args="(const Period &amp;swapTenor, const boost::shared_ptr&lt; IborIndex &gt; &amp;index, Rate fixedRate=Null&lt; Rate &gt;(), const Period &amp;forwardStart=0 *Days)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>MakeVanillaSwap</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;swapTenor, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;index, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> fixedRate=<a class="el" href="class_quant_lib_1_1_null.html">Null</a>&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt;(), const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;forwardStart=0 *Days)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc2916511ef852e27ef385689a882810"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::operator VanillaSwap" ref="fc2916511ef852e27ef385689a882810" args="() const " -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator VanillaSwap</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72b80dd9ade456887a1b5c34df7b7895"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::operator boost::shared_ptr&lt; VanillaSwap &gt;" ref="72b80dd9ade456887a1b5c34df7b7895" args="() const " -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator boost::shared_ptr&lt; VanillaSwap &gt;</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1d92b1e7fc4a3db977740df16642a40"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::receiveFixed" ref="b1d92b1e7fc4a3db977740df16642a40" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>receiveFixed</b> (bool flag=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29326b18d03c2afe15487466512351a7"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withType" ref="29326b18d03c2afe15487466512351a7" args="(VanillaSwap::Type type)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withType</b> (VanillaSwap::Type type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6903d91214d2dcd8b348f5acaa7e1ea"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withNominal" ref="a6903d91214d2dcd8b348f5acaa7e1ea" args="(Real n)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withNominal</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> n)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b4d1104ab63df2c92186679b583f40f"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withEffectiveDate" ref="7b4d1104ab63df2c92186679b583f40f" args="(const Date &amp;)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withEffectiveDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="068f530309e704bd5738f6016b45323c"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegTenor" ref="068f530309e704bd5738f6016b45323c" args="(const Period &amp;t)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegTenor</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;t)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="88bfe641d2317ff8e6a537b7478dc0e9"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegCalendar" ref="88bfe641d2317ff8e6a537b7478dc0e9" args="(const Calendar &amp;cal)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegCalendar</b> (const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;cal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5c461f3d0b94d3eac490f6e8384b35a"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegConvention" ref="c5c461f3d0b94d3eac490f6e8384b35a" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegConvention</b> (<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad4b1bec31b77aefe3a2173d5070138a"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegTerminationDateConvention" ref="ad4b1bec31b77aefe3a2173d5070138a" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegTerminationDateConvention</b> (<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="593a60b393a652c96c87117a147136d5"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegRule" ref="593a60b393a652c96c87117a147136d5" args="(DateGeneration::Rule r)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegRule</b> (<a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a> r)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d15c7e584c167640d94fdf398cb2b589"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegEndOfMonth" ref="d15c7e584c167640d94fdf398cb2b589" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegEndOfMonth</b> (bool flag=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d72db29d9ffe88e5370437a9fb1c4a33"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegFirstDate" ref="d72db29d9ffe88e5370437a9fb1c4a33" args="(const Date &amp;d)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegFirstDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39eb16b1b314adc3c4a6cd39f75765b7"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegNextToLastDate" ref="39eb16b1b314adc3c4a6cd39f75765b7" args="(const Date &amp;d)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegNextToLastDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a032b408c945364fc78010cceb7d3cb"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFixedLegDayCount" ref="0a032b408c945364fc78010cceb7d3cb" args="(const DayCounter &amp;dc)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFixedLegDayCount</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7224c2a0d5fc6993c310773a88bbd269"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegTenor" ref="7224c2a0d5fc6993c310773a88bbd269" args="(const Period &amp;t)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegTenor</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;t)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0294e4391f4f2e183dc47bcb762885be"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegCalendar" ref="0294e4391f4f2e183dc47bcb762885be" args="(const Calendar &amp;cal)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegCalendar</b> (const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;cal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb558392bbaf05ed4efb7f368aa8a0e2"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegConvention" ref="bb558392bbaf05ed4efb7f368aa8a0e2" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegConvention</b> (<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a5ee54ad82b31f61a8121682aab0278"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegTerminationDateConvention" ref="7a5ee54ad82b31f61a8121682aab0278" args="(BusinessDayConvention bdc)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegTerminationDateConvention</b> (<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a099ca8aa763d0b6b5eafa8e7321735"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegRule" ref="0a099ca8aa763d0b6b5eafa8e7321735" args="(DateGeneration::Rule r)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegRule</b> (<a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a> r)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38dad0cdc3897aadc954c9ae107ac3fc"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegEndOfMonth" ref="38dad0cdc3897aadc954c9ae107ac3fc" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegEndOfMonth</b> (bool flag=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea4ab586a9b7b24bec2307c17836ddbd"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegFirstDate" ref="ea4ab586a9b7b24bec2307c17836ddbd" args="(const Date &amp;d)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegFirstDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2933f80f79f9f2175aeb767cd6e13b02"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegNextToLastDate" ref="2933f80f79f9f2175aeb767cd6e13b02" args="(const Date &amp;d)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegNextToLastDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="528ad9d266aa68073a2fc85c37181fe9"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegDayCount" ref="528ad9d266aa68073a2fc85c37181fe9" args="(const DayCounter &amp;dc)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegDayCount</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="148b22872218da556a36153a25accebe"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withFloatingLegSpread" ref="148b22872218da556a36153a25accebe" args="(Spread sp)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withFloatingLegSpread</b> (<a class="el" href="group__types.html#ge7427f4743503002b0c6eeeefae91a3d">Spread</a> sp)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52a40557f3d4c639441a1e475c4adf2e"></a><!-- doxytag: member="QuantLib::MakeVanillaSwap::withDiscountingTermStructure" ref="52a40557f3d4c639441a1e475c4adf2e" args="(const Handle&lt; YieldTermStructure &gt; &amp;discountingTermStructure)" -->
<a class="el" href="class_quant_lib_1_1_make_vanilla_swap.html">MakeVanillaSwap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>withDiscountingTermStructure</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;discountingTermStructure)</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>