NAG Library Function Document
nag_matop_real_gen_matrix_cond_sqrt (f01jdc)
 
1
 Purpose
nag_matop_real_gen_matrix_cond_sqrt (f01jdc) computes an estimate of the relative condition number   and a bound on the relative residual, in the Frobenius norm, for the square root of a real  by  matrix . The principal square root, , of  is also returned.
 
2
 Specification
| 
| #include <nag.h> |  
| #include <nagf01.h> |  
| void | nag_matop_real_gen_matrix_cond_sqrt (Integer n,
double a[],
Integer pda,
double *alpha,
double *condsa,
NagError *fail) |  | 
 
3
 Description
For a matrix with no eigenvalues on the closed negative real line, the principal matrix square root, , of  is the unique square root with eigenvalues in the right half-plane.
The Fréchet derivative of a matrix function 
 in the direction of the matrix 
 is the linear function mapping 
 to 
 such that
The absolute condition number is given by the norm of the Fréchet derivative which is defined by 
The Fréchet derivative is linear in 
 and can therefore be written as 
 where the 
 operator stacks the columns of a matrix into one vector, so that 
 is 
.
nag_matop_real_gen_matrix_cond_sqrt (f01jdc) uses Algorithm 3.20 from 
Higham (2008) to compute an estimate 
 such that 
. The quantity of 
 provides a good approximation to 
. The relative condition number, 
, is then computed via
  is returned in the argument 
condsa.
 is computed using the algorithm described in 
Higham (1987).  This is a real arithmetic version of the algorithm of 
Björck and Hammarling (1983).  In addition, a blocking scheme described in 
Deadman et al. (2013) is used.
The computed quantity 
 is a measure of the stability of the relative residual (see 
Section 7). It is computed via
 
4
 References
Björck Å and Hammarling S (1983)  A Schur method for the square root of a matrix Linear Algebra Appl. 52/53 127–140 
Deadman E, Higham N J and Ralha R (2013)  Blocked Schur Algorithms for Computing the Matrix Square Root Applied Parallel and Scientific Computing: 11th International Conference, (PARA 2012, Helsinki, Finland) P. Manninen and P. Öster, Eds Lecture Notes in Computer Science 7782 171–181 Springer–Verlag 
Higham N J (1987)  Computing real square roots of a real matrix Linear Algebra Appl. 88/89 405–430 
Higham N J (2008)  Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA 
 
5
 Arguments
- 1:
  
      – IntegerInput
- 
On entry: , the order of the matrix . Constraint:
  .
 
- 2:
  
      – doubleInput/Output
- 
Note: the dimension,  dim, of the array  a
must be at least
 . 
 The th element of the matrix  is stored in . On entry: the  by  matrix . On exit: contains, if   NE_NOERROR, the   by   principal matrix square root,  . Alternatively, if  NE_EIGENVALUES, contains an   by   non-principal square root of  . 
 
- 3:
  
      – IntegerInput
- 
On entry: the stride separating matrix row elements in  the array  a. 
 Constraint:
  .
 
- 4:
  
      – double *Output
- 
On exit: an estimate of the stability of the relative residual for the computed principal (if   NE_NOERROR) or non-principal (if  NE_EIGENVALUES) matrix square root,  . 
 
- 5:
  
      – double *Output
- 
On exit: an estimate of the relative condition number, in the Frobenius norm, of the principal (if   NE_NOERROR) or non-principal (if  NE_EIGENVALUES) matrix square root at  ,  . 
 
- 6:
  
      – NagError *Input/Output
- 
The NAG error argument (see  Section 3.7 in How to Use the NAG Library and its Documentation). 
 
6
 Error Indicators and Warnings
- NE_ALG_FAIL
- 
An error occurred when computing the condition number. The matrix square root was still returned but you should use  nag_matop_real_gen_matrix_sqrt (f01enc) to check if it is the principal matrix square root.
 
An error occurred when computing the matrix square root. Consequently,  alpha  and  condsa could not be computed. It is likely that the function was  called incorrectly.
 
- 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_EIGENVALUES
- 
 has a semisimple vanishing eigenvalue. A non-principal square root  was returned.
 
- NE_INT
- 
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. 
	See  Section 2.7.6  in How to Use the NAG Library and its Documentation for further information. 
- NE_NEGATIVE_EIGVAL
- 
 has a negative real eigenvalue. The principal square root is not defined.   nag_matop_complex_gen_matrix_cond_sqrt (f01kdc) can be used to return a complex, non-principal square root.
 
 
- 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
- 
 has a defective vanishing eigenvalue. The square root and condition  number cannot be found in this case.
 
 
7
 Accuracy
If the computed square root is 
, then the relative residual
is bounded approximately by 
, where 
 is 
machine precision. The relative error in 
 is bounded approximately by 
.
 
8
 Parallelism and Performance
nag_matop_real_gen_matrix_cond_sqrt (f01jdc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_matop_real_gen_matrix_cond_sqrt (f01jdc) 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.
Approximately  of real allocatable memory is required by the function.
The cost of computing the matrix square root is  floating-point operations. The cost of computing the condition number depends on how fast the algorithm converges. It typically takes over twice as long as computing the matrix square root.
If condition estimates are not required then it is more efficient to use 
nag_matop_real_gen_matrix_sqrt (f01enc) to obtain the matrix square root alone. Condition estimates for the square root of a complex matrix can be obtained via 
nag_matop_complex_gen_matrix_cond_sqrt (f01kdc).
 
10
 Example
This example estimates the matrix square root and condition number of the matrix
 
10.1
 Program Text
Program Text (f01jdce.c)
 
10.2
 Program Data
Program Data (f01jdce.d)
 
10.3
 Program Results
Program Results (f01jdce.r)