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
|
<!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>PathMultiAssetOption 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_path_multi_asset_option.html">PathMultiAssetOption</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> </div>
<div class="headertitle">
<div class="title">PathMultiAssetOption Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::PathMultiAssetOption" --><!-- doxytag: inherits="QuantLib::Instrument" -->
<p>Base class for path-dependent options on multiple assets.
<a href="class_quant_lib_1_1_path_multi_asset_option.html#details">More...</a></p>
<p><code>#include <ql/experimental/mcbasket/pathmultiassetoption.hpp></code></p>
<div class="dynheader">
Inheritance diagram for PathMultiAssetOption:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_path_multi_asset_option__inherit__graph.png" border="0" usemap="#_path_multi_asset_option_inherit__map" alt="Inheritance graph"/></div>
<map name="_path_multi_asset_option_inherit__map" id="_path_multi_asset_option_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_instrument.html" title="Abstract instrument class." alt="" coords="37,6,120,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_path_multi_asset_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_path_multi_asset_option_1_1arguments.html">arguments</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Arguments for multi-asset option calculation <a href="class_quant_lib_1_1_path_multi_asset_option_1_1arguments.html#details">More...</a><br/></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_path_multi_asset_option_1_1results.html">results</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Results from multi-asset option calculation <a href="class_quant_lib_1_1_path_multi_asset_option_1_1results.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="a9976ee9f3c76512bc22c86f56c67f092"></a><!-- doxytag: member="QuantLib::PathMultiAssetOption::PathMultiAssetOption" ref="a9976ee9f3c76512bc22c86f56c67f092" args="(const boost::shared_ptr< PricingEngine > &engine=boost::shared_ptr< PricingEngine >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PathMultiAssetOption</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a> > &engine=boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a> >())</td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Instrument interface</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a274c03751addc5c2ea63cc23d14a0bfe"></a><!-- doxytag: member="QuantLib::PathMultiAssetOption::isExpired" ref="a274c03751addc5c2ea63cc23d14a0bfe" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_path_multi_asset_option.html#a274c03751addc5c2ea63cc23d14a0bfe">isExpired</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether the instrument might have value greater than zero. <br/></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_path_multi_asset_option.html#aad6958108bfaef12bc4ccd6b3d7a7231">setupArguments</a> (PricingEngine::arguments *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3762cf1ede25044eb5380658e479a49f"></a><!-- doxytag: member="QuantLib::PathMultiAssetOption::pathPayoff" ref="a3762cf1ede25044eb5380658e479a49f" args="() const =0" -->
virtual boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_path_payoff.html">PathPayoff</a> > </td><td class="memItemRight" valign="bottom"><b>pathPayoff</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aa73071c45512677295c1e059e47060"></a><!-- doxytag: member="QuantLib::PathMultiAssetOption::fixingDates" ref="a1aa73071c45512677295c1e059e47060" args="() const =0" -->
virtual std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > </td><td class="memItemRight" valign="bottom"><b>fixingDates</b> () const =0</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_path_multi_asset_option.html#a1ea01b653cd3880c3e5d8bc34af412d3">setupExpired</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for path-dependent options on multiple assets. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aad6958108bfaef12bc4ccd6b3d7a7231"></a><!-- doxytag: member="QuantLib::PathMultiAssetOption::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_path_multi_asset_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_instrument.html#aad6958108bfaef12bc4ccd6b3d7a7231">Instrument</a>.</p>
</div>
</div>
<a class="anchor" id="a1ea01b653cd3880c3e5d8bc34af412d3"></a><!-- doxytag: member="QuantLib::PathMultiAssetOption::setupExpired" ref="a1ea01b653cd3880c3e5d8bc34af412d3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_quant_lib_1_1_path_multi_asset_option.html#a1ea01b653cd3880c3e5d8bc34af412d3">setupExpired</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method must leave the instrument in a consistent state when the expiration condition is met. </p>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_instrument.html#a1ea01b653cd3880c3e5d8bc34af412d3">Instrument</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>
|