XLPack 7.0
XLPack Numerical Library (C API) Reference Manual
Loading...
Searching...
No Matches

◆ dspgvx()

void dspgvx ( int  itype,
char  jobz,
char  range,
char  uplo,
int  n,
double  ap[],
double  bp[],
double  vl,
double  vu,
int  il,
int  iu,
double  abstol,
int *  m,
double  w[],
int  ldz,
double  z[],
double  work[],
int  iwork[],
int  ifail[],
int *  info 
)

(Expert driver) Generalized eigenvalue problem of symmetric matrices in packed form

Purpose
This routine computes selected eigenvalues, and optionally, the eigenvectors of a real generalized symmetric-definite eigenproblem, of the form
A*x = lambda*B*x, A*Bx = lambda*x, or B*A*x = lambda*x.
Here A and B are assumed to be symmetric, stored in packed form, and B is also positive definite.
Eigenvalues and eigenvectors can be selected by specifying either a range of values or a range of indices for the desired eigenvalues.
Parameters
[in]itypeSpecifies the problem type to be solved:
= 1: A*x = (lambda)*B*x.
= 2: A*B*x = (lambda)*x.
= 3: B*A*x = (lambda)*x.
[in]jobz= 'N': Compute eigenvalues only.
= 'V': Compute eigenvalues and eigenvectors.
[in]range= 'A': All eigenvalues will be found.
= 'V': All eigenvalues in the half-open interval (vl, vu] will be found.
= 'I': The il-th through iu-th eigenvalues will be found.
[in]uplo= 'U': Upper triangles of A and B are stored.
= 'L': Lower triangles of A and B are stored.
[in]nOrder of the matrices A and B. (n >= 0) (If n = 0, returns without computation)
[in,out]ap[]Array ap[lap] (lap >= n(n + 1)/2)
[in] The upper or lower triangle of the symmetric matrix A, packed columnwise in a linear array. The j-th column of A is stored in the array ap as follows.
uplo = 'U': ap[i + j*(j + 1)/2] = Aij for 0 <= i <= j <= n - 1.
uplo = 'L': ap[(i + j*(2*n - j - 1)/2] = Aij for 0 <= j < = i <= n - 1.
[out] The contents of ap[] are destroyed.
[in,out]bp[]Array bp[lbp] (lbp >= n(n + 1)/2)
[in] The upper or lower triangle of the symmetric positive definite matrix B, packed columnwise in a linear array. The j-th column of B is stored in the array bp as follows.
uplo = 'U': bp[i + j*(j + 1)/2] = Bij for 0 <= i <= j <= n - 1.
uplo = 'L': bp[(i + j*(2*n - j - 1)/2] = Bij for 0 <= j < = i <= n - 1.
[out] The triangular factor U or L from the Cholesky factorization B = U^T*U or B = L*L^T, in the same storage format as B.
[in]vlrange = 'V': The lower bound of the interval to be searched for eigenvalues. (vl < vu)
range = 'A' or 'I': Not referenced.
[in]vurange = 'V': The upper bound of the interval to be searched for eigenvalues. (vl < vu)
range = 'A' or 'I': Not referenced.
[in]ilrange = 'I': The index of the smallest eigenvalue to be returned. (1 <= il <= iu <= n, if n > 0; il = 1 and iu = 0 if n = 0)
range = 'A' or 'V': Not referenced.
[in]iurange = 'I': The index of the largest eigenvalues to be returned. (1 <= il <= iu <= n, if n > 0; il = 1 and iu = 0 if n = 0)
range = 'A' or 'V': Not referenced.
[in]abstolThe absolute error tolerance for the eigenvalues.
An approximate eigenvalue is accepted as converged when it is determined to lie in an interval [a, b] of width less than or equal to abstol + eps * max(|a|, |b|), where eps is the machine precision. If abstol is less than or equal to zero, then eps*|T| will be used in its place, where |T| is the 1-norm of the tridiagonal matrix obtained by reducing A to tridiagonal form.
Eigenvalues will be computed most accurately when abstol is set to twice the underflow threshold 2*dlamch('S'), not zero. If this routine returns with info > 0, indicating that some eigenvectors did not converge, try setting abstol to 2*dlamch('S').
[out]mThe total number of eigenvalues found. (0 <= m <= n)
If range = 'A', m = n, and if range = 'I', m = iu - il + 1.
[out]w[]Array w[lw] (lw >= n)
On normal exit, the first m elements contain the selected eigenvalues in ascending order.
[in]ldzLeading dimension of the two dimensional array z[][]. (ldz >= 1 if jobz = 'N', ldz >= max(1, n) if jobz = 'V')
[out]z[][]Array z[lz][ldz] (lz >= max(1, m))
jobz = 'V': 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].
  The eigenvectors are normalized as follows:
    itype = 1 or 2: Z^T*B*Z = I
    itype = 3: Z^T*inv(B)*Z = I
  If an eigenvector fails to converge, then that column of z[][] contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in ifail[].
jobz = 'N': z[][] is not referenced.
Note: The user must ensure that at least max(1, m) columns are supplied in the array z[][]; if range = 'V', the exact value of m is not known in advance and an upper bound must be used.
[out]work[]Array work[lwork] (lwork >= 8*n)
Work array.
[out]iwork[]Array iwork[liwork] (liwork >= 5*n)
Integer work array.
[out]ifail[]Array ifail[lifail] (lifail >= n)
jobz = 'V': If info = 0, the first m elements of ifail[] are zero. If info > 0, then ifail[] contains the indices of the eigenvectors that failed to converge.
jobz = 'N': ifail[] is not referenced.
[out]info= 0: Successful exit
= -1: The argument itype had an illegal value (itype < 1 or itype > 3)
= -2: The argument jobz had an illegal value (jobz != 'V' nor 'N')
= -3: The argument range had an illegal value (range != 'A', 'V' nor 'I')
= -4: The argument uplo had an illegal value (uplo != 'U' nor 'L')
= -5: The argument n had an illegal value (n < 0)
= -9: The argument vu had an illegal value (vu <= vl)
= -10: The argument il had an illegal value (il < 1 or il > n)
= -11: The argument iu had an illegal value (iu < min(n, il) or iu > n)
= -15: The argument ldz had an illegal value (ldz too small)
= i (0 < i <= n): dspevx failed to converge; i eigenvectors failed to converge. Their indices are stored in array ifail[].
= i (i > n): The leading minor of order i-n of B is not positive definite. The factorization of B could not be completed and no eigenvalues or eigenvectors were computed.
Reference
LAPACK