naginterfaces.library.lapackeig.ztgevc

naginterfaces.library.lapackeig.ztgevc(side, howmny, a, b, select=None, vl=None, vr=None)

ztgevc computes some or all of the right and/or left generalized eigenvectors of a pair of complex upper triangular matrices $(A,B)$.

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

https://www.nag.com/numeric/nl/nagdoc_29.3/flhtml/f08/f08yxf.html

Parameters

sidestr, length 1

Specifies the required sets of generalized eigenvectors.

$side=\text{'R'}$

Only right eigenvectors are computed.

$side=\text{'L'}$

Only left eigenvectors are computed.

$side=\text{'B'}$

Both left and right eigenvectors are computed.

howmnystr, length 1

Specifies further details of the required generalized eigenvectors.

$howmny=\text{'A'}$

All right and/or left eigenvectors are computed.

$howmny=\text{'B'}$

All right and/or left eigenvectors are computed; they are backtransformed using the input matrices supplied in arrays $vr$ and/or $vl$.

$howmny=\text{'S'}$

Selected right and/or left eigenvectors, defined by the array $select$, are computed.

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

The matrix $A$ must be in upper triangular form. Usually, this is the matrix $A$ returned by zhgeqz().

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

The matrix $B$ must be in upper triangular form with non-negative real diagonal elements. Usually, this is the matrix $B$ returned by zhgeqz().

selectNone or bool, array-like, shape $(:)$, optional

Note: the required length for this argument is determined as follows: if $howmny=\text{'S'}$: $n$; otherwise: $1$.

Specifies the eigenvectors to be computed if $howmny=\text{'S'}$. To select the generalized eigenvector corresponding to the $j$th generalized eigenvalue, the $j$th element of $select$ should be set to $True$.

vlNone or complex, array-like, shape $(:,:)$, optional

Note: the required extent for this argument in dimension 1 is determined as follows: if $side\text{in}(\text{'L'},\text{'B'})$: $n$; if $side=\text{'R'}$: $1$; otherwise: $0$.

Note: the required extent for this argument in dimension 2 is determined as follows: if $side\text{in}(\text{'L'},\text{'B'})$: $\text{mm}$; if $side=\text{'R'}$: $1$; otherwise: $0$.

If $howmny=\text{'B'}$ and $side=\text{'L'}$ or $\text{'B'}$, $vl$ must be initialized to an $n\times n$ matrix $Q$. Usually, this is the unitary matrix $Q$ of left Schur vectors returned by zhgeqz().

vrNone or complex, array-like, shape $(:,:)$, optional

Note: the required extent for this argument in dimension 1 is determined as follows: if $side\text{in}(\text{'R'},\text{'B'})$: $n$; if $side=\text{'L'}$: $1$; otherwise: $0$.

Note: the required extent for this argument in dimension 2 is determined as follows: if $side\text{in}(\text{'R'},\text{'B'})$: $\text{mm}$; if $side=\text{'L'}$: $1$; otherwise: $0$.

If $howmny=\text{'B'}$ and $side=\text{'R'}$ or $\text{'B'}$, $vr$ must be initialized to an $n\times n$ matrix $Z$. Usually, this is the unitary matrix $Z$ of right Schur vectors returned by dhgeqz().

Returns

vlNone or complex, ndarray, shape $(:,:)$

If $side=\text{'L'}$ or $\text{'B'}$, $vl$ contains:

if $howmny=\text{'A'}$, the matrix $Y$ of left eigenvectors of $(A,B)$;

if $howmny=\text{'B'}$, the matrix $QY$;

if $howmny=\text{'S'}$, the left eigenvectors of $(A,B)$ specified by $select$, stored consecutively in the columns of the array $vl$, in the same order as their corresponding eigenvalues.

vrNone or complex, ndarray, shape $(:,:)$

If $side=\text{'R'}$ or $\text{'B'}$, $vr$ contains:

if $howmny=\text{'A'}$, the matrix $X$ of right eigenvectors of $(A,B)$;

if $howmny=\text{'B'}$, the matrix $ZX$;

if $howmny=\text{'S'}$, the right eigenvectors of $(A,B)$ specified by $select$, stored consecutively in the columns of the array $vr$, in the same order as their corresponding eigenvalues.

mint

The number of columns in the arrays $vl$ and/or $vr$ actually used to store the eigenvectors. If $howmny=\text{'A'}$ or $\text{'B'}$, $m$ is set to $\text{n}$. Each selected eigenvector occupies one column.

Raises

NagValueError

(errno $-1$)

On entry, error in parameter $side$.

Constraint: $side=\text{'B'}$, $\text{'L'}$ or $\text{'R'}$.

(errno $-2$)

On entry, error in parameter $howmny$.

Constraint: $howmny=\text{'A'}$, $\text{'B'}$ or $\text{'S'}$.

(errno $-3$)

On entry, error in parameter $select$.

Constraint: $select\left[\text{j}\right]=True$ or $False$, for $\text{j}=0,\dots ,n-1$.

(errno $-4$)

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

Constraint: $n\ge 0$.

(errno $-7$)

On entry, error in parameter $b$.

(errno $-13$)

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

Notes

ztgevc computes some or all of the right and/or left generalized eigenvectors of the matrix pair $(A,B)$ which is assumed to be in upper triangular form. If the matrix pair $(A,B)$ is not upper triangular then the function zhgeqz() should be called before invoking ztgevc.

The right generalized eigenvector $x$ and the left generalized eigenvector $y$ of $(A,B)$ corresponding to a generalized eigenvalue $\lambda$ are defined by

$$(A-\lambda B)x=0$$

and

$$y^H(A-\lambda B)=0\text{.}$$

If a generalized eigenvalue is determined as $0/0$, which is due to zero diagonal elements at the same locations in both $A$ and $B$, a unit vector is returned as the corresponding eigenvector.

Note that the generalized eigenvalues are computed using zhgeqz() but ztgevc does not explicitly require the generalized eigenvalues to compute eigenvectors. The ordering of the eigenvectors is based on the ordering of the eigenvalues as computed by ztgevc.

If all eigenvectors are requested, the function may either return the matrices $X$ and/or $Y$ of right or left eigenvectors of $(A,B)$, or the products $ZX$ and/or $QY$, where $Z$ and $Q$ are two matrices supplied by you. Usually, $Q$ and $Z$ are chosen as the unitary matrices returned by zhgeqz(). Equivalently, $Q$ and $Z$ are the left and right Schur vectors of the matrix pair supplied to zhgeqz(). In that case, $QY$ and $ZX$ are the left and right generalized eigenvectors, respectively, of the matrix pair supplied to zhgeqz().

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

Golub, G H and Van Loan, C F, 1996, Matrix Computations, (3rd Edition), Johns Hopkins University Press, Baltimore

Moler, C B and Stewart, G W, 1973, An algorithm for generalized matrix eigenproblems, SIAM J. Numer. Anal. (10), 241–256

Stewart, G W and Sun, J-G, 1990, Matrix Perturbation Theory, Academic Press, London