NAG C Library Function Document

nag_zamax_val (f16jsc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{n}$ – IntegerInput

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

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

2:    $\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.

3:    $\mathbf{incx}$ – IntegerInput

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

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

4:    $\mathbf{k}$ – Integer *Output

On exit: $k$, the index, from the set $\left\{0,1,\dots ,\mathbf{n}-1\right\}$, of the largest component of $x$ with respect to absolute value. If $\mathbf{n}=0$ on input then k is returned as $-1$.

5:    $\mathbf{r}$ – double *Output

On exit: $r$, the largest component of $x$ with respect to absolute value. If $\mathbf{n}=0$ on input then r is returned as $0.0$.

6:    $\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{incx}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{incx}\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 (f16jsce.c)

10.2

Program Data

Program Data (f16jsce.d)

10.3

Program Results

Program Results (f16jsce.r)