Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_lapack_dstevx (f08jb)

## Purpose

nag_lapack_dstevx (f08jb) computes selected eigenvalues and, optionally, eigenvectors of a real symmetric tridiagonal matrix A$A$. Eigenvalues and eigenvectors can be selected by specifying either a range of values or a range of indices for the desired eigenvalues.

## Syntax

[d, e, m, w, z, jfail, info] = f08jb(jobz, range, d, e, vl, vu, il, iu, abstol, 'n', n)
[d, e, m, w, z, jfail, info] = nag_lapack_dstevx(jobz, range, d, e, vl, vu, il, iu, abstol, 'n', n)

## Description

nag_lapack_dstevx (f08jb) computes the required eigenvalues and eigenvectors of A$A$ by reducing the tridiagonal matrix to diagonal form using the QR$QR$ algorithm. Bisection is used to determine selected eigenvalues.

## 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
Demmel J W and Kahan W (1990) Accurate singular values of bidiagonal matrices SIAM J. Sci. Statist. Comput. 11 873–912
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

## Parameters

### Compulsory Input Parameters

1:     jobz – string (length ≥ 1)
Indicates whether eigenvectors are computed.
jobz = 'N'${\mathbf{jobz}}=\text{'N'}$
Only eigenvalues are computed.
jobz = 'V'${\mathbf{jobz}}=\text{'V'}$
Eigenvalues and eigenvectors are computed.
Constraint: jobz = 'N'${\mathbf{jobz}}=\text{'N'}$ or 'V'$\text{'V'}$.
2:     range – string (length ≥ 1)
If range = 'A'${\mathbf{range}}=\text{'A'}$, all eigenvalues will be found.
If range = 'V'${\mathbf{range}}=\text{'V'}$, all eigenvalues in the half-open interval (vl,vu]$\left({\mathbf{vl}},{\mathbf{vu}}\right]$ will be found.
If range = 'I'${\mathbf{range}}=\text{'I'}$, the ilth to iuth eigenvalues will be found.
Constraint: range = 'A'${\mathbf{range}}=\text{'A'}$, 'V'$\text{'V'}$ or 'I'$\text{'I'}$.
3:     d( : $:$) – double array
Note: the dimension of the array d must be at least max (1,n)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
The n$n$ diagonal elements of the tridiagonal matrix A$A$.
4:     e( : $:$) – double array
Note: the dimension of the array e must be at least max (1,n1)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}-1\right)$.
The (n1)$\left(n-1\right)$ subdiagonal elements of the tridiagonal matrix A$A$.
5:     vl – double scalar
6:     vu – double scalar
If range = 'V'${\mathbf{range}}=\text{'V'}$, the lower and upper bounds of the interval to be searched for eigenvalues.
If range = 'A'${\mathbf{range}}=\text{'A'}$ or 'I'$\text{'I'}$, vl and vu are not referenced.
Constraint: if range = 'V'${\mathbf{range}}=\text{'V'}$, vl < vu${\mathbf{vl}}<{\mathbf{vu}}$.
7:     il – int64int32nag_int scalar
8:     iu – int64int32nag_int scalar
If range = 'I'${\mathbf{range}}=\text{'I'}$, the indices (in ascending order) of the smallest and largest eigenvalues to be returned.
If range = 'A'${\mathbf{range}}=\text{'A'}$ or 'V'$\text{'V'}$, il and iu are not referenced.
Constraints:
• if range = 'I'${\mathbf{range}}=\text{'I'}$ and n = 0${\mathbf{n}}=0$, il = 1${\mathbf{il}}=1$ and iu = 0${\mathbf{iu}}=0$;
• if range = 'I'${\mathbf{range}}=\text{'I'}$ and n > 0${\mathbf{n}}>0$, 1 il iu n $1\le {\mathbf{il}}\le {\mathbf{iu}}\le {\mathbf{n}}$.
9:     abstol – double scalar
The absolute error tolerance for the eigenvalues. An approximate eigenvalue is accepted as converged when it is determined to lie in an interval [a,b] $\left[a,b\right]$ of width less than or equal to
 abstol + ε max (|a|,|b|) , $abstol+ε max(|a|,|b|) ,$
where ε $\epsilon$ is the machine precision. If abstol is less than or equal to zero, then ε A1 $\epsilon {‖A‖}_{1}$ will be used in its place. Eigenvalues will be computed most accurately when abstol is set to twice the underflow threshold 2 × x02am (   ) , not zero. If this function returns with ${\mathbf{INFO}}>{\mathbf{0}}$, indicating that some eigenvectors did not converge, try setting abstol to 2 × x02am (   ) . See Demmel and Kahan (1990).

### Optional Input Parameters

1:     n – int64int32nag_int scalar
Default: The dimension of the array d.
n$n$, the order of the matrix.
Constraint: n0${\mathbf{n}}\ge 0$.

ldz work iwork

### Output Parameters

