g03gbc (Integer n, Integer m, const double x[], Integer pdx, const Integer isx[], Integer nvar, Integer ng, Nag_Boolean popt, double prob[], Integer tdprob, Integer *niter, Integer riter, double w[], double g[], Integer pdg, Nag_VarCovar sopt, double s[], Integer pds, Integer tds, double f[], Integer pdf, double tol, double *loglik, NagError *fail)

The function may be called by the names: g03gbc or nag_mv_gaussian_mixture_ld.

3 Description

g03gbc is identical to g03gac except for the addition of array dimension arguments that allow submatrices to be passed as actual arguments for outputs f and g.

A Normal (Gaussian) mixture model is a weighted sum of

k

group Normal densities given by,

p (x ∣ w, μ, Σ) = \sum_{j = 1}^{k} w_{j} g (x ∣ μ_{j}, Σ_{j}), x \in ℝ^{p}

where:

$x$ is a $p$ -dimensional object of interest;
$w_{j}$ is the mixture weight for the $j$ th group and $\sum_{j = 1}^{k} w_{j} = 1$ ;
$μ_{j}$ is a $p$ -dimensional vector of means for the $j$ th group;
$Σ_{j}$ is the covariance structure for the $j$ th group;
$g (\cdot)$ is the $p$ -variate Normal density:

$g (x ∣ μ_{j}, Σ_{j}) = \frac{1}{{(2 π)}^{p / 2} {| Σ_{j} |}^{1 / 2}} \exp [- \frac{1}{2} (x - μ_{j}) Σ_{j}^{−1} {(x - μ_{j})}^{T}] .$

Optionally, the (co)variance structure may be pooled (common to all groups) or calculated for each group, and may be full or diagonal.

4 References

Hartigan J A (1975) Clustering Algorithms Wiley

5 Arguments

1: $n$ – Integer Input

On entry:

n

, the number of objects. There must be more objects than parameters in the model.

Constraints:

if $sopt = Nag_GroupCovar$ , $n > ng \times (nvar \times nvar + nvar)$ ;
if $sopt = Nag_PooledCovar$ , $n > nvar \times (ng + nvar)$ ;
if $sopt = Nag_GroupVar$ , $n > 2 \times ng \times nvar$ ;
if $sopt = Nag_PooledVar$ , $n > nvar \times (ng + 1)$ ;
if $sopt = Nag_OverallVar$ , $n > nvar \times ng + 1$ .

2: $m$ – Integer Input

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

Constraint:

m \geq 1

3: $x [\dim]$ – const double Input

Note: the dimension, dim, of the array x must be at least

n \times pdx

On entry:

x [(i - 1) \times pdx + j - 1]

must contain the value of the

j

th variable for the

i

th object, for

i = 1, 2, \dots, n

and

j = 1, 2, \dots, m

4: $pdx$ – Integer Input

On entry: the stride separating matrix column elements in the array x.

Constraint:

pdx \geq m

5: $isx [m]$ – const Integer Input

On entry: if

nvar = 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

isx [j - 1] = 1

and excluded if

isx [j - 1] = 0

, for

j = 1, 2, \dots, m

Constraint: if

nvar \neq m

isx [j - 1] = 1

for nvar values of

j

and

isx [j - 1] = 0

for the remaining

m - nvar

values of

j

, for

j = 1, 2, \dots, m

6: $nvar$ – Integer Input

On entry:

p

, the number of variables included in the calculations.

Constraint:

1 \leq nvar \leq m

7: $ng$ – Integer Input

On entry:

k

, the number of groups in the mixture model.

Constraint:

ng \geq 1

8: $popt$ – Nag_Boolean Input

On entry: if

popt = Nag_TRUE

, the initial membership probabilities in prob are set internally; otherwise these probabilities must be supplied.

9: $prob [\dim]$ – double Input/Output

Note: the dimension, dim, of the array prob must be at least

n \times tdprob

On entry: if

popt \neq Nag_TRUE

prob [(i - 1) \times tdprob + j - 1]

is the probability that the

i

th object belongs to the

j

th group. (These probabilities are normalised internally.)

On exit:

prob [(i - 1) \times tdprob + j - 1]

is the probability of membership of the

i

th object to the

j

th group for the fitted model.

10: $tdprob$ – Integer Input

On entry: the stride separating matrix column elements in the array prob.

Constraint:

tdprob \geq ng

11: $niter$ – Integer * Input/Output

On entry: the maximum number of iterations.

Suggested value:

15

On exit: the number of completed iterations.

Constraint:

niter \geq 1

12: $riter$ – Integer Input

On entry: if

riter > 0

, membership probabilities are rounded to

0.0

1.0

after the completion of the first riter iterations.

Suggested value:

0

13: $w [ng]$ – double Output

On exit:

w_{j}

, the mixing probability for the

j

th group.

14: $g [\dim]$ – double Output

Note: the dimension, dim, of the array g must be at least

nvar \times pdg

On exit:

g [(i - 1) \times pdg + j - 1]

gives the estimated mean of the

i

th variable in the

j

th group.

