summaryrefslogtreecommitdiff
path: root/libs/math/doc/sf_and_dist/html/math_toolkit/dist/dist_ref/dists/nc_t_dist.html
blob: 18e2927b837b2a657943a477016be3350501199a (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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Noncentral T Distribution</title>
<link rel="stylesheet" href="../../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../../../index.html" title="Math Toolkit">
<link rel="up" href="../dists.html" title="Distributions">
<link rel="prev" href="nc_f_dist.html" title="Noncentral F Distribution">
<link rel="next" href="normal_dist.html" title="Normal (Gaussian) Distribution">
</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="nc_f_dist.html"><img src="../../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../dists.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="normal_dist.html"><img src="../../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section math_toolkit_dist_dist_ref_dists_nc_t_dist">
<div class="titlepage"><div><div><h5 class="title">
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist"></a><a class="link" href="nc_t_dist.html" title="Noncentral T Distribution">Noncentral
          T Distribution</a>
</h5></div></div></div>
<p>
</p>
<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">distributions</span><span class="special">/</span><span class="identifier">non_central_t</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></pre>
<p>
          </p>
<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">RealType</span> <span class="special">=</span> <span class="keyword">double</span><span class="special">,</span>
          <span class="keyword">class</span> <a class="link" href="../../../policy.html" title="Policies">Policy</a>   <span class="special">=</span> <a class="link" href="../../../policy/pol_ref/pol_ref_ref.html" title="Policy Class Reference">policies::policy&lt;&gt;</a> <span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">non_central_t_distribution</span><span class="special">;</span>

<span class="keyword">typedef</span> <span class="identifier">non_central_t_distribution</span><span class="special">&lt;&gt;</span> <span class="identifier">non_central_t</span><span class="special">;</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RealType</span><span class="special">,</span> <span class="keyword">class</span> <a class="link" href="../../../policy.html" title="Policies">Policy</a><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">non_central_t_distribution</span>
<span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
   <span class="keyword">typedef</span> <span class="identifier">RealType</span>  <span class="identifier">value_type</span><span class="special">;</span>
   <span class="keyword">typedef</span> <span class="identifier">Policy</span>    <span class="identifier">policy_type</span><span class="special">;</span>

   <span class="comment">// Constructor:</span>
   <span class="identifier">non_central_t_distribution</span><span class="special">(</span><span class="identifier">RealType</span> <span class="identifier">v</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="identifier">delta</span><span class="special">);</span>

   <span class="comment">// Accessor to degrees_of_freedom parameter v:</span>
   <span class="identifier">RealType</span> <span class="identifier">degrees_of_freedom</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span>

   <span class="comment">// Accessor to non-centrality parameter lambda:</span>
   <span class="identifier">RealType</span> <span class="identifier">non_centrality</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span>
<span class="special">};</span>

<span class="special">}}</span> <span class="comment">// namespaces</span>
</pre>
<p>
            The noncentral T distribution is a generalization of the <a class="link" href="students_t_dist.html" title="Students t Distribution">Students
            t Distribution</a>. Let X have a normal distribution with mean &#948; and
            variance 1, and let &#957; S<sup>2</sup> have a chi-squared distribution with degrees of
            freedom &#957;. Assume that X and S<sup>2</sup> are independent. The distribution of t<sub>&#957;</sub>(&#948;)=X/S
            is called a noncentral t distribution with degrees of freedom &#957; and noncentrality
            parameter &#948;.
          </p>
<p>
            This gives the following PDF:
          </p>
<p>
            <span class="inlinemediaobject"><img src="../../../../../equations/nc_t_ref1.png"></span>
          </p>
<p>
            where <sub>1</sub>F<sub>1</sub>(a;b;x) is a confluent hypergeometric function.
          </p>
<p>
            The following graph illustrates how the distribution changes for different
            values of &#948;:
          </p>
<p>
            <span class="inlinemediaobject"><img src="../../../../../graphs/nc_t_pdf.png" align="middle"></span>
          </p>
<h5>
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.h0"></a>
            <span><a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.member_functions"></a></span><a class="link" href="nc_t_dist.html#math_toolkit.dist.dist_ref.dists.nc_t_dist.member_functions">Member
            Functions</a>
          </h5>
<pre class="programlisting"><span class="identifier">non_central_t_distribution</span><span class="special">(</span><span class="identifier">RealType</span> <span class="identifier">v</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="identifier">lambda</span><span class="special">);</span>
</pre>
<p>
            Constructs a non-central t distribution with degrees of freedom parameter
            <span class="emphasis"><em>v</em></span> and non-centrality parameter <span class="emphasis"><em>delta</em></span>.
          </p>
<p>
            Requires v &gt; 0 and finite delta, otherwise calls <a class="link" href="../../../main_overview/error_handling.html#domain_error">domain_error</a>.
          </p>
