F07 Chapter Contents
F07 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentF07KRF (ZPSTRF)

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

F07KRF (ZPSTRF) computes the Cholesky factorization with complete pivoting of a complex Hermitian positive semidefinite matrix.

## 2  Specification

 SUBROUTINE F07KRF ( UPLO, N, A, LDA, PIV, RANK, TOL, WORK, INFO)
 INTEGER N, LDA, PIV(N), RANK, INFO REAL (KIND=nag_wp) TOL, WORK(2*N) COMPLEX (KIND=nag_wp) A(LDA,*) CHARACTER(1) UPLO
The routine may be called by its LAPACK name zpstrf.

## 3  Description

F07KRF (ZPSTRF) forms the Cholesky factorization of a complex Hermitian positive semidefinite matrix $A$ either as ${P}^{\mathrm{T}}AP={U}^{\mathrm{H}}U$ if ${\mathbf{UPLO}}=\text{'U'}$ or ${P}^{\mathrm{T}}AP=L{L}^{\mathrm{H}}$ if ${\mathbf{UPLO}}=\text{'L'}$, where $P$ is a permutation matrix, $U$ is an upper triangular matrix and $L$ is lower triangular.
This algorithm does not attempt to check that $A$ is positive semidefinite.

## 4  References

Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia
Lucas C (2004) LAPACK-style codes for Level 2 and 3 pivoted Cholesky factorizations LAPACK Working Note 161. Technical Report CS-04-522 Department of Computer Science, University of Tennessee, 107 Ayres Hall, Knoxville, TN 37996-1301, USA

## 5  Parameters

1:     UPLO – CHARACTER(1)Input
On entry: specifies whether the upper or lower triangular part of $A$ is stored and how $A$ is to be factorized.
${\mathbf{UPLO}}=\text{'U'}$
The upper triangular part of $A$ is stored and $A$ is factorized as ${U}^{\mathrm{H}}U$, where $U$ is upper triangular.
${\mathbf{UPLO}}=\text{'L'}$
The lower triangular part of $A$ is stored and $A$ is factorized as $L{L}^{\mathrm{H}}$, where $L$ is lower triangular.
Constraint: ${\mathbf{UPLO}}=\text{'U'}$ or $\text{'L'}$.
2:     N – INTEGERInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{N}}\ge 0$.
3:     A(LDA,$*$) – COMPLEX (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array A must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{N}}\right)$.
On entry: the $n$ by $n$ Hermitian positive semidefinite matrix $A$.
• If ${\mathbf{UPLO}}=\text{'U'}$, the upper triangular part of $A$ must be stored and the elements of the array below the diagonal are not referenced.
• If ${\mathbf{UPLO}}=\text{'L'}$, the lower triangular part of $A$ must be stored and the elements of the array above the diagonal are not referenced.
On exit: if ${\mathbf{UPLO}}=\text{'U'}$, the first RANK rows of the upper triangle of $A$ are overwritten with the nonzero elements of the Cholesky factor $U$, and the remaining rows of the triangle are destroyed.
If ${\mathbf{UPLO}}=\text{'L'}$, the first RANK columns of the lower triangle of $A$ are overwritten with the nonzero elements of the Cholesky factor $L$, and the remaining columns of the triangle are destroyed.
4:     LDA – INTEGERInput
On entry: the first dimension of the array A as declared in the (sub)program from which F07KRF (ZPSTRF) is called.
Constraint: ${\mathbf{LDA}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{N}}\right)$.
5:     PIV(N) – INTEGER arrayOutput
On exit: PIV is such that the nonzero entries of $P$ are $P\left({\mathbf{PIV}}\left(\mathit{k}\right),\mathit{k}\right)=1$, for $\mathit{k}=1,2,\dots ,n$.
6:     RANK – INTEGEROutput
On exit: the computed rank of $A$ given by the number of steps the algorithm completed.
7:     TOL – REAL (KIND=nag_wp)Input
On entry: user defined tolerance. If ${\mathbf{TOL}}<0$, then  will be used. The algorithm terminates at the $r$th step if the $\left(r+1\right)$th step pivot $\text{}<{\mathbf{TOL}}$.
8:     WORK($2*{\mathbf{N}}$) – REAL (KIND=nag_wp) arrayWorkspace
9:     INFO – INTEGEROutput
On exit: ${\mathbf{INFO}}=0$ unless the routine detects an error (see Section 6).

## 6  Error Indicators and Warnings

Errors or warnings detected by the routine:
${\mathbf{INFO}}<0$
If ${\mathbf{INFO}}=-i$, the $i$th parameter had an illegal value. An explanatory message is output, and execution of the program is terminated.
${\mathbf{INFO}}=1$
The matrix $A$ is either rank deficient with computed rank as returned in RANK, or is indefinite, see Section 8.

## 7  Accuracy

If ${\mathbf{UPLO}}=\text{'L'}$ and ${\mathbf{RANK}}=r$, the computed Cholesky factor $L$ and permutation matrix $P$ satisfy the following upper bound
 $A - PLLHPT 2 A2 ≤ 2r cr ε W 2 + 1 2 + Oε2 ,$
where
 $W = L 11 -1 L12 , L = L11 0 L12 0 , L11 ∈ ℂr×r ,$
$c\left(r\right)$ is a modest linear function of $r$, $\epsilon$ is machine precision, and
 $W2 ≤ 13 n-r 4r-1 .$
So there is no guarantee of stability of the algorithm for large $n$ and $r$, although ${‖W‖}_{2}$ is generally small in practice.

The total number of real floating point operations is approximately $4n{r}^{2}-8/3{r}^{3}$, where $r$ is the computed rank of $A$.
This algorithm does not attempt to check that $A$ is positive semidefinite, and in particular the rank detection criterion in the algorithm is based on $A$ being positive semidefinite. If there is doubt over semidefiniteness then you should use the indefinite factorization F07MRF (ZHETRF). See Lucas (2004) for further information.
The real analogue of this routine is F07KDF (DPSTRF).

## 9  Example

This example computes the Cholesky factorization of the matrix $A$, where
 $A= 12.40+0.00i 2.39+0.00i 5.50+0.05i 4.47+0.00i 11.89+0.00i 2.39+0.00i 1.63+0.00i 1.04+0.10i 1.14+0.00i 1.81+0.00i 5.50+0.05i 1.04+0.10i 2.45+0.00i 1.98-0.03i 5.28-0.02i 4.47+0.00i 1.14+0.00i 1.98-0.03i 1.71+0.00i 4.14+0.00i 11.89+0.00i 1.81+0.00i 5.28-0.02i 4.14+0.00i 11.63+0.00i .$

### 9.1  Program Text

Program Text (f07krfe.f90)

### 9.2  Program Data

Program Data (f07krfe.d)

### 9.3  Program Results

Program Results (f07krfe.r)