File: class_quant_lib_1_1_implied_std_dev_quote.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 (161 lines) | stat: -rw-r--r-- 11,317 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
<!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>ImpliedStdDevQuote 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_implied_std_dev_quote.html">ImpliedStdDevQuote</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ImpliedStdDevQuote Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ImpliedStdDevQuote" --><!-- doxytag: inherits="QuantLib::Quote,QuantLib::LazyObject" -->
<p>quote for the implied standard deviation of an underlying  
 <a href="class_quant_lib_1_1_implied_std_dev_quote.html#details">More...</a></p>

<p><code>#include &lt;ql/quotes/impliedstddevquote.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ImpliedStdDevQuote:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_implied_std_dev_quote__inherit__graph.png" border="0" usemap="#_implied_std_dev_quote_inherit__map" alt="Inheritance graph"/></div>
<map name="_implied_std_dev_quote_inherit__map" id="_implied_std_dev_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_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="85,6,173,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_implied_std_dev_quote-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="a44efc0ebf7d4c782afcd55c2ec3f4445"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::ImpliedStdDevQuote" ref="a44efc0ebf7d4c782afcd55c2ec3f4445" args="(Option::Type optionType, const Handle&lt; Quote &gt; &amp;forward, const Handle&lt; Quote &gt; &amp;price, Real strike, Real guess, Real accuracy=1.0e&#45;6, Natural maxIter=100)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ImpliedStdDevQuote</b> (Option::Type optionType, 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;forward, 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;price, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> guess, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-6, Natural maxIter=100)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Quote interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7f31cfaca49d25079e464ca462d691c"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::value" ref="ab7f31cfaca49d25079e464ca462d691c" args="() const " -->
<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_implied_std_dev_quote.html#ab7f31cfaca49d25079e464ca462d691c">value</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the current value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac1b70a2ed67ead038c4d3f5ac4d8a81"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::isValid" ref="aac1b70a2ed67ead038c4d3f5ac4d8a81" args="() const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_implied_std_dev_quote.html#aac1b70a2ed67ead038c4d3f5ac4d8a81">isValid</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</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>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_implied_std_dev_quote.html#a02b90bbfee3ee29627939544fb59ec93">performCalculations</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2a1e58de4f267d289d1a6a8e17ed466"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::impliedStdev_" ref="af2a1e58de4f267d289d1a6a8e17ed466" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>impliedStdev_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecc0c3c34ac4fb81b4227a07b0e7c194"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::optionType_" ref="aecc0c3c34ac4fb81b4227a07b0e7c194" args="" -->
Option::Type&#160;</td><td class="memItemRight" valign="bottom"><b>optionType_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4df09cd4cbe06f6558dc5777c23e106"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::strike_" ref="af4df09cd4cbe06f6558dc5777c23e106" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>strike_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ee5ac7e44b518c6da03615672cb6e9b"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::accuracy_" ref="a9ee5ac7e44b518c6da03615672cb6e9b" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>accuracy_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6c06ed67d150ec02baff8aa16f88004"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::maxIter_" ref="ae6c06ed67d150ec02baff8aa16f88004" args="" -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a>&#160;</td><td class="memItemRight" valign="bottom"><b>maxIter_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a956859b47599b6d2380009a5d28a7b38"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::forward_" ref="a956859b47599b6d2380009a5d28a7b38" args="" -->
<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;&#160;</td><td class="memItemRight" valign="bottom"><b>forward_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ff5f85b607cce82a2b3b2a49a306148"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::price_" ref="a5ff5f85b607cce82a2b3b2a49a306148" args="" -->
<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;&#160;</td><td class="memItemRight" valign="bottom"><b>price_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>quote for the implied standard deviation of an underlying </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a02b90bbfee3ee29627939544fb59ec93"></a><!-- doxytag: member="QuantLib::ImpliedStdDevQuote::performCalculations" ref="a02b90bbfee3ee29627939544fb59ec93" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_implied_std_dev_quote.html#a02b90bbfee3ee29627939544fb59ec93">performCalculations</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method must implement any calculations which must be (re)done in order to calculate the desired results. </p>

<p>Implements <a class="el" href="class_quant_lib_1_1_lazy_object.html#a572dbe926524786c64db01e31dba7ab8">LazyObject</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>