<pre class="programlisting"><span class="identifier">RealType</span> <span class="identifier">degrees_of_freedom</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span>
</pre>
<p>
            Returns the parameter <span class="emphasis"><em>v</em></span> from which this object was
            constructed.
          </p>
<pre class="programlisting"><span class="identifier">RealType</span> <span class="identifier">non_centrality</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span>
</pre>
<p>
            Returns the non-centrality parameter <span class="emphasis"><em>delta</em></span> from
            which this object was constructed.
          </p>
<h5>
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.h1"></a>
            <span><a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.non_member_accessors"></a></span><a class="link" href="nc_t_dist.html#math_toolkit.dist.dist_ref.dists.nc_t_dist.non_member_accessors">Non-member
            Accessors</a>
          </h5>
<p>
            All the <a class="link" href="../nmp.html" title="Non-Member Properties">usual non-member
            accessor functions</a> that are generic to all distributions are supported:
            <a class="link" href="../nmp.html#math.dist.cdf">Cumulative Distribution Function</a>,
            <a class="link" href="../nmp.html#math.dist.pdf">Probability Density Function</a>, <a class="link" href="../nmp.html#math.dist.quantile">Quantile</a>, <a class="link" href="../nmp.html#math.dist.hazard">Hazard
            Function</a>, <a class="link" href="../nmp.html#math.dist.chf">Cumulative Hazard Function</a>,
            <a class="link" href="../nmp.html#math.dist.mean">mean</a>, <a class="link" href="../nmp.html#math.dist.median">median</a>,
            <a class="link" href="../nmp.html#math.dist.mode">mode</a>, <a class="link" href="../nmp.html#math.dist.variance">variance</a>,
            <a class="link" href="../nmp.html#math.dist.sd">standard deviation</a>, <a class="link" href="../nmp.html#math.dist.skewness">skewness</a>,
            <a class="link" href="../nmp.html#math.dist.kurtosis">kurtosis</a>, <a class="link" href="../nmp.html#math.dist.kurtosis_excess">kurtosis_excess</a>,
            <a class="link" href="../nmp.html#math.dist.range">range</a> and <a class="link" href="../nmp.html#math.dist.support">support</a>.
          </p>
