Developer Reference for Intel® oneAPI Math Kernel Library for C
?syevr
Computes selected eigenvalues and, optionally, eigenvectors of a real symmetric matrix using the Relatively Robust Representations.
Syntax
lapack_intLAPACKE_ssyevr ( intmatrix_layout , charjobz , charrange , charuplo , lapack_intn , float*a , lapack_intlda , floatvl , floatvu , lapack_intil , lapack_intiu , floatabstol , lapack_int*m , float*w , float*z , lapack_intldz , lapack_int*isuppz );
lapack_intLAPACKE_dsyevr ( intmatrix_layout , charjobz , charrange , charuplo , lapack_intn , double*a , lapack_intlda , doublevl , doublevu , lapack_intil , lapack_intiu , doubleabstol , lapack_int*m , double*w , double*z , lapack_intldz , lapack_int*isuppz );
Include Files
mkl.h
Description
ssyevr dsyevr syevr
The routine computes selected eigenvalues and, optionally, eigenvectors of a real symmetric matrix A . Eigenvalues and eigenvectors can be selected by specifying either a range of values or a range of indices for the desired eigenvalues.
The routine first reduces the matrix A to tridiagonal form T . Then, whenever possible, ?syevr calls stemr to compute the eigenspectrum using Relatively Robust Representations. stemr computes eigenvalues by the dqds algorithm, while orthogonal eigenvectors are computed from various “good” L*D*L:code:`T` representations (also known as Relatively Robust Representations). Gram-Schmidt orthogonalization is avoided as far as possible. More specifically, the various steps of the algorithm are as follows. For the each unreduced block of T :
Compute T - σ*I = L*D*L^{T} , so that L and D define all the wanted eigenvalues to high relative accuracy. This means that small relative changes in the entries of D and L cause only small relative changes in the eigenvalues and eigenvectors. The standard (unfactored) representation of the tridiagonal matrix T does not have this property in general.
Compute the eigenvalues to suitable accuracy. If the eigenvectors are desired, the algorithm attains full accuracy of the computed eigenvalues only right before the corresponding vectors have to be computed, see Steps c) and d).
For each cluster of close eigenvalues, select a new shift close to the cluster, find a new factorization, and refine the shifted eigenvalues to suitable accuracy.
For each eigenvalue with a large enough relative separation, compute the corresponding eigenvector by forming a rank revealing twisted factorization. Go back to Step c) for any clusters that remain.
The desired accuracy of the output can be specified by the input parameter abstol .
The routine ?syevr calls stemr when the full spectrum is requested on machines that conform to the IEEE-754 floating point standard. ?syevr calls stebz and stein on non-IEEE machines and when partial spectrum requests are made.
Normal execution of ?dsyevr may create NaNs and infinities and may abort due to a floating point exception in environments that do not handle NaNs and infinities in the IEEE standard default manner.
Note that ?syevr is preferable for most cases of real symmetric eigenvalue problems as its underlying algorithm is fast and uses less workspace.
Input Parameters
- matrix_layout
-
Specifies whether matrix storage layout is row major ( LAPACK_ROW_MAJOR ) or column major ( LAPACK_COL_MAJOR ).
jobz
Must be ‘N’ or ‘V’ .
If jobz = 'N' , then only eigenvalues are computed. If jobz = 'V' , then eigenvalues and eigenvectors are computed.
range
Must be ‘A’ or ‘V’ or ‘I’ .
If range = 'A' , the routine computes all eigenvalues. If range = 'V' , the routine computes eigenvalues w(i)w[i] in the half-open interval: vl < w(i)w[i]≤vu . If range = 'I' , the routine computes eigenvalues with indices il to iu . For range = 'V' or ‘I’ and iu-il < n-1 , sstebz / dstebz and sstein / dstein are called.
uplo
Must be ‘U’ or ‘L’ .
If uplo = 'U' , a stores the upper triangular part of A . If uplo = 'L' , a stores the lower triangular part of A .
n
The order of the matrix A ( n≥ 0 ).
- a , work
-
REAL for ssyevr DOUBLE PRECISION for dsyevr . Arrays:
a (size max(1, lda * n )) is an array containing either upper or lower triangular part of the symmetric matrix A , as specified by uplo .
The second dimension of a must be at least max(1, n ). work is a workspace array, its dimension max(1, lwork) .
lda
The leading dimension of the array a . Must be at least max(1, n ).
- vl , vu
-
REAL for ssyevr DOUBLE PRECISION for dsyevr . If range = 'V' , the lower and upper bounds of the interval to be searched for eigenvalues. Constraint: vl< vu . If range = 'A' or ‘I’ , vl and vu are not referenced.
il , iu
If range = 'I' , the indices in ascending order of the smallest and largest eigenvalues to be returned. Constraint: 1 ≤il≤iu≤n , if n > 0 ; il=1 and iu=0 , if n = 0 . If range = 'A' or ‘V’ , il and iu are not referenced.
- abstol
-
REAL for ssyevr DOUBLE PRECISION for dsyevr . The absolute error tolerance to which each eigenvalue/eigenvector is required. If jobz = 'V' , the eigenvalues and eigenvectors output have residual norms bounded by abstol , and the dot products between different eigenvectors are bounded by abstol . If abstol < n *eps*||T|| , then n *eps*||T|| is used instead, where eps is the machine precision, and ||T|| is the 1-norm of the matrix T . The eigenvalues are computed to an accuracy of eps*||T|| irrespective of abstol . If high relative accuracy is important, set abstol to ?lamch (‘S’).
ldz
The leading dimension of the output array z .
Constraints: ldz≥ 1 if jobz = 'N' and
ldz≥ max(1, n) for column major layout and ldz ≥ max(1, m ) for row major layout if jobz = 'V' .
lwork
The dimension of the array work . Constraint: lwork≥ max(1, 26n) . If lwork = -1 , then a workspace query is assumed; the routine only calculates the optimal size of the work array, returns this value as the first entry of the work array, and no error message related to lwork is issued by xerbla . See Application Notes for the suggested value of lwork .
iwork
Workspace array, its dimension max(1, liwork) .
liwork
The dimension of the array iwork , lwork≥ max(1, 10n) . If liwork = -1 , then a workspace query is assumed; the routine only calculates the optimal size of the iwork array, returns this value as the first entry of the iwork array, and no error message related to liwork is issued by xerbla .
Output Parameters
- a
-
On exit, the lower triangle (if uplo = 'L' ) or the upper triangle (if uplo = 'U' ) of A , including the diagonal, is overwritten.
m
The total number of eigenvalues found, 0 ≤m≤n .
If range = 'A' , m = n , if range = 'I' , m = iu-il+1 , and if range = 'V' the exact value of m is not known in advance.
- w , z
-
REAL for ssyevr DOUBLE PRECISION for dsyevr . Arrays:
w , size at least max(1, n ), contains the selected eigenvalues in ascending order, stored in w(1)w[0] to w(m)w[m - 1] ;
z (size max(1, ldz * m ) for column major layout and max(1, ldz * n ) for row major layout) .
If jobz = 'V' , then if info = 0 , the first m columns of z contain the orthonormal eigenvectors of the matrix A corresponding to the selected eigenvalues, with the i -th column of z holding the eigenvector associated with w(i)w[i - 1] .
If jobz = 'N' , then z is not referenced.
isuppz
Array, size at least 2 *max(1, m ). The support of the eigenvectors in z , i.e., the indices indicating the nonzero elements in z . The i -th eigenvector is nonzero only in elements isuppz( 2i-1)isuppz[2i - 2] through isuppz( 2i )isuppz[2i - 1] . Referenced only if eigenvectors are needed ( jobz = 'V' ) and all eigenvalues are needed, that is, range = 'A' or range = 'I' and il = 1 and iu = n .
- work(1)
-
On exit, if info = 0 , then work(1) returns the required minimal size of lwork .
- iwork(1)
-
On exit, if info = 0 , then iwork(1) returns the required minimal size of liwork .
Return Values
This function returns a value info .
If info=0 , the execution is successful.
If info = -i , the i -th parameter had an illegal value.
If info = i , an internal error has occurred.
LAPACK 95 Interface Notes
There exist FORTRAN 77 and FORTRAN 95 interfaces for this routine. See the Intel® oneMKL Fortran Developer Reference for details.