File: class_quant_lib_1_1_multi_cubic_spline.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (131 lines) | stat: -rw-r--r-- 8,213 bytes parent folder | download
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
<!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: MultiCubicSpline Class Template 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_multi_cubic_spline.html">MultiCubicSpline</a></div>
<h1>MultiCubicSpline Class Template Reference</h1><!-- doxytag: class="QuantLib::MultiCubicSpline" --><code>#include &lt;ql/math/interpolations/multicubicspline.hpp&gt;</code>
<p>

<p>
<a href="class_quant_lib_1_1_multi_cubic_spline-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;Size i&gt;<br>
 class QuantLib::MultiCubicSpline&lt; i &gt;</h3>

N-dimensional cubic spline interpolation between discrete points. 
<p>
<dl compact><dt><b><a class="el" href="test.html#_test000033">Tests:</a></b></dt><dd>interpolated values are checked against the original function.</dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000021">Possible enhancements:</a></b></dt><dd><ul>
<li>allow extrapolation as for the other interpolations</li><li>investigate if and how to implement Hyman filters and different boundary conditions</li></ul>
</dd></dl>
<dl compact><dt><b><a class="el" href="bug.html#_bug000003">Bug:</a></b></dt><dd>cannot interpolate at the grid points on the boundary surface of the N-dimensional region </dd></dl>
<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="015b0e85ee81e3da61427f7a4c0d42ee"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::argument_type" ref="015b0e85ee81e3da61427f7a4c0d42ee" args="" -->
typedef c_splint::argument_type&nbsp;</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="1041b4d77c5a2dc893d85075b9683901"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::result_type" ref="1041b4d77c5a2dc893d85075b9683901" args="" -->
typedef c_splint::result_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>result_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d52271a2cb04f2fa648165cc57c2606a"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::data_table" ref="d52271a2cb04f2fa648165cc57c2606a" args="" -->
typedef c_splint::data_table&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_table</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb2defc9d91d720b0608c60bc1e54450"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::return_type" ref="bb2defc9d91d720b0608c60bc1e54450" args="" -->
typedef c_splint::return_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>return_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4155be31bdd2d49d7f4f2276773a470c"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::output_data" ref="4155be31bdd2d49d7f4f2276773a470c" args="" -->
typedef c_splint::output_data&nbsp;</td><td class="memItemRight" valign="bottom"><b>output_data</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="212b7ae9248cc51f5df6690ac9aab14e"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::dimensions" ref="212b7ae9248cc51f5df6690ac9aab14e" args="" -->
typedef c_splint::dimensions&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensions</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6586602618017024fdcd66a924e147e8"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::data" ref="6586602618017024fdcd66a924e147e8" args="" -->
typedef c_splint::data&nbsp;</td><td class="memItemRight" valign="bottom"><b>data</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="cdd17fa93ecf7947e0a70431f9d2e28c"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::MultiCubicSpline" ref="cdd17fa93ecf7947e0a70431f9d2e28c" args="(const SplineGrid &amp;grid, const data_table &amp;y, const std::vector&lt; bool &gt; &amp;ae=std::vector&lt; bool &gt;(20, false))" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>MultiCubicSpline</b> (const SplineGrid &amp;grid, const data_table &amp;y, const std::vector&lt; bool &gt; &amp;ae=std::vector&lt; bool &gt;(20, false))</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77115db0bafb1f6fd97e51216e552b6d"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::operator()" ref="77115db0bafb1f6fd97e51216e552b6d" args="(const argument_type &amp;x) const " -->
result_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (const argument_type &amp;x) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34b4b0a9ab266c603ce441c4cf9db4c9"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::set_shared_increments" ref="34b4b0a9ab266c603ce441c4cf9db4c9" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_shared_increments</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54a993ffaa599e4ca5e431d59183c3d1"></a><!-- doxytag: member="QuantLib::MultiCubicSpline::set_shared_coefficients" ref="54a993ffaa599e4ca5e431d59183c3d1" args="(const argument_type &amp;x) const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_shared_coefficients</b> (const argument_type &amp;x) const </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>