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 205 206 207 208
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: CashOrNothingPayoff Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://quantlib.org">
<img alt="QuantLib" src="QL-title.jpg"></a>
<div id="projectbrief">A free/open-source library for quantitative finance</div>
<div id="projectnumber">Reference manual - version 1.20</div>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_cash_or_nothing_payoff.html">CashOrNothingPayoff</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_quant_lib_1_1_cash_or_nothing_payoff-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CashOrNothingPayoff Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary cash-or-nothing payoff.
<a href="class_quant_lib_1_1_cash_or_nothing_payoff.html#details">More...</a></p>
<p><code>#include <ql/instruments/payoffs.hpp></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CashOrNothingPayoff:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_quant_lib_1_1_cash_or_nothing_payoff__inherit__graph.png" border="0" usemap="#a_cash_or_nothing_payoff_inherit__map" alt="Inheritance graph"/></div>
<map name="_cash_or_nothing_payoff_inherit__map" id="a_cash_or_nothing_payoff_inherit__map">
<area shape="rect" title="Binary cash-or-nothing payoff." alt="" coords="5,155,156,181"/>
<area shape="rect" href="class_quant_lib_1_1_striked_type_payoff.html" title="Intermediate class for payoffs based on a fixed strike." alt="" coords="16,80,145,107"/>
<area shape="rect" href="class_quant_lib_1_1_type_payoff.html" title="Intermediate class for put/call payoffs." alt="" coords="37,5,125,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afeb67fb6a0f48a80a84975ff4007bacd"><td class="memItemLeft" align="right" valign="top"><a id="afeb67fb6a0f48a80a84975ff4007bacd"></a>
 </td><td class="memItemRight" valign="bottom"><b>CashOrNothingPayoff</b> (Option::Type type, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> cashPayoff)</td></tr>
<tr class="separator:afeb67fb6a0f48a80a84975ff4007bacd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_striked_type_payoff"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_striked_type_payoff')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_striked_type_payoff.html">StrikedTypePayoff</a></td></tr>
<tr class="memitem:ab03aa38eeb7397bc097432ac4f959822 inherit pub_methods_class_quant_lib_1_1_striked_type_payoff"><td class="memItemLeft" align="right" valign="top"><a id="ab03aa38eeb7397bc097432ac4f959822"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>strike</b> () const</td></tr>
<tr class="separator:ab03aa38eeb7397bc097432ac4f959822 inherit pub_methods_class_quant_lib_1_1_striked_type_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_type_payoff"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_type_payoff')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_type_payoff.html">TypePayoff</a></td></tr>
<tr class="memitem:adb0ba825d3a506ae8445b023210c40ce inherit pub_methods_class_quant_lib_1_1_type_payoff"><td class="memItemLeft" align="right" valign="top"><a id="adb0ba825d3a506ae8445b023210c40ce"></a>
Option::Type </td><td class="memItemRight" valign="bottom"><b>optionType</b> () const</td></tr>
<tr class="separator:adb0ba825d3a506ae8445b023210c40ce inherit pub_methods_class_quant_lib_1_1_type_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Payoff interface</div></td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Payoff interface</h2></td></tr>
<tr class="memitem:a826fc0267983b40d8a3a05ce80a54826"><td class="memItemLeft" align="right" valign="top"><a id="a826fc0267983b40d8a3a05ce80a54826"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>cashPayoff_</b></td></tr>
<tr class="separator:a826fc0267983b40d8a3a05ce80a54826"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d89c28bd42ba9a52da008bb69367171"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_cash_or_nothing_payoff.html#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr>
<tr class="separator:a1d89c28bd42ba9a52da008bb69367171"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07ffe70037e0a16554c868bcdd8f83b5"><td class="memItemLeft" align="right" valign="top"><a id="a07ffe70037e0a16554c868bcdd8f83b5"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>description</b> () const</td></tr>
<tr class="separator:a07ffe70037e0a16554c868bcdd8f83b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87c0e550bbefd59755c7e75e631bcc30"><td class="memItemLeft" align="right" valign="top"><a id="a87c0e550bbefd59755c7e75e631bcc30"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>operator()</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> price) const</td></tr>
<tr class="separator:a87c0e550bbefd59755c7e75e631bcc30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a896099363a2a409d2485c3ce9e4e4265"><td class="memItemLeft" align="right" valign="top"><a id="a896099363a2a409d2485c3ce9e4e4265"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &)</td></tr>
<tr class="separator:a896099363a2a409d2485c3ce9e4e4265"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affb62f7ddeefc8c31e3dc39bb262847d"><td class="memItemLeft" align="right" valign="top"><a id="affb62f7ddeefc8c31e3dc39bb262847d"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>cashPayoff</b> () const</td></tr>
<tr class="separator:affb62f7ddeefc8c31e3dc39bb262847d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_quant_lib_1_1_payoff"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_quant_lib_1_1_payoff')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_quant_lib_1_1_payoff.html">Payoff</a></td></tr>
<tr class="memitem:af498733f2fd0abef2f5f1071a1b9354a inherit pub_types_class_quant_lib_1_1_payoff"><td class="memItemLeft" align="right" valign="top"><a id="af498733f2fd0abef2f5f1071a1b9354a"></a>
typedef <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>argument_type</b></td></tr>
<tr class="separator:af498733f2fd0abef2f5f1071a1b9354a inherit pub_types_class_quant_lib_1_1_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd4b619e88e62e8c704bc850340fc078 inherit pub_types_class_quant_lib_1_1_payoff"><td class="memItemLeft" align="right" valign="top"><a id="abd4b619e88e62e8c704bc850340fc078"></a>
typedef <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>result_type</b></td></tr>
<tr class="separator:abd4b619e88e62e8c704bc850340fc078 inherit pub_types_class_quant_lib_1_1_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_class_quant_lib_1_1_striked_type_payoff"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_quant_lib_1_1_striked_type_payoff')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_quant_lib_1_1_striked_type_payoff.html">StrikedTypePayoff</a></td></tr>
<tr class="memitem:afec468d37c982a37d0f403c629756770 inherit pro_methods_class_quant_lib_1_1_striked_type_payoff"><td class="memItemLeft" align="right" valign="top"><a id="afec468d37c982a37d0f403c629756770"></a>
 </td><td class="memItemRight" valign="bottom"><b>StrikedTypePayoff</b> (Option::Type type, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike)</td></tr>
