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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: AssetSwap 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_asset_swap.html">AssetSwap</a></div>
<h1>AssetSwap Class Reference<br>
<small>
[<a class="el" href="group__instruments.html">Financial instruments</a>]</small>
</h1><!-- doxytag: class="QuantLib::AssetSwap" --><!-- doxytag: inherits="QuantLib::Swap" --><code>#include <ql/Instruments/assetswap.hpp></code>
<p>
Inheritance diagram for AssetSwap:<p><center><img src="class_quant_lib_1_1_asset_swap__inherit__graph.png" border="0" usemap="#_asset_swap__inherit__map" alt="Inheritance graph"></center>
<map name="_asset_swap__inherit__map">
<area href="class_quant_lib_1_1_swap.html" shape="rect" coords="83,231,141,255" alt="">
<area href="class_quant_lib_1_1_instrument.html" shape="rect" coords="64,156,160,180" alt="">
<area href="class_quant_lib_1_1_lazy_object.html" shape="rect" coords="64,81,160,105" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="5,7,104,31" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="128,7,211,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_asset_swap-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Asset swap.
<p>
<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="f8fcaf34262697bf3712ac3573a28f7a"></a><!-- doxytag: member="QuantLib::AssetSwap::AssetSwap" ref="f8fcaf34262697bf3712ac3573a28f7a" args="(bool payFixedRate, const boost::shared_ptr< Bond > &bond, Real bondCleanPrice, const Schedule &floatSchedule, const boost::shared_ptr< Xibor > &index, Spread spread, const DayCounter &floatingDayCount, const Handle< YieldTermStructure > &termStructure)" -->
</td><td class="memItemRight" valign="bottom"><b>AssetSwap</b> (bool payFixedRate, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_bond.html">Bond</a> > &bond, Real bondCleanPrice, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &floatSchedule, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_xibor.html">Xibor</a> > &index, Spread spread, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &floatingDayCount, 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> > &termStructure)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="540021030088610c9e0b0bf50f240f58"></a><!-- doxytag: member="QuantLib::AssetSwap::fairSpread" ref="540021030088610c9e0b0bf50f240f58" args="() const" -->
Spread </td><td class="memItemRight" valign="bottom"><b>fairSpread</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57487a30f418c9db5374e7c48419a0ae"></a><!-- doxytag: member="QuantLib::AssetSwap::floatingLegBPS" ref="57487a30f418c9db5374e7c48419a0ae" args="() const" -->
Real </td><td class="memItemRight" valign="bottom"><b>floatingLegBPS</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5266f847818ee9da40899ba292bf180f"></a><!-- doxytag: member="QuantLib::AssetSwap::fairPrice" ref="5266f847818ee9da40899ba292bf180f" args="() const" -->
Real </td><td class="memItemRight" valign="bottom"><b>fairPrice</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2b1ac06508be31b34a28d76091c0e3f"></a><!-- doxytag: member="QuantLib::AssetSwap::spread" ref="f2b1ac06508be31b34a28d76091c0e3f" args="() const" -->
Spread </td><td class="memItemRight" valign="bottom"><b>spread</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8eee3d3767fab185a6f78d6b406618f5"></a><!-- doxytag: member="QuantLib::AssetSwap::nominal" ref="8eee3d3767fab185a6f78d6b406618f5" args="() const" -->
Real </td><td class="memItemRight" valign="bottom"><b>nominal</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="79c7fb54f18bebae46cd99ad6e4d4ef3"></a><!-- doxytag: member="QuantLib::AssetSwap::payFixedRate" ref="79c7fb54f18bebae46cd99ad6e4d4ef3" args="() const" -->
bool </td><td class="memItemRight" valign="bottom"><b>payFixedRate</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8ab3a253c4fcf94a3e27bc2657c0f2dc"></a><!-- doxytag: member="QuantLib::AssetSwap::bondLeg" ref="8ab3a253c4fcf94a3e27bc2657c0f2dc" args="() const" -->
const std::vector< boost::shared_ptr<<br>
<a class="el" href="class_quant_lib_1_1_cash_flow.html">CashFlow</a> > > & </td><td class="memItemRight" valign="bottom"><b>bondLeg</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d69c45a28ecb82a1dcebcb89937f8075"></a><!-- doxytag: member="QuantLib::AssetSwap::floatingLeg" ref="d69c45a28ecb82a1dcebcb89937f8075" args="() const" -->
const std::vector< boost::shared_ptr<<br>
<a class="el" href="class_quant_lib_1_1_cash_flow.html">CashFlow</a> > > & </td><td class="memItemRight" valign="bottom"><b>floatingLeg</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_asset_swap.html#732a0161d1037a99ff006d5de5c6e0db">setupArguments</a> (<a class="el" href="class_quant_lib_1_1_arguments.html">Arguments</a> *args) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_asset_swap.html#c09d03fe142ca309b1927896da95754c">fetchResults</a> (const <a class="el" href="class_quant_lib_1_1_results.html">Results</a> *) const</td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_asset_swap_1_1arguments.html">arguments</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Arguments for asset swap calculation <a href="class_quant_lib_1_1_asset_swap_1_1arguments.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_asset_swap_1_1results.html">results</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Results from simple swap calculation <a href="class_quant_lib_1_1_asset_swap_1_1results.html#_details">More...</a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="732a0161d1037a99ff006d5de5c6e0db"></a><!-- doxytag: member="QuantLib::AssetSwap::setupArguments" ref="732a0161d1037a99ff006d5de5c6e0db" args="(Arguments *args) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setupArguments </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_quant_lib_1_1_arguments.html">Arguments</a> * </td>
<td class="paramname"> <em>args</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used.
<p>
Reimplemented from <a class="el" href="class_quant_lib_1_1_instrument.html#5343dd1b4e84eb46141f7e3fdd87eb15">Instrument</a>.
</div>
</div><p>
<a class="anchor" name="c09d03fe142ca309b1927896da95754c"></a><!-- doxytag: member="QuantLib::AssetSwap::fetchResults" ref="c09d03fe142ca309b1927896da95754c" args="(const Results *) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fetchResults </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_results.html">Results</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When a derived result structure is defined for an instrument, this method should be overridden to read from it. This is mandatory in case a pricing engine is used.
<p>
Reimplemented from <a class="el" href="class_quant_lib_1_1_instrument.html#c09d03fe142ca309b1927896da95754c">Instrument</a>.
</div>
</div><p>
</div>
<div class="footer">
<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
|