man3/bsearch.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Mon Mar 29 22:41:16 1993, David Metcalfe
  30 .\" Modified Sat Jul 24 21:35:16 1993, Rik Faith (faith@cs.unc.edu)
  31 .TH BSEARCH 3  2021-03-22 "" "Linux Programmer's Manual"
  32 .SH NAME
  33 bsearch \- binary search of a sorted array
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <stdlib.h>
  37 .PP
  38 .BI "void *bsearch(const void *" key ", const void *" base ,
  39 .BI "              size_t " nmemb ", size_t " size ,
  40 .BI "              int (*" compar ")(const void *, const void *));"
  41 .fi
  42 .SH DESCRIPTION
  43 The
  44 .BR bsearch ()
  45 function searches an array of
  46 .I nmemb
  47 objects,
  48 the initial member of which is pointed to by
  49 .IR base ,
  50 for a member
  51 that matches the object pointed to by
  52 .IR key .
  53 The size of each member
  54 of the array is specified by
  55 .IR size .
  56 .PP
  57 The contents of the array should be in ascending sorted order according
  58 to the comparison function referenced by
  59 .IR compar .
  60 The
  61 .I compar
  62 routine is expected to have two arguments which point to the
  63 .I key
  64 object and to an array member, in that order, and should return an integer
  65 less than, equal to, or greater than zero if the
  66 .I key
  67 object is found,
  68 respectively, to be less than, to match, or be greater than the array
  69 member.
  70 .SH RETURN VALUE
  71 The
  72 .BR bsearch ()
  73 function returns a pointer to a matching member of the
  74 array, or NULL if no match is found.
  75 If there are multiple elements that
  76 match the key, the element returned is unspecified.
  77 .SH ATTRIBUTES
  78 For an explanation of the terms used in this section, see
  79 .BR attributes (7).
  80 .ad l
  81 .nh
  82 .TS
  83 allbox;
  84 lbx lb lb
  85 l l l.
  86 Interface       Attribute       Value
  87 T{
  88 .BR bsearch ()
  89 T}      Thread safety   MT-Safe
  90 .TE
  91 .hy
  92 .ad
  93 .sp 1
  94 .SH CONFORMING TO
  95 POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
  96 .SH EXAMPLES
  97 The example below first sorts an array of structures using
  98 .BR qsort (3),
  99 then retrieves desired elements using
 100 .BR bsearch ().
 101 .PP
 102 .EX
 103 #include <stdio.h>
 104 #include <stdlib.h>
 105 #include <string.h>
 106
 107 struct mi {
 108     int nr;
 109     char *name;
 110 } months[] = {
 111     { 1, "jan" }, { 2, "feb" }, { 3, "mar" }, { 4, "apr" },
 112     { 5, "may" }, { 6, "jun" }, { 7, "jul" }, { 8, "aug" },
 113     { 9, "sep" }, {10, "oct" }, {11, "nov" }, {12, "dec" }
 114 };
 115
 116 #define nr_of_months (sizeof(months)/sizeof(months[0]))
 117
 118 static int
 119 compmi(const void *m1, const void *m2)
 120 {
 121     const struct mi *mi1 = m1;
 122     const struct mi *mi2 = m2;
 123     return strcmp(mi1\->name, mi2\->name);
 124 }
 125
 126 int
 127 main(int argc, char *argv[])
 128 {
 129     qsort(months, nr_of_months, sizeof(months[0]), compmi);
 130     for (int i = 1; i < argc; i++) {
 131         struct mi key;
 132         struct mi *res;
 133
 134         key.name = argv[i];
 135         res = bsearch(&key, months, nr_of_months,
 136                       sizeof(months[0]), compmi);
 137         if (res == NULL)
 138             printf("\(aq%s\(aq: unknown month\en", argv[i]);
 139         else
 140             printf("%s: month #%d\en", res\->name, res\->nr);
 141     }
 142     exit(EXIT_SUCCESS);
 143 }
 144 .EE
 145 .\" this example referred to in qsort.3
 146 .SH SEE ALSO
 147 .BR hsearch (3),
 148 .BR lsearch (3),
 149 .BR qsort (3),
 150 .BR tsearch (3)