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
|
<!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>DeltaVolQuote 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_delta_vol_quote.html">DeltaVolQuote</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">DeltaVolQuote Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::DeltaVolQuote" --><!-- doxytag: inherits="QuantLib::Quote,QuantLib::Observer" -->
<p>Class for the quotation of delta vs vol.
<a href="class_quant_lib_1_1_delta_vol_quote.html#details">More...</a></p>
<p><code>#include <ql/experimental/fx/deltavolquote.hpp></code></p>
<div class="dynheader">
Inheritance diagram for DeltaVolQuote:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_delta_vol_quote__inherit__graph.png" border="0" usemap="#_delta_vol_quote_inherit__map" alt="Inheritance graph"/></div>
<map name="_delta_vol_quote_inherit__map" id="_delta_vol_quote_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables" alt="" coords="5,6,61,37"/><area shape="rect" id="node4" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="85,6,160,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_delta_vol_quote-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>DeltaType</b> { <b>Spot</b>,
<b>Fwd</b>,
<b>PaSpot</b>,
<b>PaFwd</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>AtmType</b> { <br/>
  <b>AtmNull</b>,
<b>AtmSpot</b>,
<b>AtmFwd</b>,
<b>AtmDeltaNeutral</b>,
<br/>
  <b>AtmVegaMax</b>,
<b>AtmGammaMax</b>,
<b>AtmPutCall50</b>
<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="a80209fa5bb75996eed26634fda3fc348"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::DeltaVolQuote" ref="a80209fa5bb75996eed26634fda3fc348" args="(Real delta, const Handle< Quote > &vol, Time maturity, DeltaType deltaType)" -->
 </td><td class="memItemRight" valign="bottom"><b>DeltaVolQuote</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> delta, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > &vol, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity, DeltaType deltaType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10d062c930c62472b13297a9dab31250"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::DeltaVolQuote" ref="a10d062c930c62472b13297a9dab31250" args="(const Handle< Quote > &vol, DeltaType deltaType, Time maturity, AtmType atmType)" -->
 </td><td class="memItemRight" valign="bottom"><b>DeltaVolQuote</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > &vol, DeltaType deltaType, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity, AtmType atmType)</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_delta_vol_quote.html#ac5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7f31cfaca49d25079e464ca462d691c"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::value" ref="ab7f31cfaca49d25079e464ca462d691c" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_delta_vol_quote.html#ab7f31cfaca49d25079e464ca462d691c">value</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the current value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2397bf69d6801e3328c9273143c87ce6"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::delta" ref="a2397bf69d6801e3328c9273143c87ce6" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>delta</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a031873b070bc7219052b0fcc0cf0a5c6"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::maturity" ref="a031873b070bc7219052b0fcc0cf0a5c6" args="() const " -->
<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td><td class="memItemRight" valign="bottom"><b>maturity</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78d99c55c8213028e59b7a516f75fedd"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::atmType" ref="a78d99c55c8213028e59b7a516f75fedd" args="() const " -->
AtmType </td><td class="memItemRight" valign="bottom"><b>atmType</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef14a2f94c0926b16bfef905eb8b893c"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::deltaType" ref="aef14a2f94c0926b16bfef905eb8b893c" args="() const " -->
DeltaType </td><td class="memItemRight" valign="bottom"><b>deltaType</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac1b70a2ed67ead038c4d3f5ac4d8a81"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::isValid" ref="aac1b70a2ed67ead038c4d3f5ac4d8a81" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_delta_vol_quote.html#aac1b70a2ed67ead038c4d3f5ac4d8a81">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the <a class="el" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables">Quote</a> holds a valid value <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class for the quotation of delta vs vol. </p>
<p>It includes the various delta quotation types in FX markets as well as ATM types. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::DeltaVolQuote::update" ref="ac5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_quant_lib_1_1_delta_vol_quote.html#ac5c54df7ed3b930268c8d7752c101725">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes. </p>
<p>Implements <a class="el" href="class_quant_lib_1_1_observer.html#a99b02345a8a15d3c5ea2844a2253f510">Observer</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>
|