# NAG CL Interfaceg01slc (prob_​hypergeom_​vector)

## 1Purpose

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

## 2Specification

 #include
 void g01slc (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)
The function may be called by the names: g01slc, nag_stat_prob_hypergeom_vector or nag_prob_hypergeom_vector.

## 3Description

Let $X=\left\{{X}_{i}:i=1,2,\dots ,r\right\}$ denote a vector of random variables having a hypergeometric distribution with parameters ${n}_{i}$, ${l}_{i}$ and ${m}_{i}$. Then
 $Prob Xi = ki = mi ki ni - mi li - ki ni li ,$
where $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(0,{l}_{i}+{m}_{i}-{n}_{i}\right)\le {k}_{i}\le \mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({l}_{i},{m}_{i}\right)$, $0\le {l}_{i}\le {n}_{i}$ and $0\le {m}_{i}\le {n}_{i}$.
The hypergeometric distribution may arise if in a population of size ${n}_{i}$ a number ${m}_{i}$ are marked. From this population a sample of size ${l}_{i}$ is drawn and of these ${k}_{i}$ are observed to be marked.
The mean of the distribution $\text{}=\frac{{l}_{i}{m}_{i}}{{n}_{i}}$, and the variance $\text{}=\frac{{l}_{i}{m}_{i}\left({n}_{i}-{l}_{i}\right)\left({n}_{i}-{m}_{i}\right)}{{{n}_{i}}^{2}\left({n}_{i}-1\right)}$.
g01slc computes for given ${n}_{i}$, ${l}_{i}$, ${m}_{i}$ and ${k}_{i}$ the probabilities: $\mathrm{Prob}\left\{{X}_{i}\le {k}_{i}\right\}$, $\mathrm{Prob}\left\{{X}_{i}>{k}_{i}\right\}$ and $\mathrm{Prob}\left\{{X}_{i}={k}_{i}\right\}$ 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.
Knüsel L (1986) Computation of the chi-square and Poisson distribution SIAM J. Sci. Statist. Comput. 7 1022–1036

## 5Arguments

1: $\mathbf{ln}$Integer Input
On entry: the length of the array n.
Constraint: ${\mathbf{ln}}>0$.
2: $\mathbf{n}\left[{\mathbf{ln}}\right]$const Integer Input
On entry: ${n}_{i}$, the parameter of the hypergeometric distribution with ${n}_{i}={\mathbf{n}}\left[j\right]$, , for $i=1,2,\dots ,\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{ln}},{\mathbf{ll}},{\mathbf{lm}},{\mathbf{lk}}\right)$.
Constraint: ${\mathbf{n}}\left[\mathit{j}-1\right]\ge 0$, for $\mathit{j}=1,2,\dots ,{\mathbf{ln}}$.
3: $\mathbf{ll}$Integer Input
On entry: the length of the array l.
Constraint: ${\mathbf{ll}}>0$.
4: $\mathbf{l}\left[{\mathbf{ll}}\right]$const Integer Input
On entry: ${l}_{i}$, the parameter of the hypergeometric distribution with ${l}_{i}={\mathbf{l}}\left[j\right]$, .
Constraint: $0\le {l}_{i}\le {n}_{i}$.
5: $\mathbf{lm}$Integer Input
On entry: the length of the array m.
Constraint: ${\mathbf{lm}}>0$.
6: $\mathbf{m}\left[{\mathbf{lm}}\right]$const Integer Input
On entry: ${m}_{i}$, the parameter of the hypergeometric distribution with ${m}_{i}={\mathbf{m}}\left[j\right]$, .
Constraint: $0\le {m}_{i}\le {n}_{i}$.
7: $\mathbf{lk}$Integer Input
On entry: the length of the array k.
Constraint: ${\mathbf{lk}}>0$.
8: $\mathbf{k}\left[{\mathbf{lk}}\right]$const Integer Input
On entry: ${k}_{i}$, the integer which defines the required probabilities with ${k}_{i}={\mathbf{k}}\left[j\right]$, .
Constraint: $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(0,{l}_{i}+{m}_{i}-{n}_{i}\right)\le {k}_{i}\le \mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({l}_{i},{m}_{i}\right)$.
9: $\mathbf{plek}\left[\mathit{dim}\right]$double Output
Note: the dimension, dim, of the array plek must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{ln}},{\mathbf{ll}},{\mathbf{lm}},{\mathbf{lk}}\right)$.
On exit: $\mathrm{Prob}\left\{{X}_{i}\le {k}_{i}\right\}$, the lower tail probabilities.
10: $\mathbf{pgtk}\left[\mathit{dim}\right]$double Output
Note: the dimension, dim, of the array pgtk must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{ln}},{\mathbf{ll}},{\mathbf{lm}},{\mathbf{lk}}\right)$.
On exit: $\mathrm{Prob}\left\{{X}_{i}>{k}_{i}\right\}$, the upper tail probabilities.
11: $\mathbf{peqk}\left[\mathit{dim}\right]$double Output
Note: the dimension, dim, of the array peqk must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{ln}},{\mathbf{ll}},{\mathbf{lm}},{\mathbf{lk}}\right)$.
On exit: $\mathrm{Prob}\left\{{X}_{i}={k}_{i}\right\}$, the point probabilities.
12: $\mathbf{ivalid}\left[\mathit{dim}\right]$Integer Output
Note: the dimension, dim, of the array ivalid must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{ln}},{\mathbf{ll}},{\mathbf{lm}},{\mathbf{lk}}\right)$.
On exit: ${\mathbf{ivalid}}\left[i-1\right]$ indicates any errors with the input arguments, with
${\mathbf{ivalid}}\left[i-1\right]=0$
No error.
${\mathbf{ivalid}}\left[i-1\right]=1$
On entry, ${n}_{i}<0$.
${\mathbf{ivalid}}\left[i-1\right]=2$
On entry, ${l}_{i}<0$, or, ${l}_{i}>{n}_{i}$.
${\mathbf{ivalid}}\left[i-1\right]=3$
On entry, ${m}_{i}<0$, or, ${m}_{i}>{n}_{i}$.
${\mathbf{ivalid}}\left[i-1\right]=4$
On entry, ${k}_{i}<0$, or, ${k}_{i}>{l}_{i}$, or, ${k}_{i}>{m}_{i}$, or, ${k}_{i}<{l}_{i}+{m}_{i}-{n}_{i}$.
${\mathbf{ivalid}}\left[i-1\right]=5$
On entry, ${n}_{i}$ is too large to be represented exactly as a real number.
${\mathbf{ivalid}}\left[i-1\right]=6$
On entry, the variance (see Section 3) exceeds ${10}^{6}$.
13: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

## 6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_ARRAY_SIZE
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lk}}>0$.
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ll}}>0$.
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lm}}>0$.
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ln}}>0$.
On entry, argument $〈\mathit{\text{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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NW_IVALID
On entry, at least one value of n, l, m or k was invalid, or the variance was too large.

## 7Accuracy

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).

## 8Parallelism and Performance

g01slc is not threaded in any implementation.

The time taken by g01slc to calculate each probability depends on the variance (see Section 3) and on ${k}_{i}$. For given variance, the time is greatest when ${k}_{i}\approx {l}_{i}{m}_{i}/{n}_{i}$ ($=$ the mean), and is then approximately proportional to the square-root of the variance.

## 10Example

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

### 10.1Program Text

Program Text (g01slce.c)

### 10.2Program Data

Program Data (g01slce.d)

### 10.3Program Results

Program Results (g01slce.r)