NAG Library Function Document

nag_search_char (m01ncc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:    $\mathbf{validate}$ – Nag_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 $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR. See Section 9 for further details.

2:    $\mathbf{ch}\left[\mathbf{m2}+1\right]$ – 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:    $\mathbf{m1}$ – IntegerInput

On entry: the index of the first element of ch to be searched.

Constraint: $\mathbf{m1}\ge 0$.

4:    $\mathbf{m2}$ – IntegerInput

On entry: the index of the last element of ch to be searched.

Constraint: $\mathbf{m2}\ge \mathbf{m1}$.

5:    $\mathbf{item}$ – const char *Input

On entry: the sought-after item. Trailing space characters are ignored.

6:    $\mathbf{fail}$ – NagError *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.
See Section 3.2.1.2 in the Essential Introduction for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{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 $=〈\mathit{\text{value}}〉$.

NE_INT

On entry, $\mathbf{m1}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m1}\ge 0$.

NE_INT_2

On entry, $\mathbf{m1}=〈\mathit{\text{value}}〉$ and $\mathbf{m2}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m2}\ge \mathbf{m1}$.

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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.

NE_NOT_INCREASING

On entry, ch must be sorted in ascending order: $\mathbf{ch}\text{ element }〈\mathit{\text{value}}〉>\text{ element }〈\mathit{\text{value}}〉$.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (m01ncce.c)

10.2  Program Data

Program Data (m01ncce.d)

10.3  Program Results

Program Results (m01ncce.r)