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
|
<!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>QuantLib: LocalVolSurface 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.9.0</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="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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_local_vol_surface.html">LocalVolSurface</a></div>
<h1>LocalVolSurface Class Reference</h1><!-- doxytag: class="QuantLib::LocalVolSurface" --><!-- doxytag: inherits="QuantLib::LocalVolTermStructure" --><code>#include <ql/termstructures/volatility/equityfx/localvolsurface.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for LocalVolSurface:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_local_vol_surface__inherit__graph.png" border="0" usemap="#_local_vol_surface__inherit__map" alt="Inheritance graph"></center>
<map name="_local_vol_surface__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_local_vol_term_structure.html" title="LocalVolTermStructure" alt="" coords="5,7,171,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_local_vol_surface-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Local volatility surface derived from a Black vol surface.
<p>
For details about this implementation refer to "Stochastic Volatility and Local Volatility," in "Case Studies and Financial Modelling Course Notes," by Jim Gatheral, Fall Term, 2003<p>
see www.math.nyu.edu/fellows_fin_math/gatheral/Lecture1_Fall02.pdf<p>
<dl compact><dt><b><a class="el" href="bug.html#_bug000013">Bug:</a></b></dt><dd>this class is untested, probably unreliable. </dd></dl>
<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="a4e518df5098f413a08bafa0343911e1"></a><!-- doxytag: member="QuantLib::LocalVolSurface::LocalVolSurface" ref="a4e518df5098f413a08bafa0343911e1" args="(const Handle< BlackVolTermStructure > &blackTS, const Handle< YieldTermStructure > &riskFreeTS, const Handle< YieldTermStructure > &dividendTS, const Handle< Quote > &underlying)" -->
</td><td class="memItemRight" valign="bottom"><b>LocalVolSurface</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> > &blackTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &riskFreeTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &dividendTS, 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> > &underlying)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5d251ea796a2a4b537152220293306f"></a><!-- doxytag: member="QuantLib::LocalVolSurface::LocalVolSurface" ref="f5d251ea796a2a4b537152220293306f" args="(const Handle< BlackVolTermStructure > &blackTS, const Handle< YieldTermStructure > &riskFreeTS, const Handle< YieldTermStructure > &dividendTS, Real underlying)" -->
</td><td class="memItemRight" valign="bottom"><b>LocalVolSurface</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> > &blackTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &riskFreeTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &dividendTS, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> underlying)</td></tr>
<tr><td colspan="2"><div class="groupHeader">LocalVolTermStructure interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a72314adf5959d9427df0fad16a1d3b"></a><!-- doxytag: member="QuantLib::LocalVolSurface::referenceDate" ref="4a72314adf5959d9427df0fad16a1d3b" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_local_vol_surface.html#4a72314adf5959d9427df0fad16a1d3b">referenceDate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the date at which discount = 1.0 and/or variance = 0.0 <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c147d63df367bbe5282b76b1f98cb9be"></a><!-- doxytag: member="QuantLib::LocalVolSurface::dayCounter" ref="c147d63df367bbe5282b76b1f98cb9be" args="() const " -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_local_vol_surface.html#c147d63df367bbe5282b76b1f98cb9be">dayCounter</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the day counter used for date/time conversion <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::LocalVolSurface::maxDate" ref="74d8fc5480ca811db8332b7b30597fe9" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_local_vol_surface.html#74d8fc5480ca811db8332b7b30597fe9">maxDate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the latest date for which the curve can return values <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec700319eaa1c6fca66df8e15aea6167"></a><!-- doxytag: member="QuantLib::LocalVolSurface::minStrike" ref="ec700319eaa1c6fca66df8e15aea6167" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_local_vol_surface.html#ec700319eaa1c6fca66df8e15aea6167">minStrike</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the minimum strike for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be69dc8630a5ea3f8333cfdfd01ba765"></a><!-- doxytag: member="QuantLib::LocalVolSurface::maxStrike" ref="be69dc8630a5ea3f8333cfdfd01ba765" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_local_vol_surface.html#be69dc8630a5ea3f8333cfdfd01ba765">maxStrike</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the maximum strike for which the term structure can return vols <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="896099363a2a409d2485c3ce9e4e4265"></a><!-- doxytag: member="QuantLib::LocalVolSurface::accept" ref="896099363a2a409d2485c3ce9e4e4265" args="(AcyclicVisitor &)" -->
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><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae14ca62291a64bc501d292224396525"></a><!-- doxytag: member="QuantLib::LocalVolSurface::localVolImpl" ref="ae14ca62291a64bc501d292224396525" args="(Time, Real) const " -->
<a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_local_vol_surface.html#ae14ca62291a64bc501d292224396525">localVolImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">local vol calculation <br></td></tr>
</table>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|