NAG FL Interface
f07frf (zpotrf)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

f07frf computes the Cholesky factorization of a complex Hermitian positive definite matrix.

2 Specification

Fortran Interface
Subroutine f07frf ( uplo, n, a, lda, info)
Integer, Intent (In) :: n, lda
Integer, Intent (Out) :: info
Complex (Kind=nag_wp), Intent (Inout) :: a(lda,*)
Character (1), Intent (In) :: uplo
C Header Interface
#include <nag.h>
void  f07frf_ (const char *uplo, const Integer *n, Complex a[], const Integer *lda, Integer *info, const Charlen length_uplo)
The routine may be called by the names f07frf, nagf_lapacklin_zpotrf or its LAPACK name zpotrf.

3 Description

f07frf forms the Cholesky factorization of a complex Hermitian positive definite matrix A either as A=UHU if uplo='U' or A=LLH if uplo='L', where U is an upper triangular matrix and L is lower triangular.

4 References

Demmel J W (1989) On floating-point errors in Cholesky LAPACK Working Note No. 14 University of Tennessee, Knoxville https://www.netlib.org/lapack/lawnspdf/lawn14.pdf
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5 Arguments

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.
uplo='U'
The upper triangular part of A is stored and A is factorized as UHU, where U is upper triangular.
uplo='L'
The lower triangular part of A is stored and A is factorized as LLH, where L is lower triangular.
Constraint: uplo='U' or 'L'.
2: n Integer Input
On entry: n, the order of the matrix A.
Constraint: n0.
3: a(lda,*) Complex (Kind=nag_wp) array Input/Output
Note: the second dimension of the array a must be at least max(1,n).
On entry: the n×n Hermitian positive definite matrix A.
  • If uplo='U', the upper triangular part of A must be stored and the elements of the array below the diagonal are not referenced.
  • If uplo='L', the lower triangular part of A must be stored and the elements of the array above the diagonal are not referenced.
On exit: the upper or lower triangle of A is overwritten by the Cholesky factor U or L as specified by uplo.
4: lda Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f07frf is called.
Constraint: ldamax(1,n).
5: info Integer Output
On exit: info=0 unless the routine detects an error (see Section 6).

6 Error Indicators and Warnings

info<0
If info=-i, argument i had an illegal value. An explanatory message is output, and execution of the program is terminated.
info>0
The leading minor of order value is not positive definite and the factorization could not be completed. Hence A itself is not positive definite. This may indicate an error in forming the matrix A. To factorize a Hermitian matrix which is not positive definite, call f07mrf instead.

7 Accuracy

If uplo='U', the computed factor U is the exact factor of a perturbed matrix A+E, where
|E|c(n)ε|UH||U| ,  
c(n) is a modest linear function of n, and ε is the machine precision. If uplo='L', a similar statement holds for the computed factor L. It follows that |eij|c(n)εaiiajj.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f07frf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f07frf 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 routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The total number of real floating-point operations is approximately 43n3.
A call to f07frf may be followed by calls to the routines:
The real analogue of this routine is f07fdf.

10 Example

This example computes the Cholesky factorization of the matrix A, where
A= ( 3.23+0.00i 1.51-1.92i 1.90+0.84i 0.42+2.50i 1.51+1.92i 3.58+0.00i -0.23+1.11i -1.18+1.37i 1.90-0.84i -0.23-1.11i 4.09+0.00i 2.33-0.14i 0.42-2.50i -1.18-1.37i 2.33+0.14i 4.29+0.00i ) .  

10.1 Program Text

Program Text (f07frfe.f90)

10.2 Program Data

Program Data (f07frfe.d)

10.3 Program Results

Program Results (f07frfe.r)