NAG FL Interface
g01slf (prob_​hypergeom_​vector)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

g01slf returns a number of the lower tail, upper tail and point probabilities for the hypergeometric distribution.

2 Specification

Fortran Interface
Subroutine g01slf ( ln, n, ll, l, lm, m, lk, k, plek, pgtk, peqk, ivalid, ifail)
Integer, Intent (In) :: ln, n(ln), ll, l(ll), lm, m(lm), lk, k(lk)
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: ivalid(*)
Real (Kind=nag_wp), Intent (Out) :: plek(*), pgtk(*), peqk(*)
C Header Interface
#include <nag.h>
void  g01slf_ (const Integer *ln, const Integer n[], const Integer *ll, const Integer l[], const Integer *lm, const Integer m[], const Integer *lk, const Integer k[], double plek[], double pgtk[], double peqk[], Integer ivalid[], Integer *ifail)
The routine may be called by the names g01slf or nagf_stat_prob_hypergeom_vector.

3 Description

Let X = {Xi: i=1 , 2 ,, r } denote a vector of random variables having a hypergeometric distribution with parameters ni, li and mi. Then
Prob{Xi=ki} = ( mi ki ) ( ni - mi li - ki ) ( ni li ) ,  
where max(0, li + mi - ni ) ki min(li,mi) , 0lini and 0mini.
The hypergeometric distribution may arise if in a population of size ni a number mi are marked. From this population a sample of size li is drawn and of these ki are observed to be marked.
The mean of the distribution = limi ni , and the variance = limi(ni-li)(ni-mi) ni2(ni-1) .
g01slf computes for given ni, li, mi and ki the probabilities: Prob{Xiki}, Prob{Xi>ki} and Prob{Xi=ki} using an algorithm similar to that described in Knüsel (1986) for the Poisson distribution.
The input arrays to this routine are designed to allow maximum flexibility in the supply of vector arguments by re-using elements of any arrays that are shorter than the total number of evaluations required. See Section 2.6 in the G01 Chapter Introduction for further information.

4 References

Knüsel L (1986) Computation of the chi-square and Poisson distribution SIAM J. Sci. Statist. Comput. 7 1022–1036

5 Arguments

1: ln Integer Input
On entry: the length of the array n.
Constraint: ln>0.
2: n(ln) Integer array Input
On entry: ni, the parameter of the hypergeometric distribution with ni=n(j), j=((i-1) mod ln)+1, for i=1,2,,max(ln,ll,lm,lk).
Constraint: n(j)0, for j=1,2,,ln.
3: ll Integer Input
On entry: the length of the array l.
Constraint: ll>0.
4: l(ll) Integer array Input
On entry: li, the parameter of the hypergeometric distribution with li=l(j), j=((i-1) mod ll)+1.
Constraint: 0 li ni .
5: lm Integer Input
On entry: the length of the array m.
Constraint: lm>0.
6: m(lm) Integer array Input
On entry: mi, the parameter of the hypergeometric distribution with mi=m(j), j=((i-1) mod lm)+1.
Constraint: 0 mi ni .
7: lk Integer Input
On entry: the length of the array k.
Constraint: lk>0.
8: k(lk) Integer array Input
On entry: ki, the integer which defines the required probabilities with ki=k(j), j=((i-1) mod lk)+1.
Constraint: max(0, li + mi - ni ) ki min(li,mi) .
9: plek(*) Real (Kind=nag_wp) array Output
Note: the dimension of the array plek must be at least max(ln,ll,lm,lk).
On exit: Prob{Xiki} , the lower tail probabilities.
10: pgtk(*) Real (Kind=nag_wp) array Output
Note: the dimension of the array pgtk must be at least max(ln,ll,lm,lk).
On exit: Prob{Xi>ki} , the upper tail probabilities.
11: peqk(*) Real (Kind=nag_wp) array Output
Note: the dimension of the array peqk must be at least max(ln,ll,lm,lk).
On exit: Prob{Xi=ki} , the point probabilities.
12: ivalid(*) Integer array Output
Note: the dimension of the array ivalid must be at least max(ln,ll,lm,lk).
On exit: ivalid(i) indicates any errors with the input arguments, with
ivalid(i)=0
No error.
ivalid(i)=1
On entry, ni<0.
ivalid(i)=2
On entry, li<0, or, li>ni.
ivalid(i)=3
On entry, mi<0, or, mi>ni.
ivalid(i)=4
On entry, ki<0, or, ki>li, or, ki>mi, or, ki<li+mi-ni.
ivalid(i)=5
On entry, ni is too large to be represented exactly as a real number.
ivalid(i)=6
On entry, the variance (see Section 3) exceeds 106.
13: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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:
ifail=1
On entry, at least one value of n, l, m or k was invalid, or the variance was too large.
Check ivalid for more information.
ifail=2
On entry, array size=value.
Constraint: ln>0.
ifail=3
On entry, array size=value.
Constraint: ll>0.
ifail=4
On entry, array size=value.
Constraint: lm>0.
ifail=5
On entry, array size=value.
Constraint: lk>0.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Results are correct to a relative accuracy of at least 10−6 on machines with a precision of 9 or more decimal digits (provided that the results do not underflow to zero).

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
g01slf is not threaded in any implementation.

9 Further Comments

The time taken by g01slf to calculate each probability depends on the variance (see Section 3) and on ki. For given variance, the time is greatest when kilimi/ni (= the mean), and is then approximately proportional to the square-root of the variance.

10 Example

This example reads a vector of values for n, l, m and k, and prints the corresponding probabilities.

10.1 Program Text

Program Text (g01slfe.f90)

10.2 Program Data

Program Data (g01slfe.d)

10.3 Program Results

Program Results (g01slfe.r)