NAG Library Function Document
nag_zhetrf (f07mrc)
1 Purpose
nag_zhetrf (f07mrc) computes the Bunch–Kaufman factorization of a complex Hermitian indefinite matrix.
2 Specification
#include <nag.h> |
#include <nagf07.h> |
void |
nag_zhetrf (Nag_OrderType order,
Nag_UploType uplo,
Integer n,
Complex a[],
Integer pda,
Integer ipiv[],
NagError *fail) |
|
3 Description
nag_zhetrf (f07mrc) factorizes a complex Hermitian matrix , using the Bunch–Kaufman diagonal pivoting method. is factorized either as if or if , where is a permutation matrix, (or ) is a unit upper (or lower) triangular matrix and is an Hermitian block diagonal matrix with by and by diagonal blocks; (or ) has by unit diagonal blocks corresponding to the by blocks of . Row and column interchanges are performed to ensure numerical stability while keeping the matrix Hermitian.
This method is suitable for Hermitian matrices which are not known to be positive definite. If is in fact positive definite, no interchanges are performed and no by blocks occur in .
4 References
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5 Arguments
- 1:
– Nag_OrderTypeInput
-
On entry: the
order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by
. See
Section 2.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint:
or .
- 2:
– Nag_UploTypeInput
-
On entry: specifies whether the upper or lower triangular part of
is stored and how
is to be factorized.
- The upper triangular part of is stored and is factorized as , where is upper triangular.
- The lower triangular part of is stored and is factorized as , where is lower triangular.
Constraint:
or .
- 3:
– IntegerInput
-
On entry: , the order of the matrix .
Constraint:
.
- 4:
– ComplexInput/Output
-
Note: the dimension,
dim, of the array
a
must be at least
.
On entry: the
by
Hermitian indefinite matrix
.
If , is stored in .
If , is stored in .
If , the upper triangular part of must be stored and the elements of the array below the diagonal are not referenced.
If , the lower triangular part of must be stored and the elements of the array above the diagonal are not referenced.
On exit: the upper or lower triangle of
is overwritten by details of the block diagonal matrix
and the multipliers used to obtain the factor
or
as specified by
uplo.
- 5:
– IntegerInput
On entry: the stride separating row or column elements (depending on the value of
order) of the matrix
in the array
a.
Constraint:
.
- 6:
– IntegerOutput
-
Note: the dimension,
dim, of the array
ipiv
must be at least
.
On exit: details of the interchanges and the block structure of
. More precisely,
- if , is a by pivot block and the th row and column of were interchanged with the th row and column;
- if and , is a by pivot block and the th row and column of were interchanged with the th row and column;
- if and , is a by pivot block and the th row and column of were interchanged with the th row and column.
- 7:
– NagError *Input/Output
-
The NAG error argument (see
Section 2.7 in How to Use the NAG Library and its Documentation).
6 Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
On entry, and .
Constraint: .
- 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.
An unexpected error has been triggered by this function. Please contact
NAG.
See
Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
- NE_SINGULAR
-
Element of the diagonal is exactly zero.
The factorization has been completed, but the block diagonal matrix is exactly singular, and division by zero will occur if it is
used to solve a system of equations.
7 Accuracy
If
, the computed factors
and
are the exact factors of a perturbed matrix
, where
is a modest linear function of
, and
is the
machine precision.
If , a similar statement holds for the computed factors and .
8 Parallelism and Performance
nag_zhetrf (f07mrc) 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.
The elements of
overwrite the corresponding elements of
; if
has
by
blocks, only the upper or lower triangle is stored, as specified by
uplo.
The unit diagonal elements of
or
and the
by
unit diagonal blocks are not stored. The remaining elements of
or
are stored in the corresponding columns of the array
a, but additional row interchanges must be applied to recover
or
explicitly (this is seldom necessary). If
, for
(as is the case when
is positive definite), then
or
is stored explicitly (except for its unit diagonal elements which are equal to
).
The total number of real floating-point operations is approximately .
A call to nag_zhetrf (f07mrc) may be followed by calls to the functions:
The real analogue of this function is
nag_dsytrf (f07mdc).
10 Example
This example computes the Bunch–Kaufman factorization of the matrix
, where
10.1 Program Text
Program Text (f07mrce.c)
10.2 Program Data
Program Data (f07mrce.d)
10.3 Program Results
Program Results (f07mrce.r)