File: class_quant_lib_1_1_digital_cms_leg.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 (156 lines) | stat: -rw-r--r-- 17,108 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
<!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>DigitalCmsLeg 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_digital_cms_leg.html">DigitalCmsLeg</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">DigitalCmsLeg Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::DigitalCmsLeg" -->
<p>helper class building a sequence of digital ibor-rate coupons  
 <a href="class_quant_lib_1_1_digital_cms_leg.html#details">More...</a></p>

<p><code>#include &lt;ql/cashflows/digitalcmscoupon.hpp&gt;</code></p>

<p><a href="class_quant_lib_1_1_digital_cms_leg-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="a3d3c95aa083397b1349444f113b98762"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::DigitalCmsLeg" ref="a3d3c95aa083397b1349444f113b98762" args="(const Schedule &amp;schedule, const boost::shared_ptr&lt; SwapIndex &gt; &amp;index)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>DigitalCmsLeg</b> (const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &amp;schedule, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_swap_index.html">SwapIndex</a> &gt; &amp;index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a462a5b39dfde286317f0075143c4530b"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withNotionals" ref="a462a5b39dfde286317f0075143c4530b" args="(Real notional)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withNotionals</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> notional)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a849da33ecb6b0f4123be61fb59bf16dc"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withNotionals" ref="a849da33ecb6b0f4123be61fb59bf16dc" args="(const std::vector&lt; Real &gt; &amp;notionals)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withNotionals</b> (const std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;notionals)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f841210c3b1955a08c8916faa456b88"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPaymentDayCounter" ref="a1f841210c3b1955a08c8916faa456b88" args="(const DayCounter &amp;)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPaymentDayCounter</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4f79815c80b55f3db0cdf9f118f1cad"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPaymentAdjustment" ref="ae4f79815c80b55f3db0cdf9f118f1cad" args="(BusinessDayConvention)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPaymentAdjustment</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="a4d2ba96c0f5281f0737569f3a8910096"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withFixingDays" ref="a4d2ba96c0f5281f0737569f3a8910096" args="(Natural fixingDays)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withFixingDays</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88f7555b31114da432a5f9f3faab2e6e"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withFixingDays" ref="a88f7555b31114da432a5f9f3faab2e6e" args="(const std::vector&lt; Natural &gt; &amp;fixingDays)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withFixingDays</b> (const std::vector&lt; <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> &gt; &amp;fixingDays)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0d7cd5da75156cf4aa623b0cab2c4c4"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withGearings" ref="ac0d7cd5da75156cf4aa623b0cab2c4c4" args="(Real gearing)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withGearings</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> gearing)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29589cae121d3a46e73a7d4cb517c7a0"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withGearings" ref="a29589cae121d3a46e73a7d4cb517c7a0" args="(const std::vector&lt; Real &gt; &amp;gearings)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withGearings</b> (const std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;gearings)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7382252f5c4f22f1cba20bbc707c108"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withSpreads" ref="ad7382252f5c4f22f1cba20bbc707c108" args="(Spread spread)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withSpreads</b> (<a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> spread)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a037fcf2259da2796366cf33f17bb3794"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withSpreads" ref="a037fcf2259da2796366cf33f17bb3794" args="(const std::vector&lt; Spread &gt; &amp;spreads)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withSpreads</b> (const std::vector&lt; <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt; &amp;spreads)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a981b3cddc159c0a2dda8b629afe6602f"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::inArrears" ref="a981b3cddc159c0a2dda8b629afe6602f" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>inArrears</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a971b451a6768e0d2d1dca1c9148a8786"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withCallStrikes" ref="a971b451a6768e0d2d1dca1c9148a8786" args="(Rate strike)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withCallStrikes</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> strike)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4032dd47e1e991c5034e0b19a57a2172"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withCallStrikes" ref="a4032dd47e1e991c5034e0b19a57a2172" args="(const std::vector&lt; Rate &gt; &amp;strikes)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withCallStrikes</b> (const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;strikes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e5e790d9e233e66be3c27b8c6bc548b"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withLongCallOption" ref="a9e5e790d9e233e66be3c27b8c6bc548b" args="(Position::Type)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withLongCallOption</b> (Position::Type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23a9a1bf861c4d0711aad4300f61cf10"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withCallATM" ref="a23a9a1bf861c4d0711aad4300f61cf10" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withCallATM</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab52b3f01181a28f53ea5753ae1fac670"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withCallPayoffs" ref="ab52b3f01181a28f53ea5753ae1fac670" args="(Rate payoff)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withCallPayoffs</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> payoff)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdad13e13590b45fd66d835483132075"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withCallPayoffs" ref="afdad13e13590b45fd66d835483132075" args="(const std::vector&lt; Rate &gt; &amp;payoffs)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withCallPayoffs</b> (const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;payoffs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa642aedf68b7a27999cb046a9f5caa10"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPutStrikes" ref="aa642aedf68b7a27999cb046a9f5caa10" args="(Rate strike)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPutStrikes</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> strike)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18b38448e6e104b75195cf661ffa3abe"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPutStrikes" ref="a18b38448e6e104b75195cf661ffa3abe" args="(const std::vector&lt; Rate &gt; &amp;strikes)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPutStrikes</b> (const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;strikes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6156ce68640cde1f80be7d4f60132f8f"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withLongPutOption" ref="a6156ce68640cde1f80be7d4f60132f8f" args="(Position::Type)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withLongPutOption</b> (Position::Type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0978a2bfbfdd24c9a3273abfe6841639"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPutATM" ref="a0978a2bfbfdd24c9a3273abfe6841639" args="(bool flag=true)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPutATM</b> (bool flag=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7b28551343e1c199e7c6c2f72a4773d"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPutPayoffs" ref="aa7b28551343e1c199e7c6c2f72a4773d" args="(Rate payoff)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPutPayoffs</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> payoff)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8094803b11cd4b9b9c1401767492697"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withPutPayoffs" ref="ad8094803b11cd4b9b9c1401767492697" args="(const std::vector&lt; Rate &gt; &amp;payoffs)" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPutPayoffs</b> (const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;payoffs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab04460f82029cf90140591a068229fc6"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::withReplication" ref="ab04460f82029cf90140591a068229fc6" args="(const boost::shared_ptr&lt; DigitalReplication &gt; &amp;replication=boost::shared_ptr&lt; DigitalReplication &gt;())" -->
<a class="el" href="class_quant_lib_1_1_digital_cms_leg.html">DigitalCmsLeg</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withReplication</b> (const boost::shared_ptr&lt; DigitalReplication &gt; &amp;replication=boost::shared_ptr&lt; DigitalReplication &gt;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab90967eddf8d006442846cf44ea38756"></a><!-- doxytag: member="QuantLib::DigitalCmsLeg::operator Leg" ref="ab90967eddf8d006442846cf44ea38756" args="() const " -->
&#160;</td><td class="memItemRight" valign="bottom"><b>operator Leg</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>helper class building a sequence of digital ibor-rate coupons </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>