NAG Library ManualKeyword Search:

NAG Library Routine Document

g01fcf (inv_cdf_chisq)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

g01fcf returns the deviate associated with the given lower tail probability of the

χ^{2}

-distribution with real degrees of freedom, via the routine name.

2

Specification

Fortran Interface

Function g01fcf (

p, df, ifail)

Real (Kind=nag_wp)	::	g01fcf
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	p, df

C Header Interface

#include nagmk26.h

double

g01fcf_ ( const double *p, const double *df, Integer *ifail)

3

Description

The deviate,

x_{p}

, associated with the lower tail probability

p

of the

χ^{2}

-distribution with

ν

degrees of freedom is defined as the solution to

P (X \leq x_{p} : ν) = p = \frac{1}{2^{ν / 2} Γ (ν / 2)} \int_{0}^{x_{p}} e^{- X / 2} X^{v / 2 - 1} d X, 0 \leq x_{p} < \infty; ν > 0 .

The required

x_{p}

is found by using the relationship between a

χ^{2}

-distribution and a gamma distribution, i.e., a

χ^{2}

-distribution with

ν

degrees of freedom is equal to a gamma distribution with scale parameter

2

and shape parameter

ν / 2

For very large values of

ν

, greater than

10^{5}

, Wilson and Hilferty's normal approximation to the

χ^{2}

is used; see Kendall and Stuart (1969).

4

References

Best D J and Roberts D E (1975) Algorithm AS 91. The percentage points of the

χ^{2}

distribution Appl. Statist. 24 385–388

Hastings N A J and Peacock J B (1975) Statistical Distributions Butterworth

Kendall M G and Stuart A (1969) The Advanced Theory of Statistics (Volume 1) (3rd Edition) Griffin

5

Arguments

1: $p$ – Real (Kind=nag_wp)Input: On entry: $p$ , the lower tail probability from the required $χ^{2}$ -distribution.

Constraint: $0.0 \leq p < 1.0$ .
2: $df$ – Real (Kind=nag_wp)Input: On entry: $ν$ , the degrees of freedom of the $χ^{2}$ -distribution.

Constraint: $df > 0.0$ .
3: $ifail$ – IntegerInput/Output: On entry: ifail must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, because for this routine the values of the output arguments may be useful even if $ifail \neq 0$ on exit, the recommended value is $- 1$ . When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Note: g01fcf may return useful information for one or more of the following detected errors or warnings.

Errors or warnings detected by the routine:

ifail = 1

2

3

5

on exit, then g01fcf returns

0.0

$ifail = 1$: On entry, $p = 〈value〉$ .
Constraint: $p \geq 0.0$ .

On entry, $p = 〈value〉$ .
Constraint: $p < 1.0$ .

$ifail = 2$: On entry, $df = 〈value〉$ .
Constraint: $df > 0.0$ .

$ifail = 3$: The probability is too close to $0.0$ or $1.0$ .

$ifail = 4$: The algorithm has failed to converge in $〈value〉$ iterations. The result should be a reasonable approximation.

$ifail = 5$: The series used to calculate the gamma function has failed to converge. This is an unlikely error exit.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

The results should be accurate to five significant digits for most argument values. Some accuracy is lost for

p

close to

0.0

8

Parallelism and Performance

g01fcf is not threaded in any implementation.

9

Further Comments

For higher accuracy the relationship described in Section 3 may be used and a direct call to g01fff made.

10

Example

This example reads lower tail probabilities for several

χ^{2}

-distributions, and calculates and prints the corresponding deviates until the end of data is reached.

NAG Library Routine Document

g01fcf (inv_cdf_chisq)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results