NAG CL Interface
g01gbc (prob_students_t_noncentral)
1
Purpose
g01gbc returns the lower tail probability for the noncentral Student's -distribution.
2
Specification
The function may be called by the names: g01gbc, nag_stat_prob_students_t_noncentral or nag_prob_non_central_students_t.
3
Description
The lower tail probability of the noncentral Student's
-distribution with
degrees of freedom and noncentrality parameter
,
, is defined by
with
The probability is computed in one of two ways.
-
(i)When , the relationship to the normal is used:
-
(ii)Otherwise the series expansion described in Equation 9 of Amos (1964) is used. This involves the sums of confluent hypergeometric functions, the terms of which are computed using recurrence relationships.
4
References
Amos D E (1964) Representations of the central and non-central -distributions Biometrika 51 451–458
5
Arguments
-
1:
– double
Input
-
On entry: , the deviate from the Student's -distribution with degrees of freedom.
-
2:
– double
Input
-
On entry: , the degrees of freedom of the Student's -distribution.
Constraint:
.
-
3:
– double
Input
-
On entry: , the noncentrality parameter of the Students -distribution.
-
4:
– double
Input
-
On entry: the absolute accuracy required by you in the results. If
g01gbc is entered with
tol greater than or equal to
or less than
(see
X02AJC), the value of
is used instead.
-
5:
– Integer
Input
-
On entry: the maximum number of terms that are used in each of the summations.
Suggested value:
. See
Section 9 for further comments.
Constraint:
.
-
6:
– NagError *
Input/Output
-
The
NAG error argument (see
Section 7 in the Introduction to the
NAG Library CL Interface).
6
Error Indicators and Warnings
If on exit NE_NOERROR, then g01gbc returns .
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 3.1.2 in the Introduction to the
NAG Library CL Interface for further information.
- NE_INT_ARG_LT
-
On entry, .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
See
Section 7.5 in the Introduction to the
NAG Library CL Interface for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the
NAG Library CL Interface for further information.
- NE_PROB_LIMIT
-
The probability is too close to or . The returned value should be a reasonable estimate of the true value.
- NE_PROBABILITY
-
Unable to calculate the probability as it is too close to zero or one.
- NE_REAL_ARG_LT
-
On entry, .
Constraint: .
- NE_SERIES
-
One of the series has failed to converge with and . Reconsider the requested tolerance and/or the maximum number of iterations.
7
Accuracy
The series described in
Amos (1964) are summed until an estimated upper bound on the contribution of future terms to the probability is less than
tol. There may also be some loss of accuracy due to calculation of gamma functions.
8
Parallelism and Performance
Background information to multithreading can be found in the
Multithreading documentation.
g01gbc is not threaded in any implementation.
The rate of convergence of the series depends, in part, on the quantity . The smaller this quantity the faster the convergence. Thus for large and small the convergence may be slow. If is an integer then one of the series to be summed is of finite length.
If two tail probabilities are required then the relationship of the
-distribution to the
-distribution can be used:
and a call made to
g01gdc.
Note that g01gbc only allows degrees of freedom greater than or equal to although values between and are theoretically possible.
10
Example
This example reads values from, and degrees of freedom for, and noncentrality parameters of the noncentral Student's -distributions, calculates the lower tail probabilities and prints all these values until the end of data is reached.
10.1
Program Text
10.2
Program Data
10.3
Program Results