summaryrefslogtreecommitdiff
path: root/libs/math/doc/html/math_toolkit/sf_beta/beta_function.html
blob: e8aedecd35e9f74014083bb2c625fa8f5673ac2b (plain)
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Beta</title>
<link rel="stylesheet" href="../../math.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="../../index.html" title="Math Toolkit 2.2.0">
<link rel="up" href="../sf_beta.html" title="Beta Functions">
<link rel="prev" href="../sf_beta.html" title="Beta Functions">
<link rel="next" href="ibeta_function.html" title="Incomplete Beta Functions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../sf_beta.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sf_beta.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ibeta_function.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="math_toolkit.sf_beta.beta_function"></a><a class="link" href="beta_function.html" title="Beta">Beta</a>
</h3></div></div></div>
<h5>
<a name="math_toolkit.sf_beta.beta_function.h0"></a>
        <span class="phrase"><a name="math_toolkit.sf_beta.beta_function.synopsis"></a></span><a class="link" href="beta_function.html#math_toolkit.sf_beta.beta_function.synopsis">Synopsis</a>
      </h5>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">math</span><span class="special">/</span><span class="identifier">special_functions</span><span class="special">/</span><span class="identifier">beta</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">math</span><span class="special">{</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T2</span><span class="special">&gt;</span>
<a class="link" href="../result_type.html" title="Calculation of the Type of the Result"><span class="emphasis"><em>calculated-result-type</em></span></a> <span class="identifier">beta</span><span class="special">(</span><span class="identifier">T1</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">T2</span> <span class="identifier">b</span><span class="special">);</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T2</span><span class="special">,</span> <span class="keyword">class</span> <a class="link" href="../../policy.html" title="Chapter&#160;14.&#160;Policies: Controlling Precision, Error Handling etc">Policy</a><span class="special">&gt;</span>
<a class="link" href="../result_type.html" title="Calculation of the Type of the Result"><span class="emphasis"><em>calculated-result-type</em></span></a> <span class="identifier">beta</span><span class="special">(</span><span class="identifier">T1</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">T2</span> <span class="identifier">b</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../../policy.html" title="Chapter&#160;14.&#160;Policies: Controlling Precision, Error Handling etc">Policy</a><span class="special">&amp;);</span>

<span class="special">}}</span> <span class="comment">// namespaces</span>
</pre>
<h5>
<a name="math_toolkit.sf_beta.beta_function.h1"></a>
        <span class="phrase"><a name="math_toolkit.sf_beta.beta_function.description"></a></span><a class="link" href="beta_function.html#math_toolkit.sf_beta.beta_function.description">Description</a>
      </h5>
<p>
        The beta function is defined by:
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta1.svg"></span>
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../graphs/beta.svg" align="middle"></span>
      </p>
<p>
        The final <a class="link" href="../../policy.html" title="Chapter&#160;14.&#160;Policies: Controlling Precision, Error Handling etc">Policy</a> argument is optional and can
        be used to control the behaviour of the function: how it handles errors,
        what level of precision to use etc. Refer to the <a class="link" href="../../policy.html" title="Chapter&#160;14.&#160;Policies: Controlling Precision, Error Handling etc">policy
        documentation for more details</a>.
      </p>
<p>
        There are effectively two versions of this function internally: a fully generic
        version that is slow, but reasonably accurate, and a much more efficient
        approximation that is used where the number of digits in the significand
        of T correspond to a certain <a class="link" href="../lanczos.html" title="The Lanczos Approximation">Lanczos
        approximation</a>. In practice any built-in floating-point type you will
        encounter has an appropriate <a class="link" href="../lanczos.html" title="The Lanczos Approximation">Lanczos
        approximation</a> defined for it. It is also possible, given enough machine
        time, to generate further <a class="link" href="../lanczos.html" title="The Lanczos Approximation">Lanczos approximation</a>'s
        using the program libs/math/tools/lanczos_generator.cpp.
      </p>
<p>
        The return type of these functions is computed using the <a class="link" href="../result_type.html" title="Calculation of the Type of the Result"><span class="emphasis"><em>result
        type calculation rules</em></span></a> when T1 and T2 are different types.
      </p>
<h5>
<a name="math_toolkit.sf_beta.beta_function.h2"></a>
        <span class="phrase"><a name="math_toolkit.sf_beta.beta_function.accuracy"></a></span><a class="link" href="beta_function.html#math_toolkit.sf_beta.beta_function.accuracy">Accuracy</a>
      </h5>
<p>
        The following table shows peak errors for various domains of input arguments,
        along with comparisons to the <a href="http://www.gnu.org/software/gsl/" target="_top">GSL-1.9</a>
        and <a href="http://www.netlib.org/cephes/" target="_top">Cephes</a> libraries.
        Note that only results for the widest floating point type on the system are
        given as narrower types have <a class="link" href="../relative_error.html#math_toolkit.relative_error.zero_error">effectively
        zero error</a>.
      </p>
<div class="table">
<a name="math_toolkit.sf_beta.beta_function.peak_errors_in_the_beta_function"></a><p class="title"><b>Table&#160;6.7.&#160;Peak Errors In the Beta Function</b></p>
<div class="table-contents"><table class="table" summary="Peak Errors In the Beta Function">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Significand Size
                </p>
              </th>
