NAG C Library Function Document

nag_zwaxpby (f16ghc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{n}$ – IntegerInput

On entry: $n$, the number of elements in $x$, $y$ and $w$.

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

2:    $\mathbf{alpha}$ – ComplexInput

On entry: the scalar $\alpha$.

3:    $\mathbf{x}\left[\mathit{dim}\right]$ – const ComplexInput

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

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

If $\mathbf{incx}>0$, $x_{\mathit{i}}$ must be stored in $\mathbf{x}\left[\left(\mathit{i}-1\right)\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[\left(\mathbf{n}-\mathit{i}\right)\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.

4:    $\mathbf{incx}$ – IntegerInput

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

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

5:    $\mathbf{beta}$ – ComplexInput

On entry: the scalar $\beta$.

6:    $\mathbf{y}\left[\mathit{dim}\right]$ – const ComplexInput

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

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

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

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

7:    $\mathbf{incy}$ – IntegerInput

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

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

8:    $\mathbf{w}\left[\mathit{dim}\right]$ – ComplexInput/Output

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

On entry: if $\left|\mathbf{incw}\right|\ne 1$, intermediate elements of w may contain values and will not be referenced; the other elements will be overwritten and need not be set.

On exit: the elements $w_i$ of the vector $w$ will be stored in w as follows.

If $\mathbf{incw}>0$, $w_i$ is in $\mathbf{w}\left[\left(\mathit{i}-1\right)\times \mathbf{incw}\right]$, for $\mathit{i}=1,2,\dots ,\mathbf{n}$.

If $\mathbf{incw}<0$, $w_i$ is in $\mathbf{w}\left[\left(\mathbf{n}-\mathit{i}\right)\times \left|\mathbf{incw}\right|\right]$, for $\mathit{i}=1,2,\dots ,\mathbf{n}$.

Intermediate elements of w are not referenced.

9:    $\mathbf{incw}$ – IntegerInput

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

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

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

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_INT

On entry, $\mathbf{incw}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{incw}\ne 0$.

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{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f16ghce.c)

10.2

Program Data

Program Data (f16ghce.d)

10.3

Program Results

Program Results (f16ghce.r)