xref: /minix3/lib/libc/stdlib/lsearch.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\" Copyright (c) 1989, 1991, 1993
2*2fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
3*2fe8fb19SBen Gras.\"
4*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
5*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
6*2fe8fb19SBen Gras.\" are met:
7*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
8*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
9*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
10*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
11*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
12*2fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
13*2fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
14*2fe8fb19SBen Gras.\"    without specific prior written permission.
15*2fe8fb19SBen Gras.\"
16*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*2fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*2fe8fb19SBen Gras.\" SUCH DAMAGE.
27*2fe8fb19SBen Gras.\"
28*2fe8fb19SBen Gras.\"     from: @(#)lsearch.3	8.1 (Berkeley) 6/4/93
29*2fe8fb19SBen Gras.\"	$NetBSD: lsearch.3,v 1.3 2005/07/12 08:28:42 wiz Exp $
30*2fe8fb19SBen Gras.\"
31*2fe8fb19SBen Gras.Dd July 6, 2005
32*2fe8fb19SBen Gras.Dt LSEARCH 3
33*2fe8fb19SBen Gras.Os
34*2fe8fb19SBen Gras.Sh NAME
35*2fe8fb19SBen Gras.Nm lsearch ,
36*2fe8fb19SBen Gras.Nm lfind
37*2fe8fb19SBen Gras.Nd linear searching routines
38*2fe8fb19SBen Gras.Sh LIBRARY
39*2fe8fb19SBen Gras.Lb libc
40*2fe8fb19SBen Gras.Sh SYNOPSIS
41*2fe8fb19SBen Gras.In search.h
42*2fe8fb19SBen Gras.Ft void *
43*2fe8fb19SBen Gras.Fn lsearch "const void *key" "void *base" "size_t *nelp" "size_t width" "int (*compar)(const void *, const void *)"
44*2fe8fb19SBen Gras.Ft void *
45*2fe8fb19SBen Gras.Fn lfind "const void *key" "const void *base" "size_t *nelp" "size_t width" "int (*compar)(const void *, const void *)"
46*2fe8fb19SBen Gras.Sh DESCRIPTION
47*2fe8fb19SBen GrasThe functions
48*2fe8fb19SBen Gras.Fn lsearch ,
49*2fe8fb19SBen Grasand
50*2fe8fb19SBen Gras.Fn lfind
51*2fe8fb19SBen Grasprovide basic linear searching functionality.
52*2fe8fb19SBen Gras.Pp
53*2fe8fb19SBen Gras.Fa base
54*2fe8fb19SBen Grasis the pointer to the beginning of an array.
55*2fe8fb19SBen GrasThe argument
56*2fe8fb19SBen Gras.Fa nelp
57*2fe8fb19SBen Grasis the current number of elements in the array, where each element
58*2fe8fb19SBen Grasis
59*2fe8fb19SBen Gras.Fa width
60*2fe8fb19SBen Grasbytes long.
61*2fe8fb19SBen GrasThe
62*2fe8fb19SBen Gras.Fa compar
63*2fe8fb19SBen Grasargument points to a function which compares its two arguments and returns
64*2fe8fb19SBen Graszero if they are matching, and non-zero otherwise.
65*2fe8fb19SBen Gras.Pp
66*2fe8fb19SBen GrasThe
67*2fe8fb19SBen Gras.Fn lsearch
68*2fe8fb19SBen Grasand
69*2fe8fb19SBen Gras.Fn lfind
70*2fe8fb19SBen Grasfunctions
71*2fe8fb19SBen Grasreturn a pointer into the array referenced by
72*2fe8fb19SBen Gras.Fa base
73*2fe8fb19SBen Graswhere
74*2fe8fb19SBen Gras.Fa key
75*2fe8fb19SBen Grasis located.
76*2fe8fb19SBen GrasIf
77*2fe8fb19SBen Gras.Fa key
78*2fe8fb19SBen Grasdoes not exist,
79*2fe8fb19SBen Gras.Fn lfind
80*2fe8fb19SBen Graswill return a null pointer and
81*2fe8fb19SBen Gras.Fn lsearch
82*2fe8fb19SBen Graswill add it to the array.
83*2fe8fb19SBen GrasWhen an element is added to the array by
84*2fe8fb19SBen Gras.Fn lsearch
85*2fe8fb19SBen Grasthe location referenced by the argument
86*2fe8fb19SBen Gras.Fa nelp
87*2fe8fb19SBen Grasis incremented by one.
88*2fe8fb19SBen Gras.Sh SEE ALSO
89*2fe8fb19SBen Gras.Xr bsearch 3 ,
90*2fe8fb19SBen Gras.Xr db 3
91*2fe8fb19SBen Gras.Sh STANDARDS
92*2fe8fb19SBen GrasThe
93*2fe8fb19SBen Gras.Fn lsearch
94*2fe8fb19SBen Grasand
95*2fe8fb19SBen Gras.Fn lfind
96*2fe8fb19SBen Grasfunctions conform to
97*2fe8fb19SBen Gras.St -p1003.1-2001 .
98