lib/libc/stdlib/tsearch.3

   1 .\" $NetBSD$
   2 .\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  17 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  18 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
  19 .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\"     OpenBSD: tsearch.3,v 1.2 1998/06/21 22:13:49 millert Exp
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd June 15, 1997
  31 .Dt TSEARCH 3
  32 .Os
  33 .Sh NAME
  34 .Nm tsearch , tfind , tdelete , twalk
  35 .Nd manipulate binary search trees
  36 .Sh SYNOPSIS
  37 .In search.h
  38 .Ft void *
  39 .Fn tdelete "const void * restrict key" "void ** restrict rootp" "int (*compar) (const void *, const void *)"
  40 .Ft void *
  41 .Fn tfind "const void *key" "void * const *rootp" "int (*compar) (const void *, const void *)"
  42 .Ft void *
  43 .Fn tsearch "const void *key" "void **rootp" "int (*compar) (const void *, const void *)"
  44 .Ft void
  45 .Fn twalk "const void *root" "void (*action) (const void *, VISIT, int)"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn tdelete ,
  49 .Fn tfind ,
  50 .Fn tsearch ,
  51 and
  52 .Fn twalk
  53 functions manage binary search trees based on algorithms T and D
  54 from Knuth (6.2.2).
  55 The comparison function passed in by
  56 the user has the same style of return values as
  57 .Xr strcmp 3 .
  58 .Pp
  59 The
  60 .Fn tfind
  61 function
  62 searches for the datum matched by the argument
  63 .Fa key
  64 in the binary tree rooted at
  65 .Fa rootp ,
  66 returning a pointer to the datum if it is found and NULL
  67 if it is not.
  68 .Pp
  69 The
  70 .Fn tsearch
  71 function
  72 is identical to
  73 .Fn tfind
  74 except that if no match is found,
  75 .Fa key
  76 is inserted into the tree and a pointer to it is returned.
  77 If
  78 .Fa rootp
  79 points to a NULL value a new binary search tree is created.
  80 .Pp
  81 The
  82 .Fn tdelete
  83 function
  84 deletes a node from the specified binary search tree and returns
  85 a pointer to the parent of the node to be deleted.
  86 It takes the same arguments as
  87 .Fn tfind
  88 and
  89 .Fn tsearch .
  90 If the node to be deleted is the root of the binary search tree,
  91 .Fa rootp
  92 will be adjusted.
  93 .Pp
  94 The
  95 .Fn twalk
  96 function
  97 walks the binary search tree rooted in
  98 .Fa root
  99 and calls the function
 100 .Fa action
 101 on each node.
 102 The
 103 .Fa action
 104 function
 105 is called with three arguments: a pointer to the current node,
 106 a value from the enum
 107 .Sy "typedef enum { preorder, postorder, endorder, leaf } VISIT;"
 108 specifying the traversal type, and a node level (where level
 109 zero is the root of the tree).
 110 .Sh RETURN VALUES
 111 The
 112 .Fn tsearch
 113 function returns NULL if allocation of a new node fails (usually
 114 due to a lack of free memory).
 115 .Pp
 116 The
 117 .Fn tfind ,
 118 .Fn tsearch ,
 119 and
 120 .Fn tdelete
 121 functions
 122 return NULL if
 123 .Fa rootp
 124 is NULL or the datum cannot be found.
 125 .Pp
 126 The
 127 .Fn twalk
 128 function returns no value.
 129 .Sh SEE ALSO
 130 .Xr bsearch 3 ,
 131 .Xr hsearch 3 ,
 132 .Xr lsearch 3