NAG Toolbox: nag_lapack_zhbgst (f08us)

Purpose

Syntax

Description

References

Parameters

Compulsory Input Parameters

1:     $\mathrm{vect}$ – string (length ≥ 1)

Indicates whether $X$ is to be returned.

$\mathbf{vect}=\text{'N'}$

$X$ is not returned.

$\mathbf{vect}=\text{'V'}$

$X$ is returned.

Constraint: $\mathbf{vect}=\text{'N'}$ or $\text{'V'}$.

2:     $\mathrm{uplo}$ – string (length ≥ 1)

Indicates whether the upper or lower triangular part of $A$ is stored.

$\mathbf{uplo}=\text{'U'}$

The upper triangular part of $A$ is stored.

$\mathbf{uplo}=\text{'L'}$

The lower triangular part of $A$ is stored.

Constraint: $\mathbf{uplo}=\text{'U'}$ or $\text{'L'}$.

3:     $\mathrm{ka}$ – int64int32nag_int scalar

If $\mathbf{uplo}=\text{'U'}$, the number of superdiagonals, $k_a$, of the matrix $A$.

If $\mathbf{uplo}=\text{'L'}$, the number of subdiagonals, $k_a$, of the matrix $A$.

Constraint: $\mathbf{ka}\ge 0$.

4:     $\mathrm{kb}$ – int64int32nag_int scalar

If $\mathbf{uplo}=\text{'U'}$, the number of superdiagonals, $k_b$, of the matrix $B$.

If $\mathbf{uplo}=\text{'L'}$, the number of subdiagonals, $k_b$, of the matrix $B$.

Constraint: $\mathbf{ka}\ge \mathbf{kb}\ge 0$.

5:     $\mathrm{ab}\left(\mathit{ldab},:\right)$ – complex array

The first dimension of the array ab must be at least $\mathbf{ka}+1$.

The second dimension of the array ab must be at least $\max \left(1,\mathbf{n}\right)$.

The upper or lower triangle of the $n$ by $n$ Hermitian band matrix $A$.

The matrix is stored in rows $1$ to $k_a+1$, more precisely,

• if $\mathbf{uplo}=\text{'U'}$, the elements of the upper triangle of $A$ within the band must be stored with element $A_{ij}$ in $\mathbf{ab}\left(k_a+1+i-j,j\right)\text{ for }\max \left(1,j-k_a\right)\le i\le j$;
• if $\mathbf{uplo}=\text{'L'}$, the elements of the lower triangle of $A$ within the band must be stored with element $A_{ij}$ in $\mathbf{ab}\left(1+i-j,j\right)\text{ for }j\le i\le \min \left(n,j+k_a\right)\text{.}$

6:     $\mathrm{bb}\left(\mathit{ldbb},:\right)$ – complex array

The first dimension of the array bb must be at least $\mathbf{kb}+1$.

The second dimension of the array bb must be at least $\max \left(1,\mathbf{n}\right)$.

The banded split Cholesky factor of $B$ as specified by uplo, n and kb and returned by nag_lapack_zpbstf (f08ut).

Optional Input Parameters

1:     $\mathrm{n}$ – int64int32nag_int scalar

Default: the second dimension of the arrays ab, bb.

$n$, the order of the matrices $A$ and $B$.

Constraint: $\mathbf{n}\ge 0$.

Output Parameters

1:     $\mathrm{ab}\left(\mathit{ldab},:\right)$ – complex array

The first dimension of the array ab will be $\mathbf{ka}+1$.

The second dimension of the array ab will be $\max \left(1,\mathbf{n}\right)$.

The upper or lower triangle of ab stores the corresponding upper or lower triangle of $C$ as specified by uplo.

2:     $\mathrm{x}\left(\mathit{ldx},:\right)$ – complex array

The first dimension, $\mathit{ldx}$, of the array x will be

• if $\mathbf{vect}=\text{'V'}$, $\mathit{ldx}=\max \left(1,\mathbf{n}\right)$;
• if $\mathbf{vect}=\text{'N'}$, $\mathit{ldx}=1$.

The second dimension of the array x will be $\max \left(1,\mathbf{n}\right)$ if $\mathbf{vect}=\text{'V'}$ and at least $1$ if $\mathbf{vect}=\text{'N'}$.

The $n$ by $n$ matrix $X=S^{-1}Q$, if $\mathbf{vect}=\text{'V'}$.

If $\mathbf{vect}=\text{'N'}$, x is not referenced.

3:     $\mathrm{info}$ – int64int32nag_int scalar

$\mathbf{info}=0$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

   $\mathbf{info}=-i$

If $\mathbf{info}=-i$, parameter $i$ had an illegal value on entry. The parameters are numbered as follows:

1: vect, 2: uplo, 3: n, 4: ka, 5: kb, 6: ab, 7: ldab, 8: bb, 9: ldbb, 10: x, 11: ldx, 12: work, 13: rwork, 14: 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.

Accuracy

Further Comments

Example

Open in the MATLAB editor: f08us_example

function f08us_example


fprintf('f08us example results\n\n');

% Sove Az = lambda Bz
% A and B are the Hermitian banded positive definite matrices:
n = 4;
ka = int64(2); 
a = [ -1.13+0.00i  1.94-2.10i -1.40+0.25i  0.00+0.00i;
       1.94+2.10i -1.91+0.00i -0.82-0.89i -0.67+0.34i;
      -1.40-0.25i -0.82+0.89i -1.87+0.00i -1.10-0.16i;
       0.00+0.00i -0.67-0.34i -1.10+0.16i  0.50+0.00i];

kb = int64(1); 
b = [  9.89+0.00i  1.08-1.73i  0.00+0.00i  0.00+0.00i;
       1.08+1.73i  1.69+0.00i -0.04+0.29i  0.00+0.00i;
       0.00+0.00i -0.04-0.29i  2.65+0.00i -0.33+2.24i;
       0.00+0.00i  0.00+0.00i -0.33-2.24i  2.17+0.00i];

% Convert to general banded format ...
[~, ab, ifail] = f01zd( ...
			'P', ka, ka, a, complex(zeros(ka+ka+1,n)));
[~, bb, ifail] = f01zd(...
		       'P', kb, kb, b, complex(zeros(kb+kb+1,n)));
% ... and chop to give 'Upper' Hermitian banded format
ab = ab(1:ka+1,1:n);
bb = bb(1:kb+1,1:n);

% Factorize B
uplo = 'Upper';
[ub, info] = f08ut( ...
		    uplo, kb, bb);

% Reduce problem to standard form Cy = lambda*y
vect = 'N';
[cb, x, info] = f08us( ...
		       vect, uplo, ka, kb, ab, ub);

% Find eigenvalues lambda
jobz = 'No Vectors';
[~, w, ~, info] = f08hn( ...
			 jobz, uplo, ka, cb);

disp('Eigenvalues:');
disp(w');

f08us example results

Eigenvalues:
   -6.6089   -2.0416    0.1603    1.7712