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
|
<!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: VolatilityTermStructure 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_volatility_term_structure.html">VolatilityTermStructure</a></div>
<h1>VolatilityTermStructure Class Reference</h1><!-- doxytag: class="QuantLib::VolatilityTermStructure" --><!-- doxytag: inherits="QuantLib::TermStructure" --><code>#include <ql/termstructures/voltermstructure.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for VolatilityTermStructure:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_volatility_term_structure__inherit__graph.png" border="0" usemap="#_volatility_term_structure__inherit__map" alt="Inheritance graph"></center>
<map name="_volatility_term_structure__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_black_atm_vol_curve.html" title="Black at-the-money (no-smile) volatility curve." alt="" coords="427,5,568,32"><area shape="rect" href="class_quant_lib_1_1_black_vol_term_structure.html" title="Black-volatility term structure." alt="" coords="415,56,580,83"><area shape="rect" href="class_quant_lib_1_1_cap_floor_term_volatility_structure.html" title="Cap/floor term-volatility structure." alt="" coords="385,107,609,133"><area shape="rect" href="class_quant_lib_1_1_local_vol_term_structure.html" title="LocalVolTermStructure" alt="" coords="415,157,580,184"><area shape="rect" href="class_quant_lib_1_1_optionlet_volatility_structure.html" title="Optionlet (caplet/floorlet) volatility structure." alt="" coords="400,208,595,235"><area shape="rect" href="class_quant_lib_1_1_swaption_volatility_structure.html" title="Swaption-volatility structure" alt="" coords="400,259,595,285"><area shape="rect" href="class_quant_lib_1_1_term_structure.html" title="Basic term-structure functionality." alt="" coords="7,132,119,159"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_volatility_term_structure-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Volatility term structure.
<p>
This abstract class defines the interface of concrete volatility structures which will be derived from this one. <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="9d653d6960e5abf8a835f24fd9beb685"></a><!-- doxytag: member="QuantLib::VolatilityTermStructure::businessDayConvention" ref="9d653d6960e5abf8a835f24fd9beb685" args="() const " -->
<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_volatility_term_structure.html#9d653d6960e5abf8a835f24fd9beb685">businessDayConvention</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the business day convention used in tenor to date conversion <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f59f60f1e0a7875cd8c4e97c3e50f8fd"></a><!-- doxytag: member="QuantLib::VolatilityTermStructure::optionDateFromTenor" ref="f59f60f1e0a7875cd8c4e97c3e50f8fd" args="(const Period &) 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_volatility_term_structure.html#f59f60f1e0a7875cd8c4e97c3e50f8fd">optionDateFromTenor</a> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">tenor to date conversion <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td colspan="2"><div class="groupText">See the TermStructure documentation for issues regarding constructors. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_volatility_term_structure.html#d105e26d10dfb435c23cca2f3bfd3c76">VolatilityTermStructure</a> (const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &cal, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc=Following, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#d105e26d10dfb435c23cca2f3bfd3c76"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="068651871aeab73305130247e4270040"></a><!-- doxytag: member="QuantLib::VolatilityTermStructure::VolatilityTermStructure" ref="068651871aeab73305130247e4270040" args="(const Date &referenceDate, const Calendar &cal, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_volatility_term_structure.html#068651871aeab73305130247e4270040">VolatilityTermStructure</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &referenceDate, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &cal, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc=Following, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">initialize with a fixed reference date <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac8eed9e933916351f14235a9feb65e"></a><!-- doxytag: member="QuantLib::VolatilityTermStructure::VolatilityTermStructure" ref="9ac8eed9e933916351f14235a9feb65e" args="(Natural settlementDays, const Calendar &cal, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_volatility_term_structure.html#9ac8eed9e933916351f14235a9feb65e">VolatilityTermStructure</a> (<a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &cal, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc=Following, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">calculate the reference date based on the global evaluation date <br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d105e26d10dfb435c23cca2f3bfd3c76"></a><!-- doxytag: member="QuantLib::VolatilityTermStructure::VolatilityTermStructure" ref="d105e26d10dfb435c23cca2f3bfd3c76" args="(const Calendar &cal, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_volatility_term_structure.html">VolatilityTermStructure</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> & </td>
<td class="paramname"> <em>cal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> </td>
<td class="paramname"> <em>bdc</em> = <code>Following</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"> <em>dc</em> = <code><a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
default constructor
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000101">Warning:</a></b></dt><dd>term structures initialized by means of this constructor must manage their own reference date by overriding the <a class="el" href="class_quant_lib_1_1_term_structure.html#a9ae6cc6009ac64d4f265065eab08be0" title="the date at which discount = 1.0 and/or variance = 0.0">referenceDate()</a> method. </dd></dl>
</div>
</div><p>
</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>
|