Changed all the licence notices in all the files.
[pspp-builds.git] / src / 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
25 typedef int hsh_compare_func (const void *, const void *, void *aux);
26 typedef unsigned hsh_hash_func (const void *, void *aux);
27 typedef void hsh_free_func (void *, void *aux);
28
29 /* Hash table iterator (opaque). */
30 struct hsh_iterator
31   {
32     size_t next;                /* Index of next entry. */
33   };
34
35 /* Hash functions. */
36 unsigned hsh_hash_bytes (const void *, size_t);
37 unsigned hsh_hash_string (const char *);
38 unsigned hsh_hash_int (int);
39 unsigned hsh_hash_double (double);
40
41 /* Hash tables. */
42 struct hsh_table *hsh_create (int m, hsh_compare_func *,
43                               hsh_hash_func *, hsh_free_func *,
44                               void *aux);
45 void hsh_clear (struct hsh_table *);
46 void hsh_destroy (struct hsh_table *);
47 void **hsh_sort (struct hsh_table *);
48 void **hsh_data (struct hsh_table *);
49 void **hsh_sort_copy (struct hsh_table *);
50 void **hsh_data_copy (struct hsh_table *);
51
52 /* Search and insertion. */
53 void **hsh_probe (struct hsh_table *, const void *);
54 void *hsh_insert (struct hsh_table *, void *);
55 void *hsh_replace (struct hsh_table *, void *);
56 void *hsh_find (struct hsh_table *, const void *);
57 int hsh_delete (struct hsh_table *, const void *);
58
59 /* Iteration. */
60 void *hsh_first (struct hsh_table *, struct hsh_iterator *);
61 void *hsh_next (struct hsh_table *, struct hsh_iterator *);
62
63 /* Search and insertion with assertion. */
64 #if GLOBAL_DEBUGGING
65 void hsh_force_insert (struct hsh_table *, void *);
66 void *hsh_force_find (struct hsh_table *, const void *);
67 void hsh_force_delete (struct hsh_table *, const void *);
68 #else
69 #define hsh_force_insert(A, B)  ((void) (*hsh_probe (A, B) = B))
70 #define hsh_force_find(A, B)    (hsh_find (A, B))
71 #define hsh_force_delete(A, B)  ((void) hsh_delete (A, B))
72 #endif
73
74 /* Number of entries in hash table H. */
75 size_t hsh_count (struct hsh_table *);
76
77 /* Debugging. */
78 #if GLOBAL_DEBUGGING
79 void hsh_dump (struct hsh_table *);
80 #endif
81
82 #endif /* hash_h */