f16 Chapter Contents
f16 Chapter Introduction
NAG Library Manual

NAG Library Function Documentnag_zamin_val (f16jtc)

1  Purpose

nag_zamin_val (f16jtc) computes, with respect to absolute value, the smallest component of a complex vector, along with the index of that component.

2  Specification

 #include #include
 void nag_zamin_val (Integer n, const Complex x[], Integer incx, Integer *k, double *r, NagError *fail)

3  Description

nag_zamin_val (f16jtc) computes, with respect to absolute value, the smallest component, $r$, of an $n$-element complex vector $x$, and determines the smallest index, $k$, such that
 $r=Re⁡xk+Im⁡xk=minjRe⁡xj+Im⁡xj.$

4  References

Basic Linear Algebra Subprograms Technical (BLAST) Forum (2001) Basic Linear Algebra Subprograms Technical (BLAST) Forum Standard University of Tennessee, Knoxville, Tennessee http://www.netlib.org/blas/blast-forum/blas-report.pdf

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 $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,1+\left({\mathbf{n}}-1\right)×\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)×{\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)×\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 smallest 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 smallest 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 2.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.
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_INTERNAL_ERROR
An unexpected error has been triggered by this function. Please contact NAG.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
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

The BLAS standard requires accurate implementations which avoid unnecessary over/underflow (see Section 2.7 of Basic Linear Algebra Subprograms Technical (BLAST) Forum (2001)).

8  Parallelism and Performance

nag_zamin_val (f16jtc) is not threaded in any implementation.

None.

10  Example

This example computes the smallest component with respect to absolute value and index of that component for the vector
 $x= -4+2.1i,3.7+4.5i,-6+1.2iT .$

10.1  Program Text

Program Text (f16jtce.c)

10.2  Program Data

Program Data (f16jtce.d)

10.3  Program Results

Program Results (f16jtce.r)