naginterfaces.library.lapackeig.zggev

naginterfaces.library.lapackeig.zggev(jobvl, jobvr, a, b)

zggev computes for a pair of $n\times n$ complex nonsymmetric matrices $(A,B)$ the generalized eigenvalues and, optionally, the left and/or right generalized eigenvectors using the $QZ$ algorithm. zggev is marked as deprecated by LAPACK; the replacement routine is zggev3() which makes better use of Level 3 BLAS.

Deprecated since version 27.0.0.0: zggev is deprecated. Please use zggev3() instead. See also the Replacement Calls document.

For full information please refer to the NAG Library document for f08wn

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/f08/f08wnf.html

Parameters

jobvlstr, length 1

If $jobvl=\text{'N'}$, do not compute the left generalized eigenvectors.

If $jobvl=\text{'V'}$, compute the left generalized eigenvectors.

jobvrstr, length 1

If $jobvr=\text{'N'}$, do not compute the right generalized eigenvectors.

If $jobvr=\text{'V'}$, compute the right generalized eigenvectors.

acomplex, array-like, shape $(n,n)$

The matrix $A$ in the pair $(A,B)$.

bcomplex, array-like, shape $(n,n)$

The matrix $B$ in the pair $(A,B)$.

Returns

acomplex, ndarray, shape $(n,n)$

$a$ has been overwritten.

bcomplex, ndarray, shape $(n,n)$

$b$ has been overwritten.

alphacomplex, ndarray, shape $\left(n\right)$

See the description of $beta$.

betacomplex, ndarray, shape $\left(n\right)$

$alpha[\text{j}-1]/beta[\text{j}-1]$, for $\text{j}=1,2,\dots ,n$, will be the generalized eigenvalues.

Note: the quotients $alpha[j-1]/beta[j-1]$ may easily overflow or underflow, and $beta[j-1]$ may even be zero.

Thus, you should avoid naively computing the ratio ${\alpha }_j/{\beta }_j$.

However, $max\left(\left|{\alpha }_j\right|\right)$ will always be less than and usually comparable with ${\parallel A\parallel }_2$ in magnitude, and $max\left(\left|{\beta }_j\right|\right)$ will always be less than and usually comparable with ${\parallel B\parallel }_2$.

vlcomplex, ndarray, shape $(:,:)$

If $jobvl=\text{'V'}$, the left generalized eigenvectors $u_j$ are stored one after another in the columns of $vl$, in the same order as the corresponding eigenvalues. Each eigenvector will be scaled so the largest component will have $\left|\text{real part}\right|+\left|\text{imag. part}\right|=1$.

If $jobvl=\text{'N'}$, $vl$ is not referenced.

vrcomplex, ndarray, shape $(:,:)$

If $jobvr=\text{'V'}$, the right generalized eigenvectors $v_j$ are stored one after another in the columns of $vr$, in the same order as the corresponding eigenvalues. Each eigenvector will be scaled so the largest component will have $\left|\text{real part}\right|+\left|\text{imag. part}\right|=1$.

If $jobvr=\text{'N'}$, $vr$ is not referenced.

Raises

NagValueError

(errno $-1$)

On entry, error in parameter $jobvl$.

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

(errno $-2$)

On entry, error in parameter $jobvr$.

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

(errno $-3$)

On entry, error in parameter $\text{n}$.

Constraint: $n\ge 0$.

(errno $n+1$)

The $QZ$ iteration failed with an unexpected error, please contact NAG.

(errno $n+2$)

A failure occurred in ztgevc() while computing generalized eigenvectors.

Warns

NagAlgorithmicWarning

(errno $(i>0)\text{and}(i\le n)$)

The $QZ$ iteration failed. No eigenvectors have been calculated but $alpha$ and $beta$ should be correct from element $⟨value⟩$.

Notes

A generalized eigenvalue for a pair of matrices $(A,B)$ is a scalar $\lambda$ or a ratio $\alpha /\beta =\lambda$, such that $A-\lambda B$ is singular. It is usually represented as the pair $(\alpha ,\beta )$, as there is a reasonable interpretation for $\beta =0$, and even for both being zero.

The right generalized eigenvector $v_j$ corresponding to the generalized eigenvalue ${\lambda }_j$ of $(A,B)$ satisfies

$$A{v}_j={\lambda }_{j}B{v}_j\text{.}$$

The left generalized eigenvector $u_j$ corresponding to the generalized eigenvalue ${\lambda }_j$ of $(A,B)$ satisfies

$$u_j^{H}A={\lambda }_j{u}_j^{H}B\text{,}$$

where $u_j^H$ is the conjugate-transpose of $u_j$.

All the eigenvalues and, if required, all the eigenvectors of the complex generalized eigenproblem $Ax=\lambda Bx$, where $A$ and $B$ are complex, square matrices, are determined using the $QZ$ algorithm. The complex $QZ$ algorithm consists of three stages:

1. $A$ is reduced to upper Hessenberg form (with real, non-negative subdiagonal elements) and at the same time $B$ is reduced to upper triangular form.

2. $A$ is further reduced to triangular form while the triangular form of $B$ is maintained and the diagonal elements of $B$ are made real and non-negative. This is the generalized Schur form of the pair $(A,B)$.

   This function does not actually produce the eigenvalues ${\lambda }_j$, but instead returns ${\alpha }_j$ and ${\beta }_j$ such that

   $${\lambda }_j={\alpha }_j/{\beta }_j\text{,}j=1,2,\dots ,n\text{.}$$

   The division by ${\beta }_j$ becomes your responsibility, since ${\beta }_j$ may be zero, indicating an infinite eigenvalue.

3. If the eigenvectors are required they are obtained from the triangular matrices and then transformed back into the original coordinate system.

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, https://www.netlib.org/lapack/lug

Golub, G H and Van Loan, C F, 2012, Matrix Computations, (4th Edition), Johns Hopkins University Press, Baltimore

Wilkinson, J H, 1979, Kronecker’s canonical form and the $QZ$ algorithm, Linear Algebra Appl. (28), 285–303