NAG Library Manual, Mark 30.1
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01na:  FL   CL   CPP   AD   PY   MB 

NAG FL Interface
m01naf (realvec_​search)

NAG Library Manual, Mark 30.1
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01na:  FL   CL   CPP   AD   PY   MB 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2024
Settings help

FL Name Style:


FL Specification Language:


1 Purpose

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

2 Specification

Fortran Interface
Function m01naf ( valid, rv, m1, m2, item, ifail)
Integer :: m01naf
Integer, Intent (In) :: m1, m2
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (In) :: rv(m2), item
Logical, Intent (In) :: valid
C Header Interface
#include <nag.h>
Integer  m01naf_ (const logical *valid, const double rv[], const Integer *m1, const Integer *m2, const double *item, Integer *ifail)
The routine may be called by the names m01naf or nagf_sort_realvec_search.

3 Description

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 Arguments

1: valid – Logical Input
On entry: if valid is set to .TRUE. argument checking will be performed. If valid is set to .FALSE. m01naf will be called without argument 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) array Input
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 – Integer Input
On entry: the index of the first element of rv to be searched.
Constraint: m1≥1.
4: m2 – Integer Input
On entry: the index of the last element of rv to be searched.
Constraint: m2≥m1.
5: item – Real (Kind=nag_wp) 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..
ifail=2
On entry, rv must be sorted in ascending order: rv​ element ​⟨value⟩>​ element ​⟨value⟩.
ifail=3
On entry, m1=⟨value⟩.
Constraint: m1≥1.
ifail=4
On entry, m1=⟨value⟩, m2=⟨value⟩.
Constraint: m1≤m2.
ifail=-99
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.
ifail=-399
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.
ifail=-999
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.
m01naf 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 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.

10.1 Program Text

Program Text (m01nafe.f90)

10.2 Program Data

Program Data (m01nafe.d)

10.3 Program Results

Program Results (m01nafe.r)
NAG Library Manual, Mark 30.1
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01na:  FL   CL   CPP   AD   PY   MB 
© The Numerical Algorithms Group Ltd. 2024