NAG Library Routine Document

M01NAF

M01NAF is based on Professor Niklaus Wirth's implementation of the Binary Search algorithm (see Wirth (2004)), but with two modifications. First, if the sought-after item is less than the value of the first element of the array to be searched,

0

is returned. Second, if a value equal to the sought-after item is not found, the index of the immediate lower value is returned.

4 References

Wirth N (2004) Algorithms and Data Structures 35–36 Prentice Hall

5 Parameters

1: $VALID$ – LOGICALInput: On entry: if VALID is set to .TRUE. parameter checking will be performed. If VALID is set to .FALSE. M01NAF will be called without parameter checking (which includes checking that array RV is sorted in ascending order) and the routine will return with $IFAIL = 0$ . See Section 9 for further details.
2: $RV (M2)$ – REAL (KIND=nag_wp) arrayInput: On entry: elements M1 to M2 contain real values to be searched.

Constraint: elements M1 to M2 of RV must be sorted in ascending order.
3: $M1$ – INTEGERInput: On entry: the index of the first element of RV to be searched.

Constraint: $M1 \geq 1$ .
4: $M2$ – INTEGERInput: On entry: the index of the last element of RV to be searched.

Constraint: $M2 \geq M1$ .
5: $ITEM$ – REAL (KIND=nag_wp)Input: On entry: the sought-after item.
6: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 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 parameter, the recommended value is $0$ . When the value $- 1 or 1$ is used it is essential to test the value of IFAIL on exit.

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

6 Error Indicators and Warnings

If on entry

IFAIL = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by X04AAF).

Errors or warnings detected by the routine:

(Note: these errors will only be returned if

VALID = .TRUE.

$IFAIL = 2$: On entry, RV must be sorted in ascending order: $RV element 〈value〉 > element 〈value〉$ .

$IFAIL = 3$: On entry, $M1 = 〈value〉$ .
Constraint: $M1 \geq 1$ .

$IFAIL = 4$: On entry, $M1 = 〈value〉$ , $M2 = 〈value〉$ .
Constraint: $M1 \leq M2$ .

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Not applicable.

9 Further Comments

The argument VALID should be used with caution. Set it to .FALSE. only if you are confident that the other arguments are correct, in particular that array RV is in fact arranged in ascending order. If you wish to search the same array RV many times, you are recommended to set VALID to .TRUE. on first call of M01NAF and to .FALSE. on subsequent calls, in order to minimize the amount of time spent checking RV, which may be significant if RV is large.

The time taken by M01NAF is

O (\log (n))

, where

n = M2 - M1 + 1

, when

VALID = .FALSE.

10 Example

This example reads a list of double precision numbers and sought-after items and performs the search for these items.

NAG Library Routine DocumentM01NAF

▸▿ Contents

1 Purpose

2 Specification

3 Description