nag_real_sym_posdef_packed_lin_solve (f04bec) (PDF version)
f04 Chapter Contents
f04 Chapter Introduction
NAG Library Manual

NAG Library Function Document

nag_real_sym_posdef_packed_lin_solve (f04bec)

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_real_sym_posdef_packed_lin_solve (f04bec) computes the solution to a real system of linear equations AX=B, where A is an n by n symmetric positive definite matrix, stored in packed format, and X and B are n by r matrices. An estimate of the condition number of A and an error bound for the computed solution are also returned.

2  Specification

#include <nag.h>
#include <nagf04.h>
void  nag_real_sym_posdef_packed_lin_solve (Nag_OrderType order, Nag_UploType uplo, Integer n, Integer nrhs, double ap[], double b[], Integer pdb, double *rcond, double *errbnd, NagError *fail)

3  Description

The Cholesky factorization is used to factor A as A=UTU, if uplo=Nag_Upper, or A=LLT, if uplo=Nag_Lower, where U is an upper triangular matrix and L is a lower triangular matrix. The factored form of A is then used to solve the system of equations AX=B.

4  References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia http://www.netlib.org/lapack/lug
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5  Arguments

1:     order 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 order=Nag_RowMajor. 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: order=Nag_RowMajor or Nag_ColMajor.
2:     uplo Nag_UploTypeInput
On entry: if uplo=Nag_Upper, the upper triangle of the matrix A is stored.
If uplo=Nag_Lower, the lower triangle of the matrix A is stored.
Constraint: uplo=Nag_Upper or Nag_Lower.
3:     n IntegerInput
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: n0.
4:     nrhs IntegerInput
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: nrhs0.
5:     ap[dim] doubleInput/Output
Note: the dimension, dim, of the array ap must be at least max1,n×n+1/2.
On entry: the n by n symmetric matrix A. The upper or lower triangular part of the symmetric matrix is packed column-wise in a linear array. The jth column of A is stored in the array ap as follows:
The storage of elements Aij depends on the order and uplo arguments as follows:
  • if order=Nag_ColMajor and uplo=Nag_Upper,
              Aij is stored in ap[j-1×j/2+i-1], for ij;
  • if order=Nag_ColMajor and uplo=Nag_Lower,
              Aij is stored in ap[2n-j×j-1/2+i-1], for ij;
  • if order=Nag_RowMajor and uplo=Nag_Upper,
              Aij is stored in ap[2n-i×i-1/2+j-1], for ij;
  • if order=Nag_RowMajor and uplo=Nag_Lower,
              Aij is stored in ap[i-1×i/2+j-1], for ij.
On exit: if fail.code= NE_NOERROR or NE_RCOND, the factor U or L from the Cholesky factorization A=UTU or A=LLT, in the same storage format as A.
6:     b[dim] doubleInput/Output
Note: the dimension, dim, of the array b must be at least
  • max1,pdb×nrhs when order=Nag_ColMajor;
  • max1,n×pdb when order=Nag_RowMajor.
The i,jth element of the matrix B is stored in
  • b[j-1×pdb+i-1] when order=Nag_ColMajor;
  • b[i-1×pdb+j-1] when order=Nag_RowMajor.
On entry: the n by r matrix of right-hand sides B.
On exit: if fail.code= NE_NOERROR or NE_RCOND, the n by r solution matrix X.
7:     pdb IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array b.
Constraints:
  • if order=Nag_ColMajor, pdbmax1,n;
  • if order=Nag_RowMajor, pdbmax1,nrhs.
8:     rcond double *Output
On exit: if fail.code= NE_NOERROR or NE_RCOND, an estimate of the reciprocal of the condition number of the matrix A, computed as rcond=1/A1A-11.
9:     errbnd double *Output
On exit: if fail.code= NE_NOERROR or NE_RCOND, an estimate of the forward error bound for a computed solution x^, such that x^-x1/x1errbnd, where 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:   fail 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.
The Integer allocatable memory required is n, and the double allocatable memory required is 3×n. Allocation failed before the solution could be computed.
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 value had an illegal value.
NE_INT
On entry, n=value.
Constraint: n0.
On entry, nrhs=value.
Constraint: nrhs0.
On entry, pdb=value.
Constraint: pdb>0.
NE_INT_2
On entry, pdb=value and n=value.
Constraint: pdbmax1,n.
On entry, pdb=value and nrhs=value.
Constraint: pdbmax1,nrhs.
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_POS_DEF
The principal minor of order value of the matrix A is not positive definite. The factorization has not been completed and the solution could not be computed.
NE_RCOND
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.

7  Accuracy

The computed solution for a single right-hand side, x^, satisfies an equation of the form
A+E x^=b,  
where
E1=Oε A1  
and ε is the machine precision. An approximate error bound for the computed solution is given by
x^-x1 x1 κA E1 A1 ,  
where κA=A-11A1, the condition number of A with respect to the solution of the linear equations. nag_real_sym_posdef_packed_lin_solve (f04bec) uses the approximation E1=εA1 to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8  Parallelism and Performance

nag_real_sym_posdef_packed_lin_solve (f04bec) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_real_sym_posdef_packed_lin_solve (f04bec) 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.

9  Further Comments

The packed storage scheme is illustrated by the following example when n=4 and uplo=Nag_Upper. Two-dimensional storage of the symmetric matrix A:
a11 a12 a13 a14 a22 a23 a24 a33 a34 a44 aij = aji  
Packed storage of the upper triangle of A:
ap= a11, a12, a22, a13, a23, a33, a14, a24, a34, a44  
The total number of floating-point operations required to solve the equations AX=B is proportional to 13n3+n2r. The condition number estimation typically requires between four and five solves and never more than eleven solves, following the factorization.
In practice the condition number estimator is very reliable, but it can underestimate the true condition number; see Section 15.3 of Higham (2002) for further details.
The complex analogue of nag_real_sym_posdef_packed_lin_solve (f04bec) is nag_herm_posdef_packed_lin_solve (f04cec).

10  Example

This example solves the equations
AX=B,  
where A is the symmetric positive definite matrix
A= 4.16 -3.12 0.56 -0.10 -3.12 5.03 -0.83 1.18 0.56 -0.83 0.76 0.34 -0.10 1.18 0.34 1.18   and   B= 8.70 8.30 -13.35 2.13 1.89 1.61 -4.14 5.00 .  
An estimate of the condition number of A and an approximate error bound for the computed solutions are also printed.

10.1  Program Text

Program Text (f04bece.c)

10.2  Program Data

Program Data (f04bece.d)

10.3  Program Results

Program Results (f04bece.r)


nag_real_sym_posdef_packed_lin_solve (f04bec) (PDF version)
f04 Chapter Contents
f04 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2016