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
|
<!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: Interpolation 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_interpolation.html">Interpolation</a></div>
<h1>Interpolation Class Reference</h1><!-- doxytag: class="QuantLib::Interpolation" --><!-- doxytag: inherits="QuantLib::Extrapolator" --><code>#include <ql/math/interpolation.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Interpolation:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_interpolation__inherit__graph.png" border="0" usemap="#_interpolation__inherit__map" alt="Inheritance graph"></center>
<map name="_interpolation__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_backward_flat_interpolation.html" title="Backward-flat interpolation between discrete points." alt="" coords="309,5,499,32"><area shape="rect" href="class_quant_lib_1_1_cubic_spline_interpolation.html" title="Cubic spline interpolation between discrete points." alt="" coords="316,56,492,83"><area shape="rect" href="class_quant_lib_1_1_forward_flat_interpolation.html" title="Forward-flat interpolation between discrete points." alt="" coords="315,107,493,133"><area shape="rect" href="class_quant_lib_1_1_linear_interpolation.html" title="Linear interpolation between discrete points" alt="" coords="333,157,475,184"><area shape="rect" href="class_quant_lib_1_1_log_cubic_interpolation.html" title="log-cubic interpolation between discrete points" alt="" coords="323,208,485,235"><area shape="rect" href="class_quant_lib_1_1_log_linear_interpolation.html" title="log-linear interpolation between discrete points" alt="" coords="321,259,487,285"><area shape="rect" href="class_quant_lib_1_1_s_a_b_r_interpolation.html" title="SABR smile interpolation between discrete volatility points." alt="" coords="335,309,473,336"><area shape="rect" href="class_quant_lib_1_1_extrapolator.html" title="base class for classes possibly allowing extrapolation" alt="" coords="7,157,108,184"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_interpolation-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
base class for 1-D interpolations.
<p>
Classes derived from this class will provide interpolated values from two sequences of equal length, representing discretized values of a variable and a function of the former, respectively. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f498733f2fd0abef2f5f1071a1b9354a"></a><!-- doxytag: member="QuantLib::Interpolation::argument_type" ref="f498733f2fd0abef2f5f1071a1b9354a" args="" -->
typedef <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>argument_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd4b619e88e62e8c704bc850340fc078"></a><!-- doxytag: member="QuantLib::Interpolation::result_type" ref="bd4b619e88e62e8c704bc850340fc078" args="" -->
typedef <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>result_type</b></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="c6e61de369e994009e36f344f99c15ad"></a><!-- doxytag: member="QuantLib::Interpolation::empty" ref="c6e61de369e994009e36f344f99c15ad" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>empty</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c180804bcc9bccca4deca3246968e4f3"></a><!-- doxytag: member="QuantLib::Interpolation::operator()" ref="c180804bcc9bccca4deca3246968e4f3" args="(Real x, bool allowExtrapolation=false) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>operator()</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x, bool allowExtrapolation=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61e81104809d2137d59ace5e6c0688d0"></a><!-- doxytag: member="QuantLib::Interpolation::primitive" ref="61e81104809d2137d59ace5e6c0688d0" args="(Real x, bool allowExtrapolation=false) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>primitive</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x, bool allowExtrapolation=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="762f31d09f9c70ceffb183248d3ef8ba"></a><!-- doxytag: member="QuantLib::Interpolation::derivative" ref="762f31d09f9c70ceffb183248d3ef8ba" args="(Real x, bool allowExtrapolation=false) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>derivative</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x, bool allowExtrapolation=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a261e6fbcb8c5436d3bb791e2b94f7b9"></a><!-- doxytag: member="QuantLib::Interpolation::secondDerivative" ref="a261e6fbcb8c5436d3bb791e2b94f7b9" args="(Real x, bool allowExtrapolation=false) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>secondDerivative</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x, bool allowExtrapolation=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e464439f613889645330b4fefbf66ab2"></a><!-- doxytag: member="QuantLib::Interpolation::xMin" ref="e464439f613889645330b4fefbf66ab2" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>xMin</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5bfc70b2ea8397a47c13cbfe397345b"></a><!-- doxytag: member="QuantLib::Interpolation::xMax" ref="c5bfc70b2ea8397a47c13cbfe397345b" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>xMax</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="065ac2d8b15048bb846f8fddc789c46b"></a><!-- doxytag: member="QuantLib::Interpolation::isInRange" ref="065ac2d8b15048bb846f8fddc789c46b" args="(Real x) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>isInRange</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::Interpolation::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>update</b> ()</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="b1128d789d8186b63cb7f9ab2d6d0402"></a><!-- doxytag: member="QuantLib::Interpolation::checkRange" ref="b1128d789d8186b63cb7f9ab2d6d0402" args="(Real x, bool extrapolate) const " -->
void </td><td class="memItemRight" valign="bottom"><b>checkRange</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x, bool extrapolate) const </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="a593fa134416a954928e323a5175af7d"></a><!-- doxytag: member="QuantLib::Interpolation::impl_" ref="a593fa134416a954928e323a5175af7d" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_interpolation_1_1_impl.html">Impl</a> > </td><td class="memItemRight" valign="bottom"><b>impl_</b></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interpolation_1_1_impl.html">Impl</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">abstract base class for interpolation implementations <a href="class_quant_lib_1_1_interpolation_1_1_impl.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interpolation_1_1template_impl.html">templateImpl</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">basic template implementation <a href="class_quant_lib_1_1_interpolation_1_1template_impl.html#_details">More...</a><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>
|