NAG FL Interface
m01nbf (intvec_​search)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

m01nbf searches an ordered vector of integer numbers and returns the index of the first value equal to the sought-after item.

2 Specification

Fortran Interface
Function m01nbf ( valid, iv, m1, m2, item, ifail)
Integer :: m01nbf
Integer, Intent (In) :: iv(m2), m1, m2, item
Integer, Intent (Inout) :: ifail
Logical, Intent (In) :: valid
C Header Interface
#include <nag.h>
Integer  m01nbf_ (const logical *valid, const Integer iv[], const Integer *m1, const Integer *m2, const Integer *item, Integer *ifail)
The routine may be called by the names m01nbf or nagf_sort_intvec_search.

3 Description

m01nbf 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 Arguments

1: valid Logical Input
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 ifail=0. See Section 9 for further details.
2: iv(m2) Integer array Input
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: m1 Integer Input
On entry: the index of the first element of iv to be searched.
Constraint: m11.
4: m2 Integer Input
On entry: the index of the last element of iv to be searched.
Constraint: m2m1.
5: item Integer Input
On entry: the sought-after item.
6: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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 or −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..).
On entry, iv must be sorted in ascending order: iv​ element ​value>​ element ​value.
On entry, m1=value.
Constraint: m11.
On entry, m1=value, m2=value.
Constraint: m1m2.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
m01nbf is not threaded in any implementation.

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 iv is in fact arranged in ascending order. If you wish to search the same array iv many times, you are recommended to set valid to .TRUE. on first call of m01nbf and to .FALSE. on subsequent calls, in order to minimize the amount of time spent checking iv, which may be significant if iv is large.
The time taken by m01nbf is O(log(n)), where n=m2-m1+1, when valid=.FALSE..

10 Example

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

10.1 Program Text

Program Text (m01nbfe.f90)

10.2 Program Data

Program Data (m01nbfe.d)

10.3 Program Results

Program Results (m01nbfe.r)