1:     d( : $:$) – double array
Note: the dimension of the array d must be at least max (1,n)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
May be multiplied by a constant factor chosen to avoid over/underflow in computing the eigenvalues.
2:     e( : $:$) – double array
Note: the dimension of the array e must be at least max (1,n1)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}-1\right)$.
May be multiplied by a constant factor chosen to avoid over/underflow in computing the eigenvalues.
3:     m – int64int32nag_int scalar
The total number of eigenvalues found. 0mn$0\le {\mathbf{m}}\le {\mathbf{n}}$.
If range = 'A'${\mathbf{range}}=\text{'A'}$, m = n${\mathbf{m}}={\mathbf{n}}$.
If range = 'I'${\mathbf{range}}=\text{'I'}$, m = iuil + 1${\mathbf{m}}={\mathbf{iu}}-{\mathbf{il}}+1$.
4:     w(n) – double array
The first m elements contain the selected eigenvalues in ascending order.
5:     z(ldz, : $:$) – double array
The first dimension, ldz, of the array z will be
• if jobz = 'V'${\mathbf{jobz}}=\text{'V'}$, ldz max (1,n) $\mathit{ldz}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$;
• otherwise ldz1$\mathit{ldz}\ge 1$.
The second dimension of the array will be max (1,m)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$ if jobz = 'V'${\mathbf{jobz}}=\text{'V'}$, and at least 1$1$ otherwise
If jobz = 'V'${\mathbf{jobz}}=\text{'V'}$, then
• if ${\mathbf{INFO}}={\mathbf{0}}$, the first m columns of Z$Z$ contain the orthonormal eigenvectors of the matrix A$A$ corresponding to the selected eigenvalues, with the i$i$th column of Z$Z$ holding the eigenvector associated with w(i)${\mathbf{w}}\left(i\right)$;
• if an eigenvector fails to converge (${\mathbf{INFO}}>{\mathbf{0}}$), then that column of Z$Z$ contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in jfail.
If jobz = 'N'${\mathbf{jobz}}=\text{'N'}$, z is not referenced.
6:     jfail( : $:$) – int64int32nag_int array
Note: the dimension of the array jfail must be at least max (1,n)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
If jobz = 'V'${\mathbf{jobz}}=\text{'V'}$, then
• if ${\mathbf{INFO}}={\mathbf{0}}$, the first m elements of jfail are zero;
• if ${\mathbf{INFO}}>{\mathbf{0}}$, jfail contains the indices of the eigenvectors that failed to converge.
If jobz = 'N'${\mathbf{jobz}}=\text{'N'}$, jfail is not referenced.
7:     info – int64int32nag_int scalar
info = 0${\mathbf{info}}=0$ unless the function detects an error (see Section [Error Indicators and Warnings]).

## Error Indicators and Warnings

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

info = i${\mathbf{info}}=-i$
If info = i${\mathbf{info}}=-i$, parameter i$i$ had an illegal value on entry. The parameters are numbered as follows:
1: jobz, 2: range, 3: n, 4: d, 5: e, 6: vl, 7: vu, 8: il, 9: iu, 10: abstol, 11: m, 12: w, 13: z, 14: ldz, 15: work, 16: iwork, 17: jfail, 18: info.
It is possible that info refers to a parameter that is omitted from the MATLAB interface. This usually indicates that an error in one of the other input parameters has caused an incorrect value to be inferred.
W INFO > 0${\mathbf{INFO}}>0$
If info = i${\mathbf{info}}=i$, then i$i$ eigenvectors failed to converge. Their indices are stored in array jfail. Please see abstol.

## Accuracy

The computed eigenvalues and eigenvectors are exact for a nearby matrix (A + E)$\left(A+E\right)$, where
 ‖E‖2 = O(ε) ‖A‖2 , $‖E‖2 = O(ε) ‖A‖2 ,$
and ε$\epsilon$ is the machine precision. See Section 4.7 of Anderson et al. (1999) for further details.

The total number of floating point operations is proportional to n2${n}^{2}$ if jobz = 'N'${\mathbf{jobz}}=\text{'N'}$ and is proportional to n3${n}^{3}$ if jobz = 'V'${\mathbf{jobz}}=\text{'V'}$ and range = 'A'${\mathbf{range}}=\text{'A'}$, otherwise the number of floating point operations will depend upon the number of computed eigenvectors.

## Example

```function nag_lapack_dstevx_example
jobz = 'Vectors';
range = 'Values in range';
d = [1;
4;
9;
16];
e = [1;
2;
3];
vl = 0;
vu = 5;
il = int64(0);
iu = int64(0);
abstol = 2*nag_machine_real_safe;
[dOut, eOut, m, w, z, jfail, info] = nag_lapack_dstevx(jobz, range, d, e, vl, vu, il, iu, abstol)
```
```

dOut =

1
4
9
16

eOut =

1
2
3

m =

2

w =

0.6476
3.5470
0
0

z =

0.9396    0.3388
-0.3311    0.8628
0.0853   -0.3648
-0.0167    0.0879

jfail =

0
0
0
0

info =

0

```
```function f08jb_example
jobz = 'Vectors';
range = 'Values in range';
d = [1;
4;
9;
16];
e = [1;
2;
3];
vl = 0;
vu = 5;
il = int64(0);
iu = int64(0);
abstol = 2*x02am;
[dOut, eOut, m, w, z, jfail, info] = f08jb(jobz, range, d, e, vl, vu, il, iu, abstol)
```
```

dOut =

1
4
9
16

eOut =

1
2
3

m =

2

w =

0.6476
3.5470
0
0

z =

0.9396    0.3388
-0.3311    0.8628
0.0853   -0.3648
-0.0167    0.0879

jfail =

0
0
0
0

info =

0

```