NAG CL Interface
g01lbc (pdf_​multi_​normal_​vector)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{ilog}$ – Nag_Boolean Input

On entry: the value of ilog determines whether the logarithmic value is returned in PDF.

$\mathbf{ilog}=\mathrm{Nag\_FALSE}$

$f(X:\mu ,\Sigma )$, the probability density function is returned.

$\mathbf{ilog}=\mathrm{Nag\_TRUE}$

$\log \left(f(X:\mu ,\Sigma )\right)$, the logarithm of the probability density function is returned.

2: $\mathbf{k}$ – Integer Input

On entry: $k$, the number of points the PDF is to be evaluated at.

Constraint: $\mathbf{k}\ge 0$.

3: $\mathbf{n}$ – Integer Input

On entry: $n$, the number of dimensions.

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

4: $\mathbf{x}\left[\mathit{dim}\right]$ – const double Input

Note: the dimension, dim, of the array x must be at least $\mathbf{pdx}\times \mathbf{k}$.

where $\mathbf{X}(i,j)$ appears in this document, it refers to the array element $\mathbf{x}\left[(j-1)\times \mathbf{pdx}+i-1\right]$.

On entry: $X$, the matrix of $k$ points at which to evaluate the probability density function, with the $i$th dimension for the $j$th point held in $\mathbf{X}(i,j)$.

5: $\mathbf{pdx}$ – Integer Input

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

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

6: $\mathbf{xmu}\left[\mathbf{n}\right]$ – const double Input

On entry: $\mu$, the mean vector of the multivariate Normal distribution.

7: $\mathbf{iuld}$ – Nag_MatrixType Input

On entry: indicates the form of $\Sigma$ and how it is stored in sig.

$\mathbf{iuld}=\mathrm{Nag\_LowerMatrix}$

sig holds the lower triangular portion of $\Sigma$.

$\mathbf{iuld}=\mathrm{Nag\_UpperMatrix}$

sig holds the upper triangular portion of $\Sigma$.

$\mathbf{iuld}=\mathrm{Nag\_DiagonalMatrix}$

$\Sigma$ is a diagonal matrix and sig only holds the diagonal elements.

$\mathbf{iuld}=\mathrm{Nag\_LowerFactored}$

sig holds the lower Cholesky decomposition, $L$ such that $L{L}^{\mathrm{T}}=\Sigma$.

$\mathbf{iuld}=\mathrm{Nag\_UpperFactored}$

sig holds the upper Cholesky decomposition, $U$ such that $U^{\mathrm{T}}U=\Sigma$.

Constraint: $\mathbf{iuld}=\mathrm{Nag\_LowerMatrix}$, $\mathrm{Nag\_UpperMatrix}$, $\mathrm{Nag\_DiagonalMatrix}$, $\mathrm{Nag\_LowerFactored}$ or $\mathrm{Nag\_UpperFactored}$.

8: $\mathbf{sig}\left[\mathit{dim}\right]$ – const double Input

Note: the dimension, dim, of the array sig must be at least $\mathbf{pdsig}\times \mathbf{n}$.

where $\mathbf{SIG}(i,j)$ appears in this document, it refers to the array element $\mathbf{sig}\left[(j-1)\times \mathbf{pdsig}+i-1\right]$.

On entry: information defining the variance-covariance matrix, $\Sigma$.

$\mathbf{iuld}=\mathrm{Nag\_LowerMatrix}$ or $\mathrm{Nag\_UpperMatrix}$

sig must hold the lower or upper portion of $\Sigma$, with ${\Sigma }_{ij}$ held in $\mathbf{SIG}(i,j)$. The supplied variance-covariance matrix must be positive semidefinite.

$\mathbf{iuld}=\mathrm{Nag\_DiagonalMatrix}$

$\Sigma$ is a diagonal matrix and the $i$th diagonal element, ${\Sigma }_{ii}$, must be held in $\mathbf{SIG}(1,i)$

$\mathbf{iuld}=\mathrm{Nag\_LowerFactored}$ or $\mathrm{Nag\_UpperFactored}$

sig must hold $L$ or $U$, the lower or upper Cholesky decomposition of $\Sigma$, with $L_{ij}$ or $U_{ij}$ held in $\mathbf{SIG}(i,j)$, depending on the value of iuld. No check is made that $L{L}^{\mathrm{T}}$ or $U^{\mathrm{T}}U$ is a valid variance-covariance matrix. The diagonal elements of the supplied $L$ or $U$ must be greater than zero

9: $\mathbf{pdsig}$ – Integer Input

On entry: the stride separating matrix row elements in the array sig.

Constraints:

• if $\mathbf{iuld}=\mathrm{Nag\_DiagonalMatrix}$, $\mathbf{pdsig}\ge 1$;
• otherwise $\mathbf{pdsig}\ge \mathbf{n}$.

10: $\mathbf{pdf}\left[\mathbf{k}\right]$ – double Output

On exit: $f(X:\mu ,\Sigma )$ or $\log \left(f(X:\mu ,\Sigma )\right)$ depending on the value of ilog.

11: $\mathbf{rank}$ – Integer * Output

On exit: $r$, rank of $\Sigma$.

12: $\mathbf{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, $\mathbf{pdsig}=⟨\mathit{\text{value}}⟩$.
Constraint: if $\mathbf{iuld}=\mathrm{Nag\_DiagonalMatrix}$, $\mathbf{pdsig}\ge 1$.

On entry, $\mathbf{pdsig}=⟨\mathit{\text{value}}⟩$.
Constraint: if $\mathbf{iuld}\ne \mathrm{Nag\_DiagonalMatrix}$, $\mathbf{pdsig}\ge \mathbf{n}$.

On entry, $\mathbf{pdx}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdx}\ge \mathbf{n}$.

NE_BAD_PARAM

On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_DIAG_ELEMENTS

On entry, at least one diagonal element of $\Sigma$ is less than or equal to $0$.

NE_INT

On entry, $\mathbf{k}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{k}\ge 0$.

On entry, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{n}\ge 2$.

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

On entry, $\Sigma$ is not positive definite and eigenvalue decomposition failed.

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_NOT_POS_SEM_DEF

On entry, $\Sigma$ is not positive semidefinite.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results