File: class_quant_lib_1_1_black_formula.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (211 lines) | stat: -rw-r--r-- 13,338 bytes parent folder | download
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
209
210
211
<!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: BlackFormula 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_black_formula.html">BlackFormula</a></div>
<h1>BlackFormula Class Reference</h1><!-- doxytag: class="QuantLib::BlackFormula" --><code>#include &lt;ql/PricingEngines/blackformula.hpp&gt;</code>
<p>
<a href="class_quant_lib_1_1_black_formula-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Black-formula calculator. 
<p>
<dl compact><dt><b><a class="el" href="bug.html#_bug000002">Bug:</a></b></dt><dd>When the variance is null, division by zero occur during the calculation of delta, delta forward, gamma, gamma forward, rho, dividend rho, vega, and strike sensitivity. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_discrete_hedging_8cpp-example.html#_a7">DiscreteHedging.cpp</a>.</dl>
<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="316efeeb86bf42358f589fa1a5c41895"></a><!-- doxytag: member="QuantLib::BlackFormula::BlackFormula" ref="316efeeb86bf42358f589fa1a5c41895" args="(Real forward, DiscountFactor discount, Real variance, const boost::shared_ptr&lt; StrikedTypePayoff &gt; &amp;payoff)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>BlackFormula</b> (Real forward, <a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> discount, Real variance, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_striked_type_payoff.html">StrikedTypePayoff</a> &gt; &amp;payoff)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72887400b9a4d1ba185b887b84876cdc"></a><!-- doxytag: member="QuantLib::BlackFormula::value" ref="72887400b9a4d1ba185b887b84876cdc" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>value</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ce2edf271b7df5907ea9a3b100383fe"></a><!-- doxytag: member="QuantLib::BlackFormula::delta" ref="1ce2edf271b7df5907ea9a3b100383fe" args="(Real spot) const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>delta</b> (Real spot) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6f8af630290d3010bc3bfc64304aa03"></a><!-- doxytag: member="QuantLib::BlackFormula::elasticity" ref="b6f8af630290d3010bc3bfc64304aa03" args="(Real spot) const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_black_formula.html#b6f8af630290d3010bc3bfc64304aa03">elasticity</a> (Real spot) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sensitivity in percent to a percent movement in the underlying. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57565309e7b2cbfe856209958c63cfa5"></a><!-- doxytag: member="QuantLib::BlackFormula::gamma" ref="57565309e7b2cbfe856209958c63cfa5" args="(Real spot) const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>gamma</b> (Real spot) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1aeee7c18b44d616b3c8169ebb9611a"></a><!-- doxytag: member="QuantLib::BlackFormula::deltaForward" ref="d1aeee7c18b44d616b3c8169ebb9611a" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>deltaForward</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c544e51336c33f06b0a9158a3d2705e"></a><!-- doxytag: member="QuantLib::BlackFormula::elasticityForward" ref="7c544e51336c33f06b0a9158a3d2705e" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_black_formula.html#7c544e51336c33f06b0a9158a3d2705e">elasticityForward</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sensitivity in percent to a percent movement in the forward price. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6949781d9c6ffe5419b5e463622430c6"></a><!-- doxytag: member="QuantLib::BlackFormula::gammaForward" ref="6949781d9c6ffe5419b5e463622430c6" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>gammaForward</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f7afb7a0e83603b71da76cd8923a07a2"></a><!-- doxytag: member="QuantLib::BlackFormula::theta" ref="f7afb7a0e83603b71da76cd8923a07a2" args="(Real spot, Time maturity) const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>theta</b> (Real spot, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bba1bf8797f099026e699408878caedc"></a><!-- doxytag: member="QuantLib::BlackFormula::thetaPerDay" ref="bba1bf8797f099026e699408878caedc" args="(Real spot, Time maturity) const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>thetaPerDay</b> (Real spot, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c37734c53fa52703c6f0d22677b05ed"></a><!-- doxytag: member="QuantLib::BlackFormula::vega" ref="0c37734c53fa52703c6f0d22677b05ed" args="(Time maturity) const " -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>vega</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffcfd1c0fd1c6bef1bb21fd2a336bff5"></a><!-- doxytag: member="QuantLib::BlackFormula::rho" ref="ffcfd1c0fd1c6bef1bb21fd2a336bff5" args="(Time maturity) const " -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>rho</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b880a4d01e68c373077c2c6cf68af259"></a><!-- doxytag: member="QuantLib::BlackFormula::dividendRho" ref="b880a4d01e68c373077c2c6cf68af259" args="(Time maturity) const " -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>dividendRho</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">Real&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_black_formula.html#52f0d80c352ce23b6009d89a828b7824">itmCashProbability</a> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">Real&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_black_formula.html#a0b200c24392e9cef0c2c467a925f290">itmAssetProbability</a> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55b21c7d22a7fdce4611b3b95effc896"></a><!-- doxytag: member="QuantLib::BlackFormula::strikeSensitivity" ref="55b21c7d22a7fdce4611b3b95effc896" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>strikeSensitivity</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7530134b03a24df85bd5ffe06507e87"></a><!-- doxytag: member="QuantLib::BlackFormula::alpha" ref="d7530134b03a24df85bd5ffe06507e87" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>alpha</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d50765ca99bba93b755d16557de7ad55"></a><!-- doxytag: member="QuantLib::BlackFormula::beta" ref="d50765ca99bba93b755d16557de7ad55" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>beta</b> () const</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="badcb24a4a0b52860a5e7618e3f66914"></a><!-- doxytag: member="QuantLib::BlackFormula::Calculator" ref="badcb24a4a0b52860a5e7618e3f66914" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Calculator</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="52f0d80c352ce23b6009d89a828b7824"></a><!-- doxytag: member="QuantLib::BlackFormula::itmCashProbability" ref="52f0d80c352ce23b6009d89a828b7824" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Real itmCashProbability           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Probability of being in the money in the bond martingale measure. It is a risk-neutral probability, not the real world probability. 
</div>
</div><p>
<a class="anchor" name="a0b200c24392e9cef0c2c467a925f290"></a><!-- doxytag: member="QuantLib::BlackFormula::itmAssetProbability" ref="a0b200c24392e9cef0c2c467a925f290" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Real itmAssetProbability           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Probability of being in the money in the asset martingale measure. It is a risk-neutral probability, not the real world probability. 
</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>