<tr class="separator:afec468d37c982a37d0f403c629756770 inherit pro_methods_class_quant_lib_1_1_striked_type_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_class_quant_lib_1_1_type_payoff"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_quant_lib_1_1_type_payoff')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_quant_lib_1_1_type_payoff.html">TypePayoff</a></td></tr>
<tr class="memitem:a0d0b65c5c1a4c7df8618e75120c15c46 inherit pro_methods_class_quant_lib_1_1_type_payoff"><td class="memItemLeft" align="right" valign="top"><a id="a0d0b65c5c1a4c7df8618e75120c15c46"></a>
 </td><td class="memItemRight" valign="bottom"><b>TypePayoff</b> (Option::Type type)</td></tr>
<tr class="separator:a0d0b65c5c1a4c7df8618e75120c15c46 inherit pro_methods_class_quant_lib_1_1_type_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_striked_type_payoff"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_striked_type_payoff')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_striked_type_payoff.html">StrikedTypePayoff</a></td></tr>
<tr class="memitem:af4df09cd4cbe06f6558dc5777c23e106 inherit pro_attribs_class_quant_lib_1_1_striked_type_payoff"><td class="memItemLeft" align="right" valign="top"><a id="af4df09cd4cbe06f6558dc5777c23e106"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>strike_</b></td></tr>
<tr class="separator:af4df09cd4cbe06f6558dc5777c23e106 inherit pro_attribs_class_quant_lib_1_1_striked_type_payoff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_type_payoff"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_type_payoff')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_type_payoff.html">TypePayoff</a></td></tr>
<tr class="memitem:abcdb1c11e3593354931e650dd3dd13f2 inherit pro_attribs_class_quant_lib_1_1_type_payoff"><td class="memItemLeft" align="right" valign="top"><a id="abcdb1c11e3593354931e650dd3dd13f2"></a>
Option::Type </td><td class="memItemRight" valign="bottom"><b>type_</b></td></tr>
<tr class="separator:abcdb1c11e3593354931e650dd3dd13f2 inherit pro_attribs_class_quant_lib_1_1_type_payoff"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Binary cash-or-nothing payoff. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_replication_8cpp-example.html#_a21">Replication.cpp</a>.</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1d89c28bd42ba9a52da008bb69367171"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d89c28bd42ba9a52da008bb69367171">◆ </a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000121">Warning:</a></b></dt><dd>This method is used for output and comparison between payoffs. It is <b>not</b> meant to be used for writing switch-on-type code. </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_payoff.html#a7f04e718c6856c4d3d77a496b6acad0d">Payoff</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>
|