nag_prob_hypergeom_vector (g01slc) (PDF version)
g01 Chapter Contents
g01 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_prob_hypergeom_vector (g01slc)

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_prob_hypergeom_vector (g01slc) returns a number of the lower tail, upper tail and point probabilities for the hypergeometric distribution.

2  Specification

#include <nag.h>
#include <nagg01.h>
void  nag_prob_hypergeom_vector (Integer ln, const Integer n[], Integer ll, const Integer l[], Integer lm, const Integer m[], Integer lk, const Integer k[], double plek[], double pgtk[], double peqk[], Integer ivalid[], NagError *fail)

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 max0, li + mi - ni ki minli,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 = limini-lini-mi ni2ni-1 .
nag_prob_hypergeom_vector (g01slc) computes for given ni, li, mi and ki the probabilities: ProbXiki, ProbXi>ki and ProbXi=ki using an algorithm similar to that described in Knüsel (1986) for the Poisson distribution.
The input arrays to this function 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:     lnIntegerInput
On entry: the length of the array n
Constraint: ln>0.
2:     n[ln]const IntegerInput
On entry: ni, the parameter of the hypergeometric distribution with ni=n[j], j=i-1 mod ln, for i=1,2,,maxln,ll,lm,lk.
Constraint: n[j-1]0, for j=1,2,,ln.
3:     llIntegerInput
On entry: the length of the array l
Constraint: ll>0.
4:     l[ll]const IntegerInput
On entry: li, the parameter of the hypergeometric distribution with li=l[j], j=i-1 mod ll.
Constraint: 0 li ni .
5:     lmIntegerInput
On entry: the length of the array m
Constraint: lm>0.
6:     m[lm]const IntegerInput
On entry: mi, the parameter of the hypergeometric distribution with mi=m[j], j=i-1 mod lm.
Constraint: 0 mi ni .
7:     lkIntegerInput
On entry: the length of the array k
Constraint: lk>0.
8:     k[lk]const IntegerInput
On entry: ki, the integer which defines the required probabilities with ki=k[j], j=i-1 mod lk.
Constraint: max0, li + mi - ni ki minli,mi .
9:     plek[dim]doubleOutput
Note: the dimension, dim, of the array plek must be at least maxln,ll,lm,lk.
On exit: Prob Xi ki , the lower tail probabilities.
10:   pgtk[dim]doubleOutput
Note: the dimension, dim, of the array pgtk must be at least maxln,ll,lm,lk.
On exit: Prob Xi > ki , the upper tail probabilities.
11:   peqk[dim]doubleOutput
Note: the dimension, dim, of the array peqk must be at least maxln,ll,lm,lk.
On exit: Prob Xi = ki , the point probabilities.
12:   ivalid[dim]IntegerOutput
Note: the dimension, dim, of the array ivalid must be at least maxln,ll,lm,lk.
On exit: ivalid[i-1] indicates any errors with the input arguments, with
ivalid[i-1]=0
No error.
ivalid[i-1]=1
On entry,ni<0.
ivalid[i-1]=2
On entry,li<0,
orli>ni.
ivalid[i-1]=3
On entry,mi<0,
ormi>ni.
ivalid[i-1]=4
On entry,ki<0,
orki>li,
orki>mi,
orki<li+mi-ni.
ivalid[i-1]=5
On entry,ni is too large to be represented exactly as a real number.
ivalid[i-1]=6
On entry,the variance (see Section 3) exceeds 106.
13:   failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
NE_ARRAY_SIZE
On entry, array size=value.
Constraint: lk>0.
On entry, array size=value.
Constraint: ll>0.
On entry, array size=value.
Constraint: lm>0.
On entry, array size=value.
Constraint: ln>0.
NE_BAD_PARAM
On entry, argument value had an illegal value.
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.
NW_IVALID
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.

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  Further Comments

The time taken by nag_prob_hypergeom_vector (g01slc) 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.

9  Example

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

9.1  Program Text

Program Text (g01slce.c)

9.2  Program Data

Program Data (g01slce.d)

9.3  Program Results

Program Results (g01slce.r)


nag_prob_hypergeom_vector (g01slc) (PDF version)
g01 Chapter Contents
g01 Chapter Introduction
NAG C Library Manual

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