15: $pdg$ – Integer Input

On entry: the stride separating matrix column elements in the array g.

Constraint:

pdg \geq ng

16: $sopt$ – Nag_VarCovar Input

On entry: determines the (co)variance structure:

$sopt = Nag_GroupCovar$: Groupwise covariance matrices.
$sopt = Nag_PooledCovar$: Pooled covariance matrix.
$sopt = Nag_GroupVar$: Groupwise variances.
$sopt = Nag_PooledVar$: Pooled variances.
$sopt = Nag_OverallVar$: Overall variance.

Constraint:

sopt = Nag_GroupCovar

Nag_PooledCovar

Nag_GroupVar

Nag_PooledVar

Nag_OverallVar

17: $s [\dim]$ – double Output

Note: the dimension, dim, of the array s must be at least

pds \times tds \times c

where

S (i, j, k)

appears in this document, it refers to the array element

s [(k - 1) \times pds \times tds + (j - 1) \times pds + i - 1]

On exit: if

sopt = Nag_GroupCovar

S (i, j, k)

gives the

(i, j)

th element of the

k

th group.

sopt = Nag_PooledCovar

S (i, j, 1)

gives the

(i, j)

th element of the pooled covariance.

sopt = Nag_GroupVar

S (j, k, 1)

gives the

j

th variance in the

k

th group.

sopt = Nag_PooledVar

S (j, 1, 1)

gives the

j

th pooled variance.

sopt = Nag_OverallVar

S (1, 1, 1)

gives the overall variance.

18: $pds$ – Integer Input

On entry: the first dimension of the matrix S as stored in the array s.

Constraints:

if $sopt = Nag_OverallVar$ , $pds \geq 1$ ;
otherwise $pds \geq nvar$ .

19: $tds$ – Integer Input

On entry: the second dimension of the matrix S as stored in the array s.

Constraints:

if $sopt = Nag_GroupCovar$ or $Nag_PooledCovar$ , $tds \geq nvar$ ;
if $sopt = Nag_GroupVar$ , $tds \geq ng$ ;
if $sopt = Nag_PooledVar$ or $Nag_OverallVar$ , $tds \geq 1$ .

20: $f [\dim]$ – double Output

Note: the dimension, dim, of the array f must be at least

n \times pdf

On exit:

f [(i - 1) \times pdf + j - 1]

gives the

p

-variate Normal (Gaussian) density of the

i

th object in the

j

th group.

21: $pdf$ – Integer Input

On entry: the stride separating matrix column elements in the array f.

Constraint:

pdf \geq ng

22: $tol$ – double Input

On entry: iterations cease the first time an improvement in log-likelihood is less than tol. If

tol \leq 0

a value of

10^{−3}

is used.

23: $loglik$ – double * Output

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

24: $fail$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error 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, $pdf = ⟨ value ⟩$ and $ng = ⟨ value ⟩$ .
Constraint: $pdf \geq ng$ .

On entry, $pdg = ⟨ value ⟩$ and $ng = ⟨ value ⟩$ .
Constraint: $pdg \geq ng$ .

On entry, $pds = ⟨ value ⟩$ was invalid.

On entry, $pdx = ⟨ value ⟩$ and $m = ⟨ value ⟩$ .
Constraint: $pdx \geq m$ .

On entry, $tdprob = ⟨ value ⟩$ and $n = ⟨ value ⟩$ .
Constraint: $tdprob \geq ng$ .

On entry, $tds = ⟨ value ⟩$ was invalid.
NE_BAD_PARAM: On entry, argument $⟨ value ⟩$ had an illegal value.
NE_CLUSTER_EMPTY: An iteration cannot continue due to an empty group, try a different initial allocation.
NE_INT: On entry, $m = ⟨ value ⟩$ .
Constraint: $m \geq 1$ .

On entry, $ng = ⟨ value ⟩$ .
Constraint: $ng \geq 1$ .

On entry, $niter = ⟨ value ⟩$ .
Constraint: $niter \geq 1$ .
NE_INT_2: On entry, $nvar = ⟨ value ⟩$ and $m = ⟨ value ⟩$ .
Constraint: $1 \leq nvar \leq m$ .
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_MAT_NOT_POS_DEF: A covariance matrix is not positive definite, try a different initial allocation.
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.
NE_OBSERVATIONS: On entry, $n = ⟨ value ⟩$ and $p = ⟨ value ⟩$ .
Constraint: $n > p$ , the number of parameters, i.e., too few objects have been supplied for the model.
NE_PROBABILITY: On entry, row $⟨ value ⟩$ of supplied prob does not sum to $1$ .
NE_VAR_INCL_INDICATED: On entry, $nvar \neq m$ and isx is invalid.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

g03gbc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

g03gbc makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

None.

10 Example

This example fits a Gaussian mixture model with pooled covariance structure to New Haven schools test data, see Table 5.1 (p. 118) in Hartigan (1975).

g03gb: FL CL CPP AD PY MB

NAG CL Interfaceg03gbc (gaussian_​mixture_​ld)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG CL Interface
g03gbc (gaussian_mixture_ld)