nag_search_char (m01ncc) (PDF version)
m01 Chapter Contents
m01 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_search_char (m01ncc)

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_search_char (m01ncc) examines an ordered vector of null terminated strings and returns the index of the first value equal to the sought-after item. Character items are compared according to the ASCII collating sequence.

2  Specification

#include <nag.h>
#include <nagm01.h>
Integer  nag_search_char (Nag_Boolean validate, const char *ch[], Integer m1, Integer m2, const char *item, NagError *fail)

3  Description

nag_search_char (m01ncc) 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:     validateNag_BooleanInput
On entry: if validate is set to Nag_TRUE argument checking will be performed. If validate is set to Nag_FALSE nag_search_char (m01ncc) will be called without argument checking, which includes checking that array ch is sorted in ascending order and the function will return with fail.code= NE_NOERROR. See Section 8 for further details.
2:     ch[m2+1]const char *Input
On entry: elements m1 to m2 contain null terminated strings to be searched.
Constraint: elements m1 to m2 of ch must be sorted in ascending order. The length of each element of ch must not exceed 255. Trailing space characters are ignored.
3:     m1IntegerInput
On entry: the index of the first element of ch to be searched.
Constraint: m10.
4:     m2IntegerInput
On entry: the index of the last element of ch to be searched.
Constraint: m2m1.
5:     itemconst char *Input
On entry: the sought-after item. Trailing space characters are ignored.
6:     failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_CHAR_LEN_INVALID
On entry, the length of each element of ch must be at most 255: maximum string length =value.
NE_INT
On entry, m1=value.
Constraint: m10.
NE_INT_2
On entry, m1=value and m2=value.
Constraint: m2m1.
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.
NE_NOT_INCREASING
On entry, ch must be sorted in ascending order: ch​ element ​value>​ element ​value.

7  Accuracy

Not applicable.

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

9  Example

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

9.1  Program Text

Program Text (m01ncce.c)

9.2  Program Data

Program Data (m01ncce.d)

9.3  Program Results

Program Results (m01ncce.r)


nag_search_char (m01ncc) (PDF version)
m01 Chapter Contents
m01 Chapter Introduction
NAG C Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2012