<p>
            The domain of the random variable is [-&#8734;, +&#8734;].
          </p>
<h5>
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.h2"></a>
            <span><a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.accuracy"></a></span><a class="link" href="nc_t_dist.html#math_toolkit.dist.dist_ref.dists.nc_t_dist.accuracy">Accuracy</a>
          </h5>
<p>
            The following table shows the peak errors (in units of <a href="http://en.wikipedia.org/wiki/Machine_epsilon" target="_top">epsilon</a>)
            found on various platforms with various floating-point types. Unless
            otherwise specified, any floating-point type that is narrower than the
            one shown will have <a class="link" href="../../../backgrounders/relative_error.html#zero_error">effectively zero error</a>.
          </p>
<div class="table">
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.errors_in_cdf_of_the_noncentral_t_distribution"></a><p class="title"><b>Table&#160;18.&#160;Errors In CDF of the Noncentral T Distribution</b></p>
<div class="table-contents"><table class="table" summary="Errors In CDF of the Noncentral T Distribution">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Significand Size
                    </p>
                  </th>
<th>
                    <p>
                      Platform and Compiler
                    </p>
                  </th>
<th>
                    <p>
                      &#957;,&#948; &lt; 600
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      53
                    </p>
                  </td>
<td>
                    <p>
                      Win32, Visual C++ 8
                    </p>
                  </td>
<td>
                    <p>
                      Peak=120 Mean=26
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      64
                    </p>
                  </td>
<td>
                    <p>
                      RedHat Linux IA32, gcc-4.1.1
                    </p>
                  </td>
<td>
                    <p>
                      Peak=121 Mean=26
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      64
                    </p>
                  </td>
<td>
                    <p>
                      Redhat Linux IA64, gcc-3.4.4
                    </p>
                  </td>
<td>
                    <p>
                      Peak=122 Mean=25
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      113
                    </p>
                  </td>
<td>
                    <p>
                      HPUX IA64, aCC A.06.06
                    </p>
                  </td>
<td>
                    <p>
                      Peak=115 Mean=24
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="caution"><table border="0" summary="Caution">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../../../../doc/src/images/caution.png"></td>
<th align="left">Caution</th>
</tr>
<tr><td align="left" valign="top"><p>
              The complexity of the current algorithm is dependent upon &#948;<sup>2</sup>: consequently
              the time taken to evaluate the CDF increases rapidly for &#948; &gt; 500,
              likewise the accuracy decreases rapidly for very large &#948;.
            </p></td></tr>
</table></div>
<p>
            Accuracy for the quantile and PDF functions should be broadly similar,
            note however that the <span class="emphasis"><em>mode</em></span> is determined numerically
            and can not in principal be more accurate than the square root of machine
            epsilon.
          </p>
<h5>
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.h3"></a>
            <span><a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.tests"></a></span><a class="link" href="nc_t_dist.html#math_toolkit.dist.dist_ref.dists.nc_t_dist.tests">Tests</a>
          </h5>
<p>
            There are two sets of tests of this distribution: basic sanity checks
            compare this implementation to the test values given in "Computing
            discrete mixtures of continuous distributions: noncentral chisquare,
            noncentral t and the distribution of the square of the sample multiple
            correlation coefficient." Denise Benton, K. Krishnamoorthy, Computational
            Statistics &amp; Data Analysis 43 (2003) 249-267. While accuracy checks
            use test data computed with this implementation and arbitary precision
            interval arithmetic: this test data is believed to be accurate to at
            least 50 decimal places.
          </p>
<h5>
<a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.h4"></a>
            <span><a name="math_toolkit.dist.dist_ref.dists.nc_t_dist.implementation"></a></span><a class="link" href="nc_t_dist.html#math_toolkit.dist.dist_ref.dists.nc_t_dist.implementation">Implementation</a>
          </h5>
<p>
            The CDF is computed using a modification of the method described in "Computing
            discrete mixtures of continuous distributions: noncentral chisquare,
            noncentral t and the distribution of the square of the sample multiple
            correlation coefficient." Denise Benton, K. Krishnamoorthy, Computational
            Statistics &amp; Data Analysis 43 (2003) 249-267.
          </p>
<p>
            This uses the following formula for the CDF:
          </p>
<p>
            <span class="inlinemediaobject"><img src="../../../../../equations/nc_t_ref2.png"></span>
          </p>
<p>
            Where I<sub>x</sub>(a,b) is the incomplete beta function, and &#934;(x) is the normal
            CDF at x.
          </p>
<p>
            Iteration starts at the largest of the Poisson weighting terms (at i
            = &#948;<sup>2</sup> / 2) and then proceeds in both directions as per Benton and Krishnamoorthy's
            paper.
          </p>
<p>
            Alternatively, by considering what happens when t = &#8734;, we have x = 1,
            and therefore I<sub>x</sub>(a,b) = 1 and:
          </p>
<p>
            <span class="inlinemediaobject"><img src="../../../../../equations/nc_t_ref3.png"></span>
          </p>
<p>
            From this we can easily show that:
          </p>
<p>
            <span class="inlinemediaobject"><img src="../../../../../equations/nc_t_ref4.png"></span>
          </p>
<p>
            and therefore we have a means to compute either the probability or its
            complement directly without the risk of cancellation error. The crossover
            criterion for choosing whether to calculate the CDF or its complement
            is the same as for the <a class="link" href="nc_beta_dist.html" title="Noncentral Beta Distribution">Noncentral
            Beta Distribution</a>.
          </p>
<p>
            The PDF can be computed by a very similar method using:
          </p>
<p>
            <span class="inlinemediaobject"><img src="../../../../../equations/nc_t_ref5.png"></span>
          </p>
<p>
            Where I<sub>x</sub><sup>'</sup>(a,b) is the derivative of the incomplete beta function.
          </p>
<p>
            The quantile is calculated via the usual <a class="link" href="../../../toolkit/internals1/roots2.html" title="Root Finding Without Derivatives: Bisection, Bracket and TOMS748">derivative-free
            root-finding techniques</a>, with the initial guess taken as the quantile
            of a normal approximation to the noncentral T.
          </p>
<p>
            There is no closed form for the mode, so this is computed via functional
            maximisation of the PDF.
          </p>
<p>
            The remaining functions (mean, variance etc) are implemented using the
            formulas given in Weisstein, Eric W. "Noncentral Student's t-Distribution."
            From MathWorld--A Wolfram Web Resource. <a href="http://mathworld.wolfram.com/NoncentralStudentst-Distribution.html" target="_top">http://mathworld.wolfram.com/NoncentralStudentst-Distribution.html</a>
            and in the <a href="http://reference.wolfram.com/mathematica/ref/NoncentralStudentTDistribution.html" target="_top">Mathematica
            documentation</a>.
          </p>
<p>
            Some analytic properties of noncentral distributions (particularly unimodality,
            and monotonicity of their modes) are surveyed and summarized by:
          </p>
<p>
            Andrea van Aubel &amp; Wolfgang Gawronski, Applied Mathematics and Computation,
            141 (2003) 3-12.
          </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 John Maddock, Paul A. Bristow, Hubert Holin, Xiaogang Zhang, Bruno
      Lalande, Johan R&#229;de, Gautam Sewani and Thijs van den Berg<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="nc_f_dist.html"><img src="../../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../dists.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="normal_dist.html"><img src="../../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>