G01ERF (PDF version)
G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

NAG Library Routine Document


Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.


    1  Purpose
    7  Accuracy

1  Purpose

G01ERF returns the probability associated with the lower tail of the von Mises distribution between -π and π through the function name.

2  Specification

REAL (KIND=nag_wp) G01ERF
REAL (KIND=nag_wp)  T, VK

3  Description

The von Mises distribution is a symmetric distribution used in the analysis of circular data. The lower tail area of this distribution on the circle with mean direction μ0=0 and concentration parameter kappa, κ, can be written as
PrΘθ:κ=12πI0κ -πθeκcosΘdΘ,  
where θ is reduced modulo 2π so that -πθ<π and κ0. Note that if θ=π then G01ERF returns a probability of 1. For very small κ the distribution is almost the uniform distribution, whereas for κ all the probability is concentrated at one point.
The method of calculation for small κ involves backwards recursion through a series expansion in terms of modified Bessel functions, while for large κ an asymptotic Normal approximation is used.
In the case of small κ the series expansion of Pr(Θθ: κ) can be expressed as
PrΘθ:κ=12+θ 2π +1πI0κ n=1n-1Inκsinnθ,  
where Inκ is the modified Bessel function. This series expansion can be represented as a nested expression of terms involving the modified Bessel function ratio Rn,
Rnκ=Inκ In-1κ ,  n=1,2,3,,  
which is calculated using backwards recursion.
For large values of κ (see Section 7) an asymptotic Normal approximation is used. The angle Θ is transformed to the nearly Normally distributed variate Z,
bκ=2π eκ I0κ  
and bκ is computed from a continued fraction approximation. An approximation to order κ-4 of the asymptotic normalizing series for z is then used. Finally the Normal probability integral is evaluated.
For a more detailed analysis of the methods used see Hill (1977).

4  References

Hill G W (1977) Algorithm 518: Incomplete Bessel function I0: The Von Mises distribution ACM Trans. Math. Software 3 279–284
Mardia K V (1972) Statistics of Directional Data Academic Press

5  Parameters

1:     T – REAL (KIND=nag_wp)Input
On entry: θ, the observed von Mises statistic measured in radians.
2:     VK – REAL (KIND=nag_wp)Input
On entry: the concentration parameter κ, of the von Mises distribution.
Constraint: VK0.0.
3:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction 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, if you are not familiar with this parameter, the recommended value is 0. 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 or -1, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
On entry,VK<0.0 and G01ERF returns 0.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.
Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

G01ERF uses one of two sets of constants depending on the value of machine precision. One set gives an accuracy of six digits and uses the Normal approximation when VK6.5, the other gives an accuracy of 12 digits and uses the Normal approximation when VK50.0.

8  Parallelism and Performance

Not applicable.

9  Further Comments

Using the series expansion for small κ the time taken by G01ERF increases linearly with κ; for larger κ, for which the asymptotic Normal approximation is used, the time taken is much less.
If angles outside the region -πθ<π are used care has to be taken in evaluating the probability of being in a region θ1θθ2 if the region contains an odd multiple of π, 2n+1π. The value of Fθ2;κ-Fθ1;κ will be negative and the correct probability should then be obtained by adding one to the value.

10  Example

This example inputs four values from the von Mises distribution along with the values of the parameter κ. The probabilities are computed and printed.

10.1  Program Text

Program Text (g01erfe.f90)

10.2  Program Data

Program Data (g01erfe.d)

10.3  Program Results

Program Results (g01erfe.r)

G01ERF (PDF version)
G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2015