File: class_quant_lib_1_1_gauss_lobatto_integral.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (141 lines) | stat: -rw-r--r-- 11,524 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
132
133
134
135
136
137
138
139
140
141
<!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>GaussLobattoIntegral 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="185" height="50" 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 1.2</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="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="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="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_gauss_lobatto_integral.html">GaussLobattoIntegral</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">GaussLobattoIntegral Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::GaussLobattoIntegral" --><!-- doxytag: inherits="QuantLib::Integrator" -->
<p>Integral of a one-dimensional function.  
 <a href="class_quant_lib_1_1_gauss_lobatto_integral.html#details">More...</a></p>

<p><code>#include &lt;ql/math/integrals/gausslobattointegral.hpp&gt;</code></p>

<p>Inherits Integrator.</p>

<p><a href="class_quant_lib_1_1_gauss_lobatto_integral-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22e1010dd30105e19d6f6b777128f45a"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::GaussLobattoIntegral" ref="a22e1010dd30105e19d6f6b777128f45a" args="(Size maxIterations, Real absAccuracy, Real relAccuracy=Null&lt; Real &gt;(), bool useConvergenceEstimate=true)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>GaussLobattoIntegral</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> maxIterations, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> absAccuracy, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> relAccuracy=Null&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;(), bool useConvergenceEstimate=true)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a7b69e9c96cb1f7b182caef74747c6c"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::integrate" ref="a5a7b69e9c96cb1f7b182caef74747c6c" args="(const boost::function&lt; Real(Real)&gt; &amp;f, Real a, Real b) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>integrate</b> (const boost::function&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>(<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>)&gt; &amp;f, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> a, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa65734e98a9fabf86cfb2e8ba6d90fb7"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::adaptivGaussLobattoStep" ref="aa65734e98a9fabf86cfb2e8ba6d90fb7" args="(const boost::function&lt; Real(Real)&gt; &amp;f, Real a, Real b, Real fa, Real fb, Real is) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>adaptivGaussLobattoStep</b> (const boost::function&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>(<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>)&gt; &amp;f, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> a, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> b, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> fa, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> fb, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> is) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dac00925faa00ccecc1541d3aad5a5a"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::calculateAbsTolerance" ref="a7dac00925faa00ccecc1541d3aad5a5a" args="(const boost::function&lt; Real(Real)&gt; &amp;f, Real a, Real b) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>calculateAbsTolerance</b> (const boost::function&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>(<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>)&gt; &amp;f, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> a, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> b) const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a749796204ab17a5427deb9062ce57cc4"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::relAccuracy_" ref="a749796204ab17a5427deb9062ce57cc4" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>relAccuracy_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe7b6eda37c4288c5a827b0c6c1bcbb6"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::useConvergenceEstimate_" ref="abe7b6eda37c4288c5a827b0c6c1bcbb6" args="" -->
const bool&#160;</td><td class="memItemRight" valign="bottom"><b>useConvergenceEstimate_</b></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a5f60670b1c3273333467ce33939204"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::alpha_" ref="a3a5f60670b1c3273333467ce33939204" args="" -->
static const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>alpha_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a208eaa0a2d6a36ccb65c022c3485363b"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::beta_" ref="a208eaa0a2d6a36ccb65c022c3485363b" args="" -->
static const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>beta_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98b2b596e0d186346a067d8411833cfe"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::x1_" ref="a98b2b596e0d186346a067d8411833cfe" args="" -->
static const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>x1_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70d791405e28cf163895351eba87a26d"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::x2_" ref="a70d791405e28cf163895351eba87a26d" args="" -->
static const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>x2_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2841be2337b04a9d0be7deaa6df9add2"></a><!-- doxytag: member="QuantLib::GaussLobattoIntegral::x3_" ref="a2841be2337b04a9d0be7deaa6df9add2" args="" -->
static const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>x3_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Integral of a one-dimensional function. </p>
<p>Given a target accuracy <img class="formulaInl" alt="$ \epsilon $" src="form_203.png"/>, the integral of a function <img class="formulaInl" alt="$ f $" src="form_37.png"/> between <img class="formulaInl" alt="$ a $" src="form_47.png"/> and <img class="formulaInl" alt="$ b $" src="form_48.png"/> is calculated by means of the Gauss-Lobatto formula</p>
<p>References: This algorithm is a C++ implementation of the algorithm outlined in</p>
<p>W. Gander and W. Gautschi, Adaptive Quadrature - Revisited. BIT, 40(1):84-101, March 2000. CS technical report: ftp.inf.ethz.ch/pub/publications/tech-reports/3xx/306.ps.gz</p>
<p>The original MATLAB version can be downloaded here <a href="http://www.inf.ethz.ch/personal/gander/adaptlob.m">http://www.inf.ethz.ch/personal/gander/adaptlob.m</a> </p>
</div></div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>