NAG Library Routine Document

g03gaf (gaussian_mixture)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the number of objects. There must be more objects than parameters in the model.

Constraints:

• if $\mathbf{sopt}=1$, $\mathbf{n}>\mathbf{ng}\times \left(\mathbf{nvar}\times \mathbf{nvar}+\mathbf{nvar}\right)$;
• if $\mathbf{sopt}=2$, $\mathbf{n}>\mathbf{nvar}\times \left(\mathbf{ng}+\mathbf{nvar}\right)$;
• if $\mathbf{sopt}=3$, $\mathbf{n}>2\times \mathbf{ng}\times \mathbf{nvar}$;
• if $\mathbf{sopt}=4$, $\mathbf{n}>\mathbf{nvar}\times \left(\mathbf{ng}+1\right)$;
• if $\mathbf{sopt}=5$, $\mathbf{n}>\mathbf{nvar}\times \mathbf{ng}+1$.

2:     $\mathbf{m}$ – IntegerInput

On entry: the total number of variables in array x.

Constraint: $\mathbf{m}\ge 1$.

3:     $\mathbf{x}\left(\mathbf{ldx},\mathbf{m}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{x}\left(\mathit{i},\mathit{j}\right)$ must contain the value of the $\mathit{j}$th variable for the $\mathit{i}$th object, for $\mathit{i}=1,2,\dots ,n$ and $\mathit{j}=1,2,\dots ,\mathbf{m}$.

4:     $\mathbf{ldx}$ – IntegerInput

On entry: the first dimension of the array x as declared in the (sub)program from which g03gaf is called.

Constraint: $\mathbf{ldx}\ge \mathbf{n}$.

5:     $\mathbf{isx}\left(\mathbf{m}\right)$ – Integer arrayInput

On entry: if $\mathbf{nvar}=\mathbf{m}$ all available variables are included in the model and isx is not referenced; otherwise the $j$th variable will be included in the analysis if $\mathbf{isx}\left(\mathit{j}\right)=1$ and excluded if $\mathbf{isx}\left(\mathit{j}\right)=0$, for $\mathit{j}=1,2,\dots ,\mathbf{m}$.

Constraint: if $\mathbf{nvar}\ne \mathbf{m}$, $\mathbf{isx}\left(\mathit{j}\right)=1$ for nvar values of $\mathit{j}$ and $\mathbf{isx}\left(\mathit{j}\right)=0$ for the remaining $\mathbf{m}-\mathbf{nvar}$ values of $\mathit{j}$, for $\mathit{j}=1,2,\dots ,\mathbf{m}$.

6:     $\mathbf{nvar}$ – IntegerInput

On entry: $p$, the number of variables included in the calculations.

Constraint: $1\le \mathbf{nvar}\le \mathbf{m}$.

7:     $\mathbf{ng}$ – IntegerInput

On entry: $k$, the number of groups in the mixture model.

Constraint: $\mathbf{ng}\ge 1$.

8:     $\mathbf{popt}$ – IntegerInput

On entry: if $\mathbf{popt}=1$, the initial membership probabilities in prob are set internally; otherwise these probabilities must be supplied.

9:     $\mathbf{prob}\left(\mathbf{lprob},\mathbf{ng}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if $\mathbf{popt}\ne 1$, $\mathbf{prob}\left(i,j\right)$ is the probability that the $i$th object belongs to the $j$th group. (These probabilities are normalised internally.)

On exit: $\mathbf{prob}\left(i,j\right)$ is the probability of membership of the $i$th object to the $j$th group for the fitted model.

10:   $\mathbf{lprob}$ – IntegerInput

On entry: the first dimension of the array prob as declared in the (sub)program from which g03gaf is called.

Constraint: $\mathbf{lprob}\ge \mathbf{n}$.

11:   $\mathbf{niter}$ – IntegerInput/Output

On entry: the maximum number of iterations.

Suggested value: $15$

On exit: the number of completed iterations.

Constraint: $\mathbf{niter}\ge 1$.

12:   $\mathbf{riter}$ – IntegerInput

On entry: if $\mathbf{riter}>0$, membership probabilities are rounded to $0.0$ or $1.0$ after the completion of every riter iterations.

Suggested value: $5$

13:   $\mathbf{w}\left(\mathbf{ng}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $w_j$, the mixing probability for the $j$th group.

14:   $\mathbf{g}\left(\mathbf{nvar},\mathbf{ng}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{g}\left(i,j\right)$ gives the estimated mean of the $i$th variable in the $j$th group.

15:   $\mathbf{sopt}$ – IntegerInput

On entry: determines the (co)variance structure:

$\mathbf{sopt}=1$

Groupwise covariance matrices.

$\mathbf{sopt}=2$

Pooled covariance matrix.

$\mathbf{sopt}=3$

Groupwise variances.

$\mathbf{sopt}=4$

Pooled variances.

$\mathbf{sopt}=5$

Overall variance.

Constraint: $\mathbf{sopt}=1$, $2$, $3$, $4$ or $5$.

16:   $\mathbf{s}\left(\mathbf{lds},\mathbf{sds},*\right)$ – Real (Kind=nag_wp) arrayOutput

Note: the last dimension of the array s must be at least $\mathbf{ng}$ if $\mathbf{sopt}=1$, and at least $1$ otherwise.

On exit: if $\mathbf{sopt}=1$, $\mathbf{s}\left(i,j,k\right)$ gives the $\left(i,j\right)$th element of the $k$th group.

If $\mathbf{sopt}=2$, $\mathbf{s}\left(i,j,1\right)$ gives the $\left(i,j\right)$th element of the pooled covariance.

If $\mathbf{sopt}=3$, $\mathbf{s}\left(j,k,1\right)$ gives the $j$th variance in the $k$th group.

If $\mathbf{sopt}=4$, $\mathbf{s}\left(j,1,1\right)$ gives the $j$th pooled variance.

If $\mathbf{sopt}=5$, $\mathbf{s}\left(1,1,1\right)$ gives the overall variance.

17:   $\mathbf{lds}$ – IntegerInput

On entry: the first dimension of the (co)variance structure s.

Constraints:

• if $\mathbf{sopt}=5$, $\mathbf{lds}=1$;
• otherwise $\mathbf{lds}=\mathbf{nvar}$.

18:   $\mathbf{sds}$ – IntegerInput

On entry: the second dimension of the (co)variance structure s.

Constraints:

• if $\mathbf{sopt}=1$ or $2$, $\mathbf{sds}\ge \mathbf{nvar}$;
• if $\mathbf{sopt}=3$, $\mathbf{sds}\ge \mathbf{ng}$;
• if $\mathbf{sopt}=4$ or $5$, $\mathbf{sds}\ge 1$.

19:   $\mathbf{f}\left(\mathbf{n},\mathbf{ng}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{f}\left(i,j\right)$ gives the $p$-variate Normal (Gaussian) density of the $i$th object in the $j$th group.

20:   $\mathbf{tol}$ – Real (Kind=nag_wp)Input

On entry: iterations cease the first time an improvement in log-likelihood is less than tol. If $\mathbf{tol}\le 0$ a value of ${10}^{-3}$ is used.

21:   $\mathbf{loglik}$ – Real (Kind=nag_wp)Output

On exit: the log-likelihood for the fitted mixture model.

22:   $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ 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\text{ 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 argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of ifail on exit.

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

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$ and $p=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}>p$, the number of parameters, i.e., too few objects have been supplied for the model.

$\mathbf{ifail}=2$

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}\ge 1$.

$\mathbf{ifail}=4$

On entry, $\mathbf{ldx}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldx}\ge \mathbf{n}$.

$\mathbf{ifail}=5$

On entry, $\mathbf{nvar}=〈\mathit{\text{value}}〉$ and $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: $1\le \mathbf{nvar}\le \mathbf{m}$.

$\mathbf{ifail}=6$

On entry, $\mathbf{nvar}\ne \mathbf{m}$ and isx is invalid.

$\mathbf{ifail}=7$

On entry, $\mathbf{ng}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ng}\ge 1$.

$\mathbf{ifail}=8$

On entry, $\mathbf{popt}\ne 1$ or $2$.

$\mathbf{ifail}=9$

On entry, row $〈\mathit{\text{value}}〉$ of supplied prob does not sum to $1$.

$\mathbf{ifail}=10$

On entry, $\mathbf{lprob}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lprob}\ge \mathbf{n}$.

$\mathbf{ifail}=11$

On entry, $\mathbf{niter}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{niter}\ge 1$.

$\mathbf{ifail}=16$

On entry, $\mathbf{sopt}\ne 1$, $2$, $3$, $4$ or $5$.

$\mathbf{ifail}=18$

On entry, $\mathbf{lds}=〈\mathit{\text{value}}〉$ was invalid.

$\mathbf{ifail}=19$

On entry, $\mathbf{sds}=〈\mathit{\text{value}}〉$ was invalid.

$\mathbf{ifail}=44$

A covariance matrix is not positive definite, try a different initial allocation.

$\mathbf{ifail}=45$

An iteration cannot continue due to an empty group, try a different initial allocation.

$\mathbf{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.

$\mathbf{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.

$\mathbf{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

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (g03gafe.f90)

10.2

Program Data

Program Data (g03gafe.d)

10.3

Program Results

Program Results (g03gafe.r)