NAG CL Interface
f16spc (zher)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{order}$ – Nag_OrderType Input

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.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.

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

2: $\mathbf{uplo}$ – Nag_UploType Input

On entry: specifies 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}$.

3: $\mathbf{n}$ – Integer Input

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

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

4: $\mathbf{alpha}$ – double Input

On entry: the scalar $\alpha$.

5: $\mathbf{x}\left[\mathit{dim}\right]$ – const Complex Input

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

On entry: the $n$-element vector $x$.

If $\mathbf{incx}>0$, $x_{\mathit{i}}$ must be stored in $\mathbf{x}\left[(\mathit{i}-1)\times \mathbf{incx}\right]$, for $\mathit{i}=1,2,\dots ,\mathbf{n}$.

If $\mathbf{incx}<0$, $x_{\mathit{i}}$ must be stored in $\mathbf{x}\left[(\mathbf{n}-\mathit{i})\times \left|\mathbf{incx}\right|\right]$, for $\mathit{i}=1,2,\dots ,\mathbf{n}$.

Intermediate elements of x are not referenced. If $\mathbf{n}=0$, x is not referenced and may be NULL.

6: $\mathbf{incx}$ – Integer Input

On entry: the increment in the subscripts of x between successive elements of $x$.

Constraint: $\mathbf{incx}\ne 0$.

7: $\mathbf{beta}$ – double Input

On entry: the scalar $\beta$.

8: $\mathbf{a}\left[\mathit{dim}\right]$ – Complex Input/Output

Note: the dimension, dim, of the array a must be at least $\max (1,\mathbf{pda}\times \mathbf{n})$.

On entry: the $n\times n$ Hermitian matrix $A$.

If $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $A_{ij}$ is stored in $\mathbf{a}\left[(j-1)\times \mathbf{pda}+i-1\right]$.

If $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $A_{ij}$ is stored in $\mathbf{a}\left[(i-1)\times \mathbf{pda}+j-1\right]$.

If $\mathbf{uplo}=\mathrm{Nag\_Upper}$, the upper triangular part of $A$ must be stored and the elements of the array below the diagonal are not referenced.

If $\mathbf{uplo}=\mathrm{Nag\_Lower}$, the lower triangular part of $A$ must be stored and the elements of the array above the diagonal are not referenced.

On exit: the updated matrix $A$. The imaginary parts of the diagonal elements are set to zero.

9: $\mathbf{pda}$ – Integer Input

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

Constraint: $\mathbf{pda}\ge \max (1,\mathbf{n})$.

10: $\mathbf{fail}$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.

NE_BAD_PARAM

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

NE_INT

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

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

NE_INT_2

On entry, $\mathbf{pda}=⟨\mathit{\text{value}}⟩$, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pda}\ge \max (1,\mathbf{n})$.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results