share/man/man3c/hsearch.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH HSEARCH 3C "Dec 29, 1996"
   7 .SH NAME
   8 hsearch, hcreate, hdestroy \- manage hash search tables
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <search.h>
  13
  14 \fBENTRY *\fR\fBhsearch\fR(\fBENTRY\fR \fIitem\fR, \fBACTION\fR \fIaction\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBhcreate\fR(\fBsize_t\fR \fImekments\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBhdestroy\fR(\fBvoid\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBhsearch()\fR function is a hash-table search routine generalized from
  31 Knuth (6.4) Algorithm D. It returns a pointer into a hash table indicating the
  32 location at which an entry can be found. The comparison function used by
  33 \fBhsearch()\fR is \fBstrcmp()\fR (see \fBstring\fR(3C)). The \fIitem\fR
  34 argument is a structure of type \fBENTRY\fR (defined in the  \fB<search.h>\fR
  35 header) containing two pointers: \fBitem.key\fR points to the comparison key,
  36 and \fBitem.data\fR points to any other data to be associated with that key.
  37 (Pointers to types other than void should be cast to pointer-to-void.) The
  38 \fIaction\fR argument is a member of an enumeration type \fBACTION\fR (defined
  39 in \fB<search.h>\fR) indicating the disposition of the entry if it cannot be
  40 found in the table. \fBENTER\fR indicates that the item should be inserted in
  41 the table at an appropriate point. Given a duplicate of an existing item, the
  42 new item is not entered and \fBhsearch()\fR returns a pointer to the existing
  43 item. \fBFIND\fR indicates that no entry should be made. Unsuccessful
  44 resolution is indicated by the return of a null pointer.
  45 .sp
  46 .LP
  47 The \fBhcreate()\fR function allocates sufficient space for the table, and must
  48 be called before \fBhsearch()\fR is used.  The \fInel\fR argument is an
  49 estimate of the maximum number of entries that the table will contain. This
  50 number may be adjusted upward by the algorithm in order to obtain certain
  51 mathematically favorable circumstances.
  52 .sp
  53 .LP
  54 The \fBhdestroy()\fR function destroys the search table, and may be followed by
  55 another call to \fBhcreate()\fR.
  56 .SH RETURN VALUES
  57 .sp
  58 .LP
  59 The \fBhsearch()\fR function returns a null pointer if either the action is
  60 \fBFIND\fR and the item could not be found or the action is \fBENTER\fR and the
  61 table is full.
  62 .sp
  63 .LP
  64 The \fBhcreate()\fR function returns \fB0\fR if it cannot allocate sufficient
  65 space for the table.
  66 .SH USAGE
  67 .sp
  68 .LP
  69 The \fBhsearch()\fR and  \fBhcreate()\fR functions use \fBmalloc\fR(3C) to
  70 allocate space.
  71 .sp
  72 .LP
  73 Only one hash search table may be active at any given time.
  74 .SH EXAMPLES
  75 .LP
  76 \fBExample 1 \fRExample to read in strings.
  77 .sp
  78 .LP
  79 The following example will read in strings followed by two numbers and store
  80 them in a hash table, discarding duplicates. It will then read in strings and
  81 find the matching entry in the hash table and print it.
  82
  83 .sp
  84 .in +2
  85 .nf
  86 \fB#include <stdio.h>
  87 #include <search.h>
  88 #include <string.h>
  89 #include <stdlib.h>
  90
  91 struct info {              /* this is the info stored in table */
  92         int age, room;     /* other than the key */
  93 };
  94 #define NUM_EMPL    5000   /* # of elements in search table */
  95 main( )
  96 {
  97                         /* space to store strings */
  98         char string_space[NUM_EMPL*20];
  99                         /* space to store employee info */
 100         struct info info_space[NUM_EMPL];
 101                         /* next avail space in string_space */
 102         char *str_ptr = string_space;
 103                         /* next avail space in info_space */
 104         struct info *info_ptr = info_space;
 105         ENTRY item, *found_item;
 106                         /* name to look for in table */
 107         char name_to_find[30];
 108         int i = 0;
 109
 110                         /* create table */
 111         (void) hcreate(NUM_EMPL);
 112         while (scanf("%s%d%d", str_ptr, &info_ptr\(mi>age,
 113                &info_ptr\(mi>room) != EOF && i++ < NUM_EMPL) {
 114                    /* put info in structure, and structure in item */
 115                 item.key = str_ptr;
 116                 item.data = (void *)info_ptr;
 117                 str_ptr += strlen(str_ptr) + 1;
 118                 info_ptr++;
 119                         /* put item into table */
 120                 (void) hsearch(item, ENTER);
 121         }
 122
 123                         /* access table */
 124         item.key = name_to_find;
 125         while (scanf("%s", item.key) != EOF) {
 126             if ((found_item = hsearch(item, FIND)) != NULL) {
 127                         /* if item is in the table */
 128                 (void)printf("found %s, age = %d, room = %d\en",
 129                         found_item\(mi>key,
 130                         ((struct info *)found_item\(mi>data)\(mi>age,
 131                         ((struct info *)found_item\(mi>data)\(mi>room);
 132             } else {
 133                 (void)printf("no such employee %s\en",
 134                         name_to_find)
 135             }
 136         }
 137         return 0;
 138 }\fR
 139 .fi
 140 .in -2
 141
 142 .SH ATTRIBUTES
 143 .sp
 144 .LP
 145 See \fBattributes\fR(5) for descriptions of the following attributes:
 146 .sp
 147
 148 .sp
 149 .TS
 150 box;
 151 c | c
 152 l | l .
 153 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 154 _
 155 Interface Stability     Standard
 156 _
 157 MT-Level        Safe
 158 .TE
 159
 160 .SH SEE ALSO
 161 .sp
 162 .LP
 163 \fBbsearch\fR(3C), \fBlsearch\fR(3C), \fBmalloc\fR(3C), \fBstring\fR(3C),
 164 \fBtsearch\fR(3C), \fBmalloc\fR(3MALLOC), \fBattributes\fR(5),
 165 \fBstandards\fR(5)
 166 .sp
 167 .LP
 168 \fIThe Art of Computer Programming, Volume 3, Sorting and Searching by Donald
 169 E. Knuth, published by Addison-Wesley Publishing Company, 1973.\fR