-mdoc (version 3)

[unix-history] / usr / src / lib / libc / stdlib / bsearch.3

.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)bsearch.3	5.4 (Berkeley) %G%
.\"
.Dd 
.Dt BSEARCH 3
.Os
.Sh NAME
.Nm bsearch
.Nd binary search of a sorted table
.Sh SYNOPSIS
.Fd #include <stdlib.h>
.Ft void *
.Fn bsearch "const void *key" "const void *base" "size_t nmemb" "size_t size" "int (*compar) (const void *, const void *)"
.Sh DESCRIPTION
The
.Fn bsearch
function searches an array of
.Fa nmemb
objects, the inital member of which is 
pointed to by
.Fa base ,
for a member that matches the object pointed to by
.Fa key .
The size of each member of the array is specified by 
.Fa size .
.Pp
The contents of the array should be in ascending sorted order according
to the comparison function referenced by
.Fa compar .
The
.Fa compar
routine
is expected to have two
two arguments which point to the
.Fa key
object and to an array member, in that order, and should return an integer
less than, equal to, or greater than zero if the
.Fa key
object is found, respectively, to be less than, to match, or be
greater than the array member.
.Sh RETURN VALUES
The
.Fn bsearch
function returns a pointer to a matching member of the array, or a null
pointer if no match is found.
If two members compare as equal, which member is matched is unspecified.
.Sh SEE ALSO
.Xr hsearch 3 ,
.Xr lsearch 3 ,
.Xr qsort 3 ,
.\" .Xr tsearch 3
.Sh STANDARDS
The
.Fn bsearch
function conforms to
.St -ansiC .