NAG Library Routine Document

F04CDF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{UPLO}$ – CHARACTER(1)Input

On entry: if $\mathbf{UPLO}=\text{'U'}$, the upper triangle of the matrix $A$ is stored.

If $\mathbf{UPLO}=\text{'L'}$, the lower triangle of the matrix $A$ is stored.

Constraint: $\mathbf{UPLO}=\text{'U'}$ or $\text{'L'}$.

2:     $\mathrm{N}$ – INTEGERInput

On entry: the number of linear equations $n$, i.e., the order of the matrix $A$.

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

3:     $\mathrm{NRHS}$ – INTEGERInput

On entry: the number of right-hand sides $r$, i.e., the number of columns of the matrix $B$.

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

4:     $\mathrm{A}\left(\mathbf{LDA},*\right)$ – COMPLEX (KIND=nag_wp) arrayInput/Output

Note: the second dimension of the array A must be at least $\max \left(1,\mathbf{N}\right)$.

On entry: the $n$ by $n$ Hermitian matrix $A$.

If $\mathbf{UPLO}=\text{'U'}$, the leading N by N upper triangular part of A contains the upper triangular part of the matrix $A$, and the strictly lower triangular part of A is not referenced.

If $\mathbf{UPLO}=\text{'L'}$, the leading N by N lower triangular part of A contains the lower triangular part of the matrix $A$, and the strictly upper triangular part of A is not referenced.

On exit: if $\mathbf{IFAIL}=\mathbf{0}$ or $\mathbf{N}+\mathbf{1}$, the factor $U$ or $L$ from the Cholesky factorization $A=U^{\mathrm{H}}U$ or $A=L{L}^{\mathrm{H}}$.

5:     $\mathrm{LDA}$ – INTEGERInput

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

Constraint: $\mathbf{LDA}\ge \max \left(1,\mathbf{N}\right)$.

6:     $\mathrm{B}\left(\mathbf{LDB},*\right)$ – COMPLEX (KIND=nag_wp) arrayInput/Output

Note: the second dimension of the array B must be at least $\max \left(1,\mathbf{NRHS}\right)$.

On entry: the $n$ by $r$ matrix of right-hand sides $B$.

On exit: if $\mathbf{IFAIL}=\mathbf{0}$ or $\mathbf{N}+\mathbf{1}$, the $n$ by $r$ solution matrix $X$.

7:     $\mathrm{LDB}$ – INTEGERInput

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

Constraint: $\mathbf{LDB}\ge \max \left(1,\mathbf{N}\right)$.

8:     $\mathrm{RCOND}$ – REAL (KIND=nag_wp)Output

On exit: if $\mathbf{IFAIL}=\mathbf{0}$ or $\mathbf{N}+\mathbf{1}$, an estimate of the reciprocal of the condition number of the matrix $A$, computed as $\mathbf{RCOND}=1/\left({‖A‖}_1{‖A^{-1}‖}_1\right)$.

9:     $\mathrm{ERRBND}$ – REAL (KIND=nag_wp)Output

On exit: if $\mathbf{IFAIL}=\mathbf{0}$ or $\mathbf{N}+\mathbf{1}$, an estimate of the forward error bound for a computed solution $\hat{x}$, such that ${‖\hat{x}-x‖}_1/{‖x‖}_1\le \mathbf{ERRBND}$, where $\hat{x}$ is a column of the computed solution returned in the array B and $x$ is the corresponding column of the exact solution $X$. If RCOND is less than machine precision, then ERRBND is returned as unity.

10:   $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction 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 parameter, 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}<0\hspace{0.17em}\text{and}\hspace{0.17em}\mathbf{IFAIL}\ne -999$

If $\mathbf{IFAIL}=-i$, the $i$th argument had an illegal value.

$\mathbf{IFAIL}>0\hspace{0.17em}\text{and}\hspace{0.17em}\mathbf{IFAIL}\le \mathbf{N}$

If $\mathbf{IFAIL}=i$, the leading minor of order $i$ of $A$ is not positive definite. The factorization could not be completed, and the solution has not been computed.

$\mathbf{IFAIL}=\mathbf{N}+1$

RCOND is less than machine precision, so that the matrix $A$ is numerically singular. A solution to the equations $AX=B$ has nevertheless been computed.

$\mathbf{IFAIL}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (f04cdfe.f90)

10.2  Program Data

Program Data (f04cdfe.d)

10.3  Program Results

Program Results (f04cdfe.r)