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
|
<!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: CalibrationHelper 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_calibration_helper.html">CalibrationHelper</a></div>
<h1>CalibrationHelper Class Reference</h1><!-- doxytag: class="QuantLib::CalibrationHelper" --><!-- doxytag: inherits="QuantLib::Observer,QuantLib::Observable" --><code>#include <ql/models/calibrationhelper.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for CalibrationHelper:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_calibration_helper__inherit__graph.png" border="0" usemap="#_calibration_helper__inherit__map" alt="Inheritance graph"></center>
<map name="_calibration_helper__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_cap_helper.html" title="calibration helper for ATM cap" alt="" coords="5,161,96,188"><area shape="rect" href="class_quant_lib_1_1_heston_model_helper.html" title="calibration helper for Heston model" alt="" coords="120,161,269,188"><area shape="rect" href="class_quant_lib_1_1_swaption_helper.html" title="calibration helper for ATM swaption" alt="" coords="293,161,416,188"><area shape="rect" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="100,7,180,33"><area shape="rect" href="class_quant_lib_1_1_observable.html" title="Object that notifies its changes to a set of observables." alt="" coords="204,7,297,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_calibration_helper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
liquid market instrument used during calibration <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="b35bd42cc95a706ac4f06cbb24d4e2f8"></a><!-- doxytag: member="QuantLib::CalibrationHelper::CalibrationHelper" ref="b35bd42cc95a706ac4f06cbb24d4e2f8" args="(const Handle< Quote > &volatility, const Handle< YieldTermStructure > &termStructure, bool calibrateVolatility=false)" -->
</td><td class="memItemRight" valign="bottom"><b>CalibrationHelper</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> > &volatility, 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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_calibration_helper.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1d5a2a3e1205bdc482f59182282c426"></a><!-- doxytag: member="QuantLib::CalibrationHelper::marketValue" ref="a1d5a2a3e1205bdc482f59182282c426" 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_calibration_helper.html#a1d5a2a3e1205bdc482f59182282c426">marketValue</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the actual price of the instrument (from volatility) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="573ec85444166decbaa5888155b9fa39"></a><!-- doxytag: member="QuantLib::CalibrationHelper::modelValue" ref="573ec85444166decbaa5888155b9fa39" args="() const =0" -->
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_calibration_helper.html#573ec85444166decbaa5888155b9fa39">modelValue</a> () const =0</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="c9e6e106b8ad56b7bf89a48b8a004857"></a><!-- doxytag: member="QuantLib::CalibrationHelper::calibrationError" ref="c9e6e106b8ad56b7bf89a48b8a004857" args="()" -->
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_calibration_helper.html#c9e6e106b8ad56b7bf89a48b8a004857">calibrationError</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the error resulting from the model valuation <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06c670b250bcd21e9787ebc007093545"></a><!-- doxytag: member="QuantLib::CalibrationHelper::addTimesTo" ref="06c670b250bcd21e9787ebc007093545" args="(std::list< Time > &times) const =0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>addTimesTo</b> (std::list< <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > &times) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83cd0c8293969d49634c639a632141f0"></a><!-- doxytag: member="QuantLib::CalibrationHelper::impliedVolatility" ref="83cd0c8293969d49634c639a632141f0" args="(Real targetValue, Real accuracy, Size maxEvaluations, Volatility minVol, Volatility maxVol) 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_calibration_helper.html#83cd0c8293969d49634c639a632141f0">impliedVolatility</a> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> targetValue, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> maxEvaluations, <a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> minVol, <a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> maxVol) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Black volatility implied by the model. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e916246904fe19039c315903020642ff"></a><!-- doxytag: member="QuantLib::CalibrationHelper::blackPrice" ref="e916246904fe19039c315903020642ff" args="(Volatility volatility) const =0" -->
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_calibration_helper.html#e916246904fe19039c315903020642ff">blackPrice</a> (<a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> volatility) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Black price given a volatility. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ef2cc90f16cf902829ac616f7b5278c"></a><!-- doxytag: member="QuantLib::CalibrationHelper::setPricingEngine" ref="5ef2cc90f16cf902829ac616f7b5278c" args="(const boost::shared_ptr< PricingEngine > &engine)" -->
void </td><td class="memItemRight" valign="bottom"><b>setPricingEngine</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a> > &engine)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="371bd616cf2cbbac47b0e6263fd6d79f"></a><!-- doxytag: member="QuantLib::CalibrationHelper::marketValue_" ref="371bd616cf2cbbac47b0e6263fd6d79f" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>marketValue_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14cc04bf8608e1205f4796cbb54fd7f5"></a><!-- doxytag: member="QuantLib::CalibrationHelper::volatility_" ref="14cc04bf8608e1205f4796cbb54fd7f5" args="" -->
<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> > </td><td class="memItemRight" valign="bottom"><b>volatility_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ccfb2e6f0d4ec3fb0789e250aa3295ca"></a><!-- doxytag: member="QuantLib::CalibrationHelper::termStructure_" ref="ccfb2e6f0d4ec3fb0789e250aa3295ca" args="" -->
<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> > </td><td class="memItemRight" valign="bottom"><b>termStructure_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec8a3d48bdab47e807560f973bfa1569"></a><!-- doxytag: member="QuantLib::CalibrationHelper::engine_" ref="ec8a3d48bdab47e807560f973bfa1569" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a> > </td><td class="memItemRight" valign="bottom"><b>engine_</b></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::CalibrationHelper::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><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>Implements <a class="el" href="class_quant_lib_1_1_observer.html#99b02345a8a15d3c5ea2844a2253f510">Observer</a>.</p>
</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>
|