<th>
                <p>
                  Platform and Compiler
                </p>
              </th>
<th>
                <p>
                  Errors in range
                </p>
                <p>
                  0.4 &lt; a,b &lt; 100
                </p>
              </th>
<th>
                <p>
                  Errors in range
                </p>
                <p>
                  1e-6 &lt; a,b &lt; 36
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  53
                </p>
              </td>
<td>
                <p>
                  Win32, Visual C++ 8
                </p>
              </td>
<td>
                <p>
                  Peak=99 Mean=22
                </p>
                <p>
                  (GSL Peak=1178 Mean=238)
                </p>
                <p>
                  (<a href="http://www.netlib.org/cephes/" target="_top">Cephes</a>=1612)
                </p>
              </td>
<td>
                <p>
                  Peak=10.7 Mean=2.6
                </p>
                <p>
                  (GSL Peak=12 Mean=2.0)
                </p>
                <p>
                  (<a href="http://www.netlib.org/cephes/" target="_top">Cephes</a>=174)
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  64
                </p>
              </td>
<td>
                <p>
                  Red Hat Linux IA32, g++ 3.4.4
                </p>
              </td>
<td>
                <p>
                  Peak=112.1 Mean=26.9
                </p>
              </td>
<td>
                <p>
                  Peak=15.8 Mean=3.6
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  64
                </p>
              </td>
<td>
                <p>
                  Red Hat Linux IA64, g++ 3.4.4
                </p>
              </td>
<td>
                <p>
                  Peak=61.4 Mean=19.5
                </p>
              </td>
<td>
                <p>
                  Peak=12.2 Mean=3.6
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  113
                </p>
              </td>
<td>
                <p>
                  HPUX IA64, aCC A.06.06
                </p>
              </td>
<td>
                <p>
                  Peak=42.03 Mean=13.94
                </p>
              </td>
<td>
                <p>
                  Peak=9.8 Mean=3.1
                </p>
              </td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><p>
        Note that the worst errors occur when a or b are large, and that when this
        is the case the result is very close to zero, so absolute errors will be
        very small.
      </p>
<h5>
<a name="math_toolkit.sf_beta.beta_function.h3"></a>
        <span class="phrase"><a name="math_toolkit.sf_beta.beta_function.testing"></a></span><a class="link" href="beta_function.html#math_toolkit.sf_beta.beta_function.testing">Testing</a>
      </h5>
<p>
        A mixture of spot tests of exact values, and randomly generated test data
        are used: the test data was computed using <a href="http://shoup.net/ntl/doc/RR.txt" target="_top">NTL::RR</a>
        at 1000-bit precision.
      </p>
<h5>
<a name="math_toolkit.sf_beta.beta_function.h4"></a>
        <span class="phrase"><a name="math_toolkit.sf_beta.beta_function.implementation"></a></span><a class="link" href="beta_function.html#math_toolkit.sf_beta.beta_function.implementation">Implementation</a>
      </h5>
<p>
        Traditional methods of evaluating the beta function either involve evaluating
        the gamma functions directly, or taking logarithms and then exponentiating
        the result. However, the former is prone to overflows for even very modest
        arguments, while the latter is prone to cancellation errors. As an alternative,
        if we regard the gamma function as a white-box containing the <a class="link" href="../lanczos.html" title="The Lanczos Approximation">Lanczos
        approximation</a>, then we can combine the power terms:
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta2.svg"></span>
      </p>
<p>
        which is almost the ideal solution, however almost all of the error occurs
        in evaluating the power terms when <span class="emphasis"><em>a</em></span> or <span class="emphasis"><em>b</em></span>
        are large. If we assume that <span class="emphasis"><em>a &gt; b</em></span> then the larger
        of the two power terms can be reduced by a factor of <span class="emphasis"><em>b</em></span>,
        which immediately cuts the maximum error in half:
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta3.svg"></span>
      </p>
<p>
        This may not be the final solution, but it is very competitive compared to
        other implementation methods.
      </p>
<p>
        The generic implementation - where no <a class="link" href="../lanczos.html" title="The Lanczos Approximation">Lanczos
        approximation</a> approximation is available - is implemented in a very
        similar way to the generic version of the gamma function. Again in order
        to avoid numerical overflow the power terms that prefix the series and continued
        fraction parts are collected together into:
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta8.svg"></span>
      </p>
<p>
        where la, lb and lc are the integration limits used for a, b, and a+b.
      </p>
<p>
        There are a few special cases worth mentioning:
      </p>
<p>
        When <span class="emphasis"><em>a</em></span> or <span class="emphasis"><em>b</em></span> are less than one,
        we can use the recurrence relations:
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta4.svg"></span>
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta5.svg"></span>
      </p>
<p>
        to move to a more favorable region where they are both greater than 1.
      </p>
<p>
        In addition:
      </p>
<p>
        <span class="inlinemediaobject"><img src="../../../equations/beta7.svg"></span>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2006-2010, 2012-2014 Nikhar Agrawal,
      Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos, Hubert
      Holin, Bruno Lalande, John Maddock, Johan R&#229;de, Gautam Sewani, Benjamin Sobotta,
      Thijs van den Berg, Daryle Walker and Xiaogang Zhang<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../sf_beta.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sf_beta.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ibeta_function.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>