The function may be called by the names: f07kdc, nag_lapacklin_dpstrf or nag_dpstrf.
f07kdc forms the Cholesky factorization of a real symmetric positive semidefinite matrix either as if or if , where is a permutation matrix, is an upper triangular matrix and is lower triangular.
This algorithm does not attempt to check that is positive semidefinite.
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 No. 161. Technical Report CS-04-522 Department of Computer Science, University of Tennessee, 107 Ayres Hall, Knoxville, TN 37996-1301, USA https://www.netlib.org/lapack/lawnspdf/lawn161.pdf
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 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
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.
3: – IntegerInput
On entry: , the order of the matrix .
4: – doubleInput/Output
Note: the dimension, dim, of the array a
must be at least
On entry: the symmetric positive semidefinite 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: if , the first rank rows of the upper triangle of are overwritten with the nonzero elements of the Cholesky factor , and the remaining rows of the triangle are destroyed.
If , the first rank columns of the lower triangle of are overwritten with the nonzero elements of the Cholesky factor , and the remaining columns of the triangle are destroyed.
5: – IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) of the matrix in the array
6: – IntegerOutput
On exit: piv is such that the nonzero entries of
are , for .
7: – Integer *Output
On exit: the computed rank of given by the number of steps the algorithm completed.
8: – doubleInput
On entry: user defined tolerance. If , will be used. The algorithm terminates at the th step if the th step pivot .
9: – NagError *Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).
6Error Indicators and Warnings
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument had an illegal value.
On entry, .
On entry, and .
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.
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.
The matrix is not positive definite. It is either positive semidefinite with computed rank as returned in rank and less than , or it may be indefinite, see Section 9.
If and , the computed Cholesky factor and permutation matrix satisfy the following upper bound
is a modest linear function of , is machine precision, and
So there is no guarantee of stability of the algorithm for large and , although is generally small in practice.
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
f07kdc 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 total number of floating-point operations is approximately , where is the computed rank of .
This algorithm does not attempt to check that is positive semidefinite, and in particular the rank detection criterion in the algorithm is based on being positive semidefinite. If there is doubt over semidefiniteness then you should use the indefinite factorization f07mdc. See Lucas (2004) for further information.