Namespace: nagcpp

Namespace: stat

Function: prob_students_t_noncentral

NAG CPP Interface
nagcpp::stat::prob_students_t_noncentral (g01gb)

Keyword Search:

NAG Library Manual, Mark 29.2

Interfaces: FL CL CPP AD PY MB

NAG CPP Interface Introduction

G01 (Stat) Chapter Contents

g01gb: FL CL CPP AD PY MB

Namespace: nagcpp

Namespace: stat

Function: prob_students_t_noncentral

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Exceptions and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Example Program

Settings help

CPP Name Style:
NAG (a00aa)
Short (impl_details)
Long (info::impl_details)
Full (nagcpp::info::impl_details)

1 Purpose

prob_students_t_noncentral returns the lower tail probability for the noncentral Student's

t

-distribution.

2 Specification

#include "g01/nagcpp_g01gb.hpp"

double prob_students_t_noncentral(const double t, const double df, const double delta, OptionalG01GB opt)

double prob_students_t_noncentral(const double t, const double df, const double delta)

3 Description

The lower tail probability of the noncentral Student's

t

-distribution with

ν

degrees of freedom and noncentrality parameter

δ

P (T \leq t : ν; δ)

, is defined by

P (T \leq t : ν; δ) = C_{ν} \int_{0}^{\infty} (\frac{1}{\sqrt{2 π}} \int_{- \infty}^{α u - δ} e^{- x^{2} / 2} d x) u^{ν - 1} e^{- u^{2} / 2} d u, ν > 0.0

with

C_{ν} = \frac{1}{Γ (\frac{1}{2} ν) 2^{(ν - 2) / 2}}, α = \frac{t}{\sqrt{ν}} .

The probability is computed in one of two ways.

(i)When $t = 0.0$ , the relationship to the normal is used:

$P (T \leq t : ν; δ) = \frac{1}{\sqrt{2 π}} \int_{δ}^{\infty} e^{- u^{2} / 2} d u .$
(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

t

-distributions Biometrika 51 451–458

5 Arguments

1: $t$ – double Input

On entry:

t

, the deviate from the Student's

t

-distribution with

ν

degrees of freedom.

2: $df$ – double Input

On entry:

ν

, the degrees of freedom of the Student's

t

-distribution.

Constraint:

df \geq 1.0

3: $delta$ – double Input

On entry:

δ

, the noncentrality parameter of the Students

t

-distribution.

4: $opt$ – OptionalG01GB Input/Output

Optional parameter container, derived from Optional.

Container for:

tol – double: This optional parameter may be set using the method OptionalG01GB::tol and accessed via OptionalG01GB::get_tol.
Default: $0.0$

On entry: the absolute accuracy required by you in the results. If prob_students_t_noncentral is entered with tol greater than or equal to $1.0$ or less than $10 \times machine precision$ (see precision), the value of $10 \times machine precision$ is used instead.
maxit – types::f77_integer: This optional parameter may be set using the method OptionalG01GB::maxit and accessed via OptionalG01GB::get_maxit.
Default: $100$

On entry: the maximum number of terms that are used in each of the summations.

Suggested value: $100$ . See Section 9 for further comments.

Constraint: $maxit \geq 1$ .

6 Exceptions and Warnings

Errors or warnings detected by the function:

If on exit

errorid \neq 0

, then prob_students_t_noncentral returns

0.0

All errors and warnings have an associated numeric error code field, errorid, stored either as a member of the thrown exception object (see errorid), or as a member of opt.ifail, depending on how errors and warnings are being handled (see Error Handling for more details).

Raises: ErrorException

$errorid = 1$: On entry, $df = ⟨ value ⟩$ .
Constraint: $df \geq 1.0$ .

$errorid = 2$: On entry, $maxit = ⟨ value ⟩$ .
Constraint: $maxit \geq 1$ .

$errorid = 4$: Unable to calculate the probability as it is too close to zero or one.

$errorid = −99$: An unexpected error has been triggered by this routine.

$errorid = −399$: Your licence key may have expired or may not have been installed correctly.

$errorid = −999$: Dynamic memory allocation failed.

Raises: WarningException

$errorid = 3$: One of the series has failed to converge with $maxit = ⟨ value ⟩$
and $tol = ⟨ value ⟩$ .
Reconsider the requested tolerance and/or the maximum number of iterations.

$errorid = 4$: The probability is too close to $0$ or $1$ .
The returned value should be a reasonable estimate of the true value.

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

Please see the description for the underlying computational routine in this section of the FL Interface documentation.

9 Further Comments

The rate of convergence of the series depends, in part, on the quantity

t^{2} / (t^{2} + ν)

. The smaller this quantity the faster the convergence. Thus for large

t

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

t

-distribution to the

F

-distribution can be used:

F = T^{2}, λ = δ^{2}, ν_{1} = 1 and ν_{2} = ν,

and a call made to g01gdf (no CPP interface).

Note that prob_students_t_noncentral only allows degrees of freedom greater than or equal to

1

although values between

0

and

1

are theoretically possible.

10 Example

This example reads values from, and degrees of freedom for, and noncentrality parameters of the noncentral Student's

t

-distributions, calculates the lower tail probabilities and prints all these values until the end of data is reached.

10.1 Example Program

Source File	Data	Results
ex_g01gb.cpp	None	ex_g01gb.r

NAG Library Manual, Mark 29.2

Interfaces: FL CL CPP AD PY MB

NAG CPP Interface Introduction

G01 (Stat) Chapter Contents

g01gb: FL CL CPP AD PY MB

Namespace: nagcpp

Namespace: stat

Function: prob_students_t_noncentral

NAG CPP Interfacenagcpp::stat::prob_students_t_noncentral (g01gb)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Exceptions and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Example Program

NAG CPP Interface
nagcpp::stat::prob_students_t_noncentral (g01gb)