diff options
author | deraadt <> | 1995-10-18 08:42:23 +0000 |
---|---|---|
committer | deraadt <> | 1995-10-18 08:42:23 +0000 |
commit | 0527d29da443886d92e9a418180c5b25a5f8d270 (patch) | |
tree | 86b3a64928451a669cefa27900e5884036b4e349 /src/lib/libc/stdlib/bsearch.3 | |
download | openbsd-0527d29da443886d92e9a418180c5b25a5f8d270.tar.gz openbsd-0527d29da443886d92e9a418180c5b25a5f8d270.tar.bz2 openbsd-0527d29da443886d92e9a418180c5b25a5f8d270.zip |
initial import of NetBSD tree
Diffstat (limited to 'src/lib/libc/stdlib/bsearch.3')
-rw-r--r-- | src/lib/libc/stdlib/bsearch.3 | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/src/lib/libc/stdlib/bsearch.3 b/src/lib/libc/stdlib/bsearch.3 new file mode 100644 index 0000000000..1622c96c6b --- /dev/null +++ b/src/lib/libc/stdlib/bsearch.3 | |||
@@ -0,0 +1,91 @@ | |||
1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
2 | .\" All rights reserved. | ||
3 | .\" | ||
4 | .\" This code is derived from software contributed to Berkeley by | ||
5 | .\" the American National Standards Committee X3, on Information | ||
6 | .\" Processing Systems. | ||
7 | .\" | ||
8 | .\" Redistribution and use in source and binary forms, with or without | ||
9 | .\" modification, are permitted provided that the following conditions | ||
10 | .\" are met: | ||
11 | .\" 1. Redistributions of source code must retain the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer. | ||
13 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
14 | .\" notice, this list of conditions and the following disclaimer in the | ||
15 | .\" documentation and/or other materials provided with the distribution. | ||
16 | .\" 3. All advertising materials mentioning features or use of this software | ||
17 | .\" must display the following acknowledgement: | ||
18 | .\" This product includes software developed by the University of | ||
19 | .\" California, Berkeley and its contributors. | ||
20 | .\" 4. Neither the name of the University nor the names of its contributors | ||
21 | .\" may be used to endorse or promote products derived from this software | ||
22 | .\" without specific prior written permission. | ||
23 | .\" | ||
24 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
25 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
26 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
27 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
28 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
29 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
30 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
31 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
32 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
33 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
34 | .\" SUCH DAMAGE. | ||
35 | .\" | ||
36 | .\" from: @(#)bsearch.3 5.6 (Berkeley) 6/29/91 | ||
37 | .\" $Id: bsearch.3,v 1.1.1.1 1995/10/18 08:42:16 deraadt Exp $ | ||
38 | .\" | ||
39 | .Dd June 29, 1991 | ||
40 | .Dt BSEARCH 3 | ||
41 | .Os | ||
42 | .Sh NAME | ||
43 | .Nm bsearch | ||
44 | .Nd binary search of a sorted table | ||
45 | .Sh SYNOPSIS | ||
46 | .Fd #include <stdlib.h> | ||
47 | .Ft void * | ||
48 | .Fn bsearch "const void *key" "const void *base" "size_t nmemb" "size_t size" "int (*compar) (const void *, const void *)" | ||
49 | .Sh DESCRIPTION | ||
50 | The | ||
51 | .Fn bsearch | ||
52 | function searches an array of | ||
53 | .Fa nmemb | ||
54 | objects, the initial member of which is | ||
55 | pointed to by | ||
56 | .Fa base , | ||
57 | for a member that matches the object pointed to by | ||
58 | .Fa key . | ||
59 | The size of each member of the array is specified by | ||
60 | .Fa size . | ||
61 | .Pp | ||
62 | The contents of the array should be in ascending sorted order according | ||
63 | to the comparison function referenced by | ||
64 | .Fa compar . | ||
65 | The | ||
66 | .Fa compar | ||
67 | routine | ||
68 | is expected to have two | ||
69 | two arguments which point to the | ||
70 | .Fa key | ||
71 | object and to an array member, in that order, and should return an integer | ||
72 | less than, equal to, or greater than zero if the | ||
73 | .Fa key | ||
74 | object is found, respectively, to be less than, to match, or be | ||
75 | greater than the array member. | ||
76 | .Sh RETURN VALUES | ||
77 | The | ||
78 | .Fn bsearch | ||
79 | function returns a pointer to a matching member of the array, or a null | ||
80 | pointer if no match is found. | ||
81 | If two members compare as equal, which member is matched is unspecified. | ||
82 | .Sh SEE ALSO | ||
83 | .Xr db 3 , | ||
84 | .Xr lsearch 3 , | ||
85 | .Xr qsort 3 , | ||
86 | .\" .Xr tsearch 3 | ||
87 | .Sh STANDARDS | ||
88 | The | ||
89 | .Fn bsearch | ||
90 | function conforms to | ||
91 | .St -ansiC . | ||