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
|
<!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>PagodaOption 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_pagoda_option.html">PagodaOption</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">PagodaOption Class Reference<div class="ingroups"><a class="el" href="group__instruments.html">Financial instruments</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::PagodaOption" --><!-- doxytag: inherits="QuantLib::MultiAssetOption" -->
<p>Roofed Asian option on a number of assets.
<a href="class_quant_lib_1_1_pagoda_option.html#details">More...</a></p>
<p><code>#include <ql/experimental/exoticoptions/pagodaoption.hpp></code></p>
<div class="dynheader">
Inheritance diagram for PagodaOption:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_pagoda_option__inherit__graph.png" border="0" usemap="#_pagoda_option_inherit__map" alt="Inheritance graph"/></div>
<map name="_pagoda_option_inherit__map" id="_pagoda_option_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_multi_asset_option.html" title="Base class for options on multiple assets." alt="" coords="5,6,128,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_pagoda_option-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_pagoda_option_1_1engine.html">engine</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pagoda-option engine base class <a href="class_quant_lib_1_1_pagoda_option_1_1engine.html#details">More...</a><br/></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="aa24208806aa5411bceaa9c73d090f47b"></a><!-- doxytag: member="QuantLib::PagodaOption::PagodaOption" ref="aa24208806aa5411bceaa9c73d090f47b" args="(const std::vector< Date > &fixingDates, Real roof, Real fraction)" -->
 </td><td class="memItemRight" valign="bottom"><b>PagodaOption</b> (const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &fixingDates, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> roof, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> fraction)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_pagoda_option.html#aad6958108bfaef12bc4ccd6b3d7a7231">setupArguments</a> (PricingEngine::arguments *) const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a385ec624b35f431becf19c48a3698e07"></a><!-- doxytag: member="QuantLib::PagodaOption::fixingDates_" ref="a385ec624b35f431becf19c48a3698e07" args="" -->
std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > </td><td class="memItemRight" valign="bottom"><b>fixingDates_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95c0170051dff1bbdc70bbe6cdd63f4c"></a><!-- doxytag: member="QuantLib::PagodaOption::roof_" ref="a95c0170051dff1bbdc70bbe6cdd63f4c" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>roof_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0abba39c7f061e53d00e11883af4d3f"></a><!-- doxytag: member="QuantLib::PagodaOption::fraction_" ref="af0abba39c7f061e53d00e11883af4d3f" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>fraction_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Roofed Asian option on a number of assets. </p>
<p>The payoff is a given fraction multiplied by the minimum between a given roof and the positive portfolio performance. If the performance of the portfolio is below then the payoff is null.</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000014">Warning:</a></b></dt><dd>This implementation still does not manage seasoned options.</dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aad6958108bfaef12bc4ccd6b3d7a7231"></a><!-- doxytag: member="QuantLib::PagodaOption::setupArguments" ref="aad6958108bfaef12bc4ccd6b3d7a7231" args="(PricingEngine::arguments *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_quant_lib_1_1_pagoda_option.html#aad6958108bfaef12bc4ccd6b3d7a7231">setupArguments</a> </td>
<td>(</td>
<td class="paramtype">PricingEngine::arguments * </td>
<td class="paramname"></td><td>)</td>
<td> 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>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_multi_asset_option.html#aad6958108bfaef12bc4ccd6b3d7a7231">MultiAssetOption</a>.</p>
</div>
</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>
|