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
|
<!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>QuantLib: BarrierOption 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.9.0</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="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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_barrier_option.html">BarrierOption</a></div>
<h1>BarrierOption Class Reference<br>
<small>
[<a class="el" href="group__instruments.html">Financial instruments</a>]</small>
</h1><!-- doxytag: class="QuantLib::BarrierOption" --><!-- doxytag: inherits="QuantLib::OneAssetOption" --><code>#include <ql/instruments/barrieroption.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for BarrierOption:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_barrier_option__inherit__graph.png" border="0" usemap="#_barrier_option__inherit__map" alt="Inheritance graph"></center>
<map name="_barrier_option__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_one_asset_option.html" title="Base class for options on a single asset." alt="" coords="5,7,131,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_barrier_option-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Barrier option on a single asset.
<p>
The analytic pricing <a class="el" href="class_quant_lib_1_1_barrier_option_1_1engine.html" title="Barrier-option engine base class">engine</a> will be used if none if passed. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="_replication_8cpp-example.html#_a17">Replication.cpp</a>.</dl><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="294feb53bf4fbbc46ee9f9428b49dc33"></a><!-- doxytag: member="QuantLib::BarrierOption::BarrierOption" ref="294feb53bf4fbbc46ee9f9428b49dc33" args="(Barrier::Type barrierType, Real barrier, Real rebate, const boost::shared_ptr< StrikedTypePayoff > &payoff, const boost::shared_ptr< Exercise > &exercise)" -->
</td><td class="memItemRight" valign="bottom"><b>BarrierOption</b> (Barrier::Type barrierType, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> barrier, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> rebate, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_striked_type_payoff.html">StrikedTypePayoff</a> > &payoff, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_exercise.html">Exercise</a> > &exercise)</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_barrier_option.html#ad6958108bfaef12bc4ccd6b3d7a7231">setupArguments</a> (PricingEngine::arguments *) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_barrier_option.html#95c0837ce9c4bcc4cb9b9ff975f3bfe1">impliedVolatility</a> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> price, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> > &process, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-4, Size maxEvaluations=100, Volatility minVol=1.0e-7, Volatility maxVol=4.0) const </td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1439bfbbaacb914efebb469a50d6528a"></a><!-- doxytag: member="QuantLib::BarrierOption::barrierType_" ref="1439bfbbaacb914efebb469a50d6528a" args="" -->
Barrier::Type </td><td class="memItemRight" valign="bottom"><b>barrierType_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70ca946cc3b0a75548f7f38eedd3a7a6"></a><!-- doxytag: member="QuantLib::BarrierOption::barrier_" ref="70ca946cc3b0a75548f7f38eedd3a7a6" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>barrier_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6e88a4eb440388c167742fc333e8fd5"></a><!-- doxytag: member="QuantLib::BarrierOption::rebate_" ref="d6e88a4eb440388c167742fc333e8fd5" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>rebate_</b></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_barrier_option_1_1arguments.html">arguments</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Arguments for barrier option calculation <a href="class_quant_lib_1_1_barrier_option_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_barrier_option_1_1engine.html">engine</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Barrier-option engine base class <a href="class_quant_lib_1_1_barrier_option_1_1engine.html#_details">More...</a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ad6958108bfaef12bc4ccd6b3d7a7231"></a><!-- doxytag: member="QuantLib::BarrierOption::setupArguments" ref="ad6958108bfaef12bc4ccd6b3d7a7231" args="(PricingEngine::arguments *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setupArguments </td>
<td>(</td>
<td class="paramtype">PricingEngine::arguments * </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 argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing <a class="el" href="class_quant_lib_1_1_barrier_option_1_1engine.html" title="Barrier-option engine base class">engine</a> is used.
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_option.html#ad6958108bfaef12bc4ccd6b3d7a7231">Option</a>.</p>
</div>
</div><p>
<a class="anchor" name="95c0837ce9c4bcc4cb9b9ff975f3bfe1"></a><!-- doxytag: member="QuantLib::BarrierOption::impliedVolatility" ref="95c0837ce9c4bcc4cb9b9ff975f3bfe1" args="(Real price, const boost::shared_ptr< GeneralizedBlackScholesProcess > &process, Real accuracy=1.0e-4, Size maxEvaluations=100, Volatility minVol=1.0e-7, Volatility maxVol=4.0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> impliedVolatility </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"> <em>price</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> > & </td>
<td class="paramname"> <em>process</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"> <em>accuracy</em> = <code>1.0e-4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td>
<td class="paramname"> <em>maxEvaluations</em> = <code>100</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td>
<td class="paramname"> <em>minVol</em> = <code>1.0e-7</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td>
<td class="paramname"> <em>maxVol</em> = <code>4.0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000032">Warning:</a></b></dt><dd>see <a class="el" href="class_quant_lib_1_1_vanilla_option.html" title="Vanilla option (no discrete dividends, no barriers) on a single asset.">VanillaOption</a> for notes on implied-volatility calculation. </dd></dl>
</div>
</div><p>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|