src/libpspp/hash.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #if !hash_h
  21 #define hash_h 1
  22
  23 #include <stddef.h>
  24 #include <stdbool.h>
  25
  26 typedef int hsh_compare_func (const void *, const void *, const void *aux);
  27 typedef unsigned hsh_hash_func (const void *, const void *aux);
  28 typedef void hsh_free_func (void *, const void *aux);
  29
  30 /* Hash table iterator (opaque). */
  31 struct hsh_iterator
  32   {
  33     size_t next;                /* Index of next entry. */
  34   };
  35
  36 /* Hash functions. */
  37 unsigned hsh_hash_bytes (const void *, size_t);
  38 unsigned hsh_hash_string (const char *);
  39 unsigned hsh_hash_case_string (const char *);
  40 unsigned hsh_hash_int (int);
  41 unsigned hsh_hash_double (double);
  42
  43 /* Hash tables. */
  44 struct hsh_table *hsh_create (int m, hsh_compare_func *,
  45                               hsh_hash_func *, hsh_free_func *,
  46                               const void *aux);
  47
  48 struct pool;
  49 struct hsh_table *hsh_create_pool (struct pool *pool, int m,
  50                                    hsh_compare_func *,
  51                                    hsh_hash_func *, hsh_free_func *,
  52                                    const void *aux);
  53
  54 void hsh_clear (struct hsh_table *);
  55 void hsh_destroy (struct hsh_table *);
  56 void *const *hsh_sort (struct hsh_table *);
  57 void *const *hsh_data (struct hsh_table *);
  58 void **hsh_sort_copy (struct hsh_table *);
  59 void **hsh_data_copy (struct hsh_table *);
  60
  61 /* Search and insertion. */
  62 void **hsh_probe (struct hsh_table *, const void *);
  63 void *hsh_insert (struct hsh_table *, void *);
  64 void *hsh_replace (struct hsh_table *, void *);
  65 void *hsh_find (struct hsh_table *, const void *);
  66 bool hsh_delete (struct hsh_table *, const void *);
  67
  68 /* Iteration. */
  69 void *hsh_first (struct hsh_table *, struct hsh_iterator *);
  70 void *hsh_next (struct hsh_table *, struct hsh_iterator *);
  71
  72 /* Search and insertion with assertion. */
  73 #if DEBUGGING
  74 void hsh_force_insert (struct hsh_table *, void *);
  75 void *hsh_force_find (struct hsh_table *, const void *);
  76 void hsh_force_delete (struct hsh_table *, const void *);
  77 #else
  78 #define hsh_force_insert(A, B)  ((void) (*hsh_probe (A, B) = B))
  79 #define hsh_force_find(A, B)    (hsh_find (A, B))
  80 #define hsh_force_delete(A, B)  ((void) hsh_delete (A, B))
  81 #endif
  82
  83 /* Number of entries in hash table H. */
  84 size_t hsh_count (struct hsh_table *);
  85
  86 /* Debugging. */
  87 #if DEBUGGING
  88 void hsh_dump (struct hsh_table *);
  89 #endif
  90
  91 #endif /* hash_h */