NAG Library Routine Document

m01nbf  (intvec_search)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{valid}$ – LogicalInput

On entry: if valid is set to .TRUE. argument checking will be performed. If valid is set to .FALSE. m01nbf will be called without argument checking (which includes checking that array iv is sorted in ascending order) and the routine will return with $\mathbf{ifail}=\mathbf{0}$. See Section 9 for further details.

2:     $\mathbf{iv}\left(\mathbf{m2}\right)$ – Integer arrayInput

On entry: elements m1 to m2 contain integer values to be searched.

Constraint: elements m1 to m2 of iv must be sorted in ascending order.

3:     $\mathbf{m1}$ – IntegerInput

On entry: the index of the first element of iv to be searched.

Constraint: $\mathbf{m1}\ge 1$.

4:     $\mathbf{m2}$ – IntegerInput

On entry: the index of the last element of iv to be searched.

Constraint: $\mathbf{m2}\ge \mathbf{m1}$.

5:     $\mathbf{item}$ – IntegerInput

On entry: the sought-after item.

6:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of ifail on exit.

On exit: $\mathbf{ifail}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

$\mathbf{ifail}=2$

On entry, iv must be sorted in ascending order: $\mathbf{iv}\text{ element }〈\mathit{\text{value}}〉>\text{ element }〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=3$

On entry, $\mathbf{m1}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m1}\ge 1$.

$\mathbf{ifail}=4$

On entry, $\mathbf{m1}=〈\mathit{\text{value}}〉$, $\mathbf{m2}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m1}\le \mathbf{m2}$.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 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 (m01nbfe.f90)

10.2

Program Data

Program Data (m01nbfe.d)

10.3

Program Results

Program Results (m01nbfe.r)