NAG Library Function Document
nag_matop_real_gen_matrix_sqrt (f01enc)
1
Purpose
nag_matop_real_gen_matrix_sqrt (f01enc) computes the principal matrix square root, , of a real by matrix .
2
Specification
#include <nag.h> |
#include <nagf01.h> |
void |
nag_matop_real_gen_matrix_sqrt (Integer n,
double a[],
Integer pda,
NagError *fail) |
|
3
Description
A square root of a matrix is a solution to the equation . A nonsingular matrix has multiple square roots. For a matrix with no eigenvalues on the closed negative real line, the principal square root, denoted by , is the unique square root whose eigenvalues lie in the open right half-plane.
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.
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:
– 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_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 is 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_sqrt (f01fnc) 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 cannot be found in this case.
7
Accuracy
The computed square root satisfies , where , where is machine precision.
For further discussion of the condition of the matrix square root see Section 6.1 of
Higham (2008).
8
Parallelism and Performance
nag_matop_real_gen_matrix_sqrt (f01enc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_matop_real_gen_matrix_sqrt (f01enc) 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 cost of the algorithm is
floating-point operations; see Algorithm 6.7 of
Higham (2008).
of real allocatable memory is required by the function.
If condition number and residual bound estimates are required, then
nag_matop_real_gen_matrix_cond_sqrt (f01jdc) should be used.
10
Example
This example finds the principal matrix square root of the matrix
10.1
Program Text
Program Text (f01ence.c)
10.2
Program Data
Program Data (f01ence.d)
10.3
Program Results
Program Results (f01ence.r)