NAG CL Interface
f16smc (zger)

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{conj}$ – Nag_ConjType Input

On entry: the argument conj specifies whether the elements $y_i$ are used unconjugated or conjugated, as follows:

$\mathbf{conj}=\mathrm{Nag\_NoConj}$

The elements $y_i$ are not conjugated.

$\mathbf{conj}=\mathrm{Nag\_Conj}$

The complex conjugate of the elements $y_i$ are used.

Constraint: $\mathbf{conj}=\mathrm{Nag\_NoConj}$ or $\mathrm{Nag\_Conj}$.

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

On entry: $m$, the number of rows of the matrix $A$.

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

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

On entry: $n$, the number of columns of the matrix $A$.

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

5: $\mathbf{alpha}$ – Complex Input

On entry: the scalar $\alpha$.

6: $\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{m}$.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

10: $\mathbf{beta}$ – Complex Input

On entry: the scalar $\beta$.

11: $\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})$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\max (1,\mathbf{m}\times \mathbf{pda})$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

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]$.

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

On exit: the updated matrix $A$.

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

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

Constraints:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $\mathbf{pda}\ge \max (1,\mathbf{m})$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $\mathbf{pda}\ge \mathbf{n}$.

13: $\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{incy}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{incy}\ne 0$.

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

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

NE_INT_2

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

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

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.

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