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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: SwaptionHelper 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_swaption_helper.html">SwaptionHelper</a></div>
<h1>SwaptionHelper Class Reference</h1><!-- doxytag: class="QuantLib::SwaptionHelper" --><!-- doxytag: inherits="QuantLib::CalibrationHelper" --><code>#include <ql/ShortRateModels/CalibrationHelpers/swaptionhelper.hpp></code>
<p>
Inheritance diagram for SwaptionHelper:<p><center><img src="class_quant_lib_1_1_swaption_helper__inherit__graph.png" border="0" usemap="#_swaption_helper__inherit__map" alt="Inheritance graph"></center>
<map name="_swaption_helper__inherit__map">
<area href="class_quant_lib_1_1_calibration_helper.html" shape="rect" coords="35,82,173,106" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="5,7,88,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="112,7,211,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_swaption_helper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
calibration helper for ATM swaption <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="_bermudan_swaption_8cpp-example.html#_a27">BermudanSwaption.cpp</a>.</dl>
<p>
<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="6e14b86c7acf3c4c142a9efb9038fb84"></a><!-- doxytag: member="QuantLib::SwaptionHelper::SwaptionHelper" ref="6e14b86c7acf3c4c142a9efb9038fb84" args="(const Period &maturity, const Period &length, const Handle< Quote > &volatility, const boost::shared_ptr< Xibor > &index, Frequency fixedLegFrequency, const DayCounter &fixedLegDayCounter, const DayCounter &floatingLegDayCounter, const Handle< YieldTermStructure > &termStructure, bool calibrateVolatility=false)" -->
</td><td class="memItemRight" valign="bottom"><b>SwaptionHelper</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &maturity, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &length, 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> > &volatility, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_xibor.html">Xibor</a> > &index, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> fixedLegFrequency, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &fixedLegDayCounter, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &floatingLegDayCounter, 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> > &termStructure, bool calibrateVolatility=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e555d4f8f2dda7c785831d5f9156dbc8"></a><!-- doxytag: member="QuantLib::SwaptionHelper::SwaptionHelper" ref="e555d4f8f2dda7c785831d5f9156dbc8" args="(const Period &maturity, const Period &length, const Handle< Quote > &volatility, const boost::shared_ptr< Xibor > &index, const Period &fixedLegTenor, const DayCounter &fixedLegDayCounter, const DayCounter &floatingLegDayCounter, const Handle< YieldTermStructure > &termStructure, bool calibrateVolatility=false)" -->
</td><td class="memItemRight" valign="bottom"><b>SwaptionHelper</b> (const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &maturity, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &length, 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> > &volatility, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_xibor.html">Xibor</a> > &index, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &fixedLegTenor, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &fixedLegDayCounter, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &floatingLegDayCounter, 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> > &termStructure, bool calibrateVolatility=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e671359d3aac4c1ea7e32d2658572e51"></a><!-- doxytag: member="QuantLib::SwaptionHelper::addTimesTo" ref="e671359d3aac4c1ea7e32d2658572e51" args="(std::list< Time > &times) const" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>addTimesTo</b> (std::list< Time > &times) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c561125f4c60e708eac2f66f1d5e0e2b"></a><!-- doxytag: member="QuantLib::SwaptionHelper::modelValue" ref="c561125f4c60e708eac2f66f1d5e0e2b" args="() const" -->
virtual <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_swaption_helper.html#c561125f4c60e708eac2f66f1d5e0e2b">modelValue</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the price of the instrument according to the model <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31d19869f6127bca922ca70f43ee4c99"></a><!-- doxytag: member="QuantLib::SwaptionHelper::blackPrice" ref="31d19869f6127bca922ca70f43ee4c99" args="(Volatility volatility) const" -->
virtual <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_swaption_helper.html#31d19869f6127bca922ca70f43ee4c99">blackPrice</a> (Volatility volatility) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Black price given a volatility. <br></td></tr>
</table>
</div>
<div class="footer">
<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
|