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

NAG CL Interface
m01nbc (intvec_​search)

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

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2023
Settings help

CL Name Style:


1 Purpose

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

2 Specification

#include <nag.h>
Integer  m01nbc (Nag_Boolean validate, const Integer iv[], Integer m1, Integer m2, Integer item, NagError *fail)
The function may be called by the names: m01nbc, nag_sort_intvec_search or nag_search_int.

3 Description

m01nbc 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, −1 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: validate – Nag_Boolean Input
On entry: if validate is set to Nag_TRUE argument checking will be performed. If validate is set to Nag_FALSE m01nbc will be called without argument checking (which includes checking that array iv is sorted in ascending order) and the function will return with fail.code= NE_NOERROR. See Section 9 for further details.
2: iv[m2+1] – const Integer 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: m1≥0.
4: m2 – Integer Input
On entry: the index of the last element of iv to be searched.
Constraint: m2≥m1.
5: item – Integer Input
On entry: the sought-after item.
6: fail – NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

Note: these errors will only be returned if validate=Nag_TRUE.).
NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument ⟨value⟩ had an illegal value.
NE_INT
On entry, m1=⟨value⟩.
Constraint: m1≥1-1.
NE_INT_2
On entry, m1=⟨value⟩, m2=⟨value⟩.
Constraint: m1≤m2.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_NOT_INCREASING
On entry, iv must be sorted in ascending order: iv​ element ​⟨value⟩>​ element ​⟨value⟩.

7 Accuracy

Not applicable.

8 Parallelism and Performance

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

9 Further Comments

The argument validate should be used with caution. Set it to Nag_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 validate to Nag_TRUE on first call of m01nbc and to Nag_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 m01nbc is O(log(n)), where n=m2-m1+1, when validate=Nag_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 (m01nbce.c)

10.2 Program Data

Program Data (m01nbce.d)

10.3 Program Results

Program Results (m01nbce.r)
NAG Library Manual, Mark 29.2
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01nb:  FL   CL   CPP   AD   PY   MB 
© The Numerical Algorithms Group Ltd. 2023