File: class_quant_lib_1_1_overnight_indexed_swap.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-- 13,409 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>OvernightIndexedSwap 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_overnight_indexed_swap.html">OvernightIndexedSwap</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">OvernightIndexedSwap Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::OvernightIndexedSwap" --><!-- doxytag: inherits="QuantLib::Swap" -->
<p>Overnight indexed swap: fix vs compounded overnight rate.  
 <a href="class_quant_lib_1_1_overnight_indexed_swap.html#details">More...</a></p>

<p><code>#include &lt;ql/instruments/overnightindexedswap.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OvernightIndexedSwap:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_overnight_indexed_swap__inherit__graph.png" border="0" usemap="#_overnight_indexed_swap_inherit__map" alt="Inheritance graph"/></div>
<map name="_overnight_indexed_swap_inherit__map" id="_overnight_indexed_swap_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_swap.html" title="Interest rate swap." alt="" coords="56,6,109,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_overnight_indexed_swap-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>Receiver</b> =  -1, 
<b>Payer</b> =  1
 }</td></tr>
<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="a89407c6282554fca99c92abfe5be0966"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::OvernightIndexedSwap" ref="a89407c6282554fca99c92abfe5be0966" args="(Type type, Real nominal, const Schedule &amp;schedule, Rate fixedRate, const DayCounter &amp;fixedDC, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex, Spread spread=0.0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>OvernightIndexedSwap</b> (Type type, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> nominal, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &amp;schedule, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> fixedRate, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;fixedDC, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex, <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> spread=0.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1741a0edce85689f3a0597a0fe0c7515"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::OvernightIndexedSwap" ref="a1741a0edce85689f3a0597a0fe0c7515" args="(Type type, std::vector&lt; Real &gt; nominals, const Schedule &amp;schedule, Rate fixedRate, const DayCounter &amp;fixedDC, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex, Spread spread=0.0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>OvernightIndexedSwap</b> (Type type, std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; nominals, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &amp;schedule, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> fixedRate, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;fixedDC, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex, <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> spread=0.0)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbd0fa31db28593e9669c3c56711c0a7"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::type" ref="afbd0fa31db28593e9669c3c56711c0a7" args="() const " -->
Type&#160;</td><td class="memItemRight" valign="bottom"><b>type</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c27f57255d093f0a9c42fb53e991e7d"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::nominal" ref="a0c27f57255d093f0a9c42fb53e991e7d" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>nominal</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f80a768e3cf3e15b9080476e9fcb3ab"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::nominals" ref="a8f80a768e3cf3e15b9080476e9fcb3ab" args="() const " -->
std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>nominals</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a865ebb01241a362567e63527db98dab2"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::paymentFrequency" ref="a865ebb01241a362567e63527db98dab2" args="()" -->
<a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a>&#160;</td><td class="memItemRight" valign="bottom"><b>paymentFrequency</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21ca699ff10159146df2e2673c1cc118"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fixedRate" ref="a21ca699ff10159146df2e2673c1cc118" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fixedRate</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a683c95096eea61b1a1ed14d32288150d"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fixedDayCount" ref="a683c95096eea61b1a1ed14d32288150d" args="()" -->
const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>fixedDayCount</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adba9c35966b6b177d2f6d73bf6ce9cee"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::overnightIndex" ref="adba9c35966b6b177d2f6d73bf6ce9cee" args="()" -->
const boost::shared_ptr<br class="typebreak"/>
&lt; OvernightIndex &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>overnightIndex</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2974165ca4841b20224e8d276227ce9"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::spread" ref="ab2974165ca4841b20224e8d276227ce9" args="()" -->
<a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a>&#160;</td><td class="memItemRight" valign="bottom"><b>spread</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a720acf11b744a6529b383940d01117a6"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fixedLeg" ref="a720acf11b744a6529b383940d01117a6" args="() const " -->
const Leg &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>fixedLeg</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf0b47fac1d94d9b87c77881eb85fbf6"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::overnightLeg" ref="adf0b47fac1d94d9b87c77881eb85fbf6" args="() const " -->
const Leg &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>overnightLeg</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Results</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8299475d045050eb89682c7fa25ca208"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fixedLegBPS" ref="a8299475d045050eb89682c7fa25ca208" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fixedLegBPS</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36e1152928660bd46ffdcdfde8a70e6d"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fixedLegNPV" ref="a36e1152928660bd46ffdcdfde8a70e6d" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fixedLegNPV</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66129d40442a389121feb6e330d54f79"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fairRate" ref="a66129d40442a389121feb6e330d54f79" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fairRate</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a266e13c778bc92a9789393871659b6bd"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::overnightLegBPS" ref="a266e13c778bc92a9789393871659b6bd" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>overnightLegBPS</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a981564829c746af02c1b945c603ee618"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::overnightLegNPV" ref="a981564829c746af02c1b945c603ee618" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>overnightLegNPV</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fed7d028c05630c089b2ae653dd94a7"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwap::fairSpread" ref="a9fed7d028c05630c089b2ae653dd94a7" args="() const " -->
<a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fairSpread</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Overnight indexed swap: fix vs compounded overnight rate. </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>