File: class_quant_lib_1_1_vega_stressed_black_scholes_process.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (167 lines) | stat: -rw-r--r-- 14,173 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
<!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>VegaStressedBlackScholesProcess 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_vega_stressed_black_scholes_process.html">VegaStressedBlackScholesProcess</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">VegaStressedBlackScholesProcess Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::VegaStressedBlackScholesProcess" --><!-- doxytag: inherits="QuantLib::GeneralizedBlackScholesProcess" -->
<p>Black-Scholes process which supports local vega stress tests.  
 <a href="class_quant_lib_1_1_vega_stressed_black_scholes_process.html#details">More...</a></p>

<p><code>#include &lt;ql/experimental/processes/vegastressedblackscholesprocess.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VegaStressedBlackScholesProcess:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_vega_stressed_black_scholes_process__inherit__graph.png" border="0" usemap="#_vega_stressed_black_scholes_process_inherit__map" alt="Inheritance graph"/></div>
<map name="_vega_stressed_black_scholes_process_inherit__map" id="_vega_stressed_black_scholes_process_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_generalized_black_scholes_process.html" title="Generalized Black&#45;Scholes stochastic process." alt="" coords="11,6,229,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_vega_stressed_black_scholes_process-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="a4d24e04dabdbe971bfe9f0b3aab40ba3"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::VegaStressedBlackScholesProcess" ref="a4d24e04dabdbe971bfe9f0b3aab40ba3" args="(const Handle&lt; Quote &gt; &amp;x0, const Handle&lt; YieldTermStructure &gt; &amp;dividendTS, const Handle&lt; YieldTermStructure &gt; &amp;riskFreeTS, const Handle&lt; BlackVolTermStructure &gt; &amp;blackVolTS, Time lowerTimeBorderForStressTest=0, Time upperTimeBorderForStressTest=1000000, Real lowerAssetBorderForStressTest=0, Real upperAssetBorderForStressTest=1000000, Real stressLevel=0, const boost::shared_ptr&lt; discretization &gt; &amp;d=boost::shared_ptr&lt; discretization &gt;(new EulerDiscretization))" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>VegaStressedBlackScholesProcess</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &amp;<a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#a89d2f497b5fd0d0a0dce2ec82c86e778">x0</a>, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;dividendTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;riskFreeTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> &gt; &amp;blackVolTS, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> lowerTimeBorderForStressTest=0, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> upperTimeBorderForStressTest=1000000, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> lowerAssetBorderForStressTest=0, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> upperAssetBorderForStressTest=1000000, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> stressLevel=0, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process_1_1discretization.html">discretization</a> &gt; &amp;d=boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process_1_1discretization.html">discretization</a> &gt;(new <a class="el" href="class_quant_lib_1_1_euler_discretization.html">EulerDiscretization</a>))</td></tr>
<tr><td colspan="2"><div class="groupHeader">StochasticProcess1D interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_vega_stressed_black_scholes_process.html#ab4d7fe4af7a6dd0ae710c073569821e4">diffusion</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">interface for vega stress test</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac62cee7b777da1b349730f16d1873c4e"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::getLowerTimeBorderForStressTest" ref="ac62cee7b777da1b349730f16d1873c4e" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getLowerTimeBorderForStressTest</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55d34bb18801c605a747d997d6b711be"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::setLowerTimeBorderForStressTest" ref="a55d34bb18801c605a747d997d6b711be" args="(Time LTB)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setLowerTimeBorderForStressTest</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> LTB)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3ba833a75fc09cc4318d74ee6ffd530"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::getUpperTimeBorderForStressTest" ref="ae3ba833a75fc09cc4318d74ee6ffd530" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getUpperTimeBorderForStressTest</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69045c95c78d578e1c80512a6ea820b8"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::setUpperTimeBorderForStressTest" ref="a69045c95c78d578e1c80512a6ea820b8" args="(Time UTB)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setUpperTimeBorderForStressTest</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> UTB)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84da2033ce377a7ceb88fc7aa18c8d76"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::getLowerAssetBorderForStressTest" ref="a84da2033ce377a7ceb88fc7aa18c8d76" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getLowerAssetBorderForStressTest</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f43f2e139739642a804bf390a294b4d"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::setLowerAssetBorderForStressTest" ref="a7f43f2e139739642a804bf390a294b4d" args="(Real LAB)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setLowerAssetBorderForStressTest</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> LAB)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa24202673c2f75819462e9777807c66"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::getUpperAssetBorderForStressTest" ref="afa24202673c2f75819462e9777807c66" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getUpperAssetBorderForStressTest</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32594bc4d45a433ffcff8a5e2176fa5f"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::setUpperAssetBorderForStressTest" ref="a32594bc4d45a433ffcff8a5e2176fa5f" args="(Real UBA)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setUpperAssetBorderForStressTest</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> UBA)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee9801e06dc96915253eb1633a5b383a"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::getStressLevel" ref="aee9801e06dc96915253eb1633a5b383a" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getStressLevel</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a785b85d9f05531d002657718dbb8cd06"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::setStressLevel" ref="a785b85d9f05531d002657718dbb8cd06" args="(Real SL)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setStressLevel</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> SL)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Black-Scholes process which supports local vega stress tests. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab4d7fe4af7a6dd0ae710c073569821e4"></a><!-- doxytag: member="QuantLib::VegaStressedBlackScholesProcess::diffusion" ref="ab4d7fe4af7a6dd0ae710c073569821e4" args="(Time t, Real x) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_vega_stressed_black_scholes_process.html#ab4d7fe4af7a6dd0ae710c073569821e4">diffusion</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td>
          <td class="paramname"><em>x</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000060">Possible enhancements:</a></b></dt><dd>revise extrapolation </dd></dl>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#ab4d7fe4af7a6dd0ae710c073569821e4">GeneralizedBlackScholesProcess</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>