NAG Library Function Document

nag_dspevd (f08gcc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:     order – Nag_OrderTypeInput

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by $\mathbf{order}=\mathrm{Nag\_RowMajor}$. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.

Constraint: $\mathbf{order}=\mathrm{Nag\_RowMajor}$ or $\mathrm{Nag\_ColMajor}$.

2:     job – Nag_JobTypeInput

On entry: indicates whether eigenvectors are computed.

$\mathbf{job}=\mathrm{Nag\_DoNothing}$

Only eigenvalues are computed.

$\mathbf{job}=\mathrm{Nag\_EigVecs}$

Eigenvalues and eigenvectors are computed.

Constraint: $\mathbf{job}=\mathrm{Nag\_DoNothing}$ or $\mathrm{Nag\_EigVecs}$.

3:     uplo – Nag_UploTypeInput

On entry: indicates whether the upper or lower triangular part of $A$ is stored.

$\mathbf{uplo}=\mathrm{Nag\_Upper}$

The upper triangular part of $A$ is stored.

$\mathbf{uplo}=\mathrm{Nag\_Lower}$

The lower triangular part of $A$ is stored.

Constraint: $\mathbf{uplo}=\mathrm{Nag\_Upper}$ or $\mathrm{Nag\_Lower}$.

4:     n – IntegerInput

On entry: $n$, the order of the matrix $A$.

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

5:     ap[$\mathit{dim}$] – doubleInput/Output

Note: the dimension, dim, of the array ap must be at least $\max \left(1,\mathbf{n}\times \left(\mathbf{n}+1\right)/2\right)$.

On entry: the upper or lower triangle of the $n$ by $n$ symmetric matrix $A$, packed by rows or columns.

The storage of elements $A_{ij}$ depends on the order and uplo arguments as follows:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(j-1\right)\times j/2+i-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(2n-j\right)\times \left(j-1\right)/2+i-1\right]$, for $i\ge j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(2n-i\right)\times \left(i-1\right)/2+j-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(i-1\right)\times i/2+j-1\right]$, for $i\ge j$.

On exit: ap is overwritten by the values generated during the reduction to tridiagonal form. The elements of the diagonal and the off-diagonal of the tridiagonal matrix overwrite the corresponding elements of $A$.

6:     w[$\mathit{dim}$] – doubleOutput

Note: the dimension, dim, of the array w must be at least $\max \left(1,\mathbf{n}\right)$.

On exit: the eigenvalues of the matrix $A$ in ascending order.

7:     z[$\mathit{dim}$] – doubleOutput

Note: the dimension, dim, of the array z must be at least

• $\max \left(1,\mathbf{pdz}\times \mathbf{n}\right)$ when $\mathbf{job}=\mathrm{Nag\_EigVecs}$;
• $1$ when $\mathbf{job}=\mathrm{Nag\_DoNothing}$.

The $\left(i,j\right)$th element of the matrix $Z$ is stored in

• $\mathbf{z}\left[\left(j-1\right)\times \mathbf{pdz}+i-1\right]$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\mathbf{z}\left[\left(i-1\right)\times \mathbf{pdz}+j-1\right]$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

On exit: if $\mathbf{job}=\mathrm{Nag\_EigVecs}$, z is overwritten by the orthogonal matrix $Z$ which contains the eigenvectors of $A$.

If $\mathbf{job}=\mathrm{Nag\_DoNothing}$, z is not referenced.

8:     pdz – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array z.

Constraints:

• if $\mathbf{job}=\mathrm{Nag\_EigVecs}$, $\mathbf{pdz}\ge \max \left(1,\mathbf{n}\right)$;
• if $\mathbf{job}=\mathrm{Nag\_DoNothing}$, $\mathbf{pdz}\ge 1$.

9:     fail – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.

NE_BAD_PARAM

On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_CONVERGENCE

If $\mathbf{fail}\mathbf{.}\mathbf{errnum}=⟨\mathit{\text{value}}⟩$ and $\mathbf{job}=\mathrm{Nag\_DoNothing}$, the algorithm failed to converge; $⟨\mathit{\text{value}}⟩$ elements of an intermediate tridiagonal form did not converge to zero; if $\mathbf{fail}\mathbf{.}\mathbf{errnum}=⟨\mathit{\text{value}}⟩$ and $\mathbf{job}=\mathrm{Nag\_EigVecs}$, then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and column $⟨\mathit{\text{value}}⟩/\left(\mathbf{n}+1\right)$ through $⟨\mathit{\text{value}}⟩\mathrm{ mod }\left(\mathbf{n}+1\right)$.

NE_ENUM_INT_2

On entry, $\mathbf{job}=⟨\mathit{\text{value}}⟩$, $\mathbf{pdz}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: if $\mathbf{job}=\mathrm{Nag\_EigVecs}$, $\mathbf{pdz}\ge \max \left(1,\mathbf{n}\right)$;
if $\mathbf{job}=\mathrm{Nag\_DoNothing}$, $\mathbf{pdz}\ge 1$.

NE_INT

On entry, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{n}\ge 0$.

On entry, $\mathbf{pdz}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdz}>0$.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (f08gcce.c)

10.2  Program Data

Program Data (f08gcce.d)

10.3  Program Results

Program Results (f08gcce.r)