code cleanup:
[blender.git] / source / blender / blenlib / BLI_edgehash.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: none of this file.
22  *
23  * Contributor(s): Daniel Dunbar
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27  
28 #ifndef __BLI_EDGEHASH_H__
29 #define __BLI_EDGEHASH_H__
30
31 /** \file BLI_edgehash.h
32  *  \ingroup bli
33  *  \author Daniel Dunbar
34  *  \brief A general unordered 2-int pair hash table ADT.
35  */
36
37 struct EdgeHash;
38 struct EdgeHashIterator;
39 typedef struct EdgeHash EdgeHash;
40 typedef struct EdgeHashIterator EdgeHashIterator;
41
42 typedef void    (*EdgeHashFreeFP)(void *key);
43
44 EdgeHash*               BLI_edgehash_new                (void);
45 void                    BLI_edgehash_free               (EdgeHash *eh, EdgeHashFreeFP valfreefp);
46
47         /* Insert edge (v0,v1) into hash with given value, does
48          * not check for duplicates.
49          */
50 void                    BLI_edgehash_insert             (EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
51
52         /* Return value for given edge (v0,v1), or NULL if
53          * if key does not exist in hash. (If need exists 
54          * to differentiate between key-value being NULL and 
55          * lack of key then see BLI_edgehash_lookup_p().
56          */
57 void*                   BLI_edgehash_lookup             (EdgeHash *eh, unsigned int v0, unsigned int v1);
58
59         /* Return pointer to value for given edge (v0,v1),
60          * or NULL if key does not exist in hash.
61          */
62 void**                  BLI_edgehash_lookup_p   (EdgeHash *eh, unsigned int v0, unsigned int v1);
63
64         /* Return boolean true/false if edge (v0,v1) in hash. */
65 int                             BLI_edgehash_haskey             (EdgeHash *eh, unsigned int v0, unsigned int v1);
66
67         /* Return number of keys in hash. */
68 int                             BLI_edgehash_size               (EdgeHash *eh);
69
70         /* Remove all edges from hash. */
71 void                    BLI_edgehash_clear              (EdgeHash *eh, EdgeHashFreeFP valfreefp);
72
73 /***/
74
75         /**
76          * Create a new EdgeHashIterator. The hash table must not be mutated
77          * while the iterator is in use, and the iterator will step exactly
78          * BLI_edgehash_size(gh) times before becoming done.
79          */
80 EdgeHashIterator*       BLI_edgehashIterator_new                (EdgeHash *eh);
81
82         /* Free an EdgeHashIterator. */
83 void                            BLI_edgehashIterator_free               (EdgeHashIterator *ehi);
84
85         /* Retrieve the key from an iterator. */
86 void                            BLI_edgehashIterator_getKey             (EdgeHashIterator *ehi, unsigned int *v0_r, unsigned int *v1_r);
87         
88         /* Retrieve the value from an iterator. */
89 void*                           BLI_edgehashIterator_getValue   (EdgeHashIterator *ehi);
90
91         /* Set the value for an iterator. */
92 void                            BLI_edgehashIterator_setValue   (EdgeHashIterator *ehi, void *val);
93
94         /* Steps the iterator to the next index. */
95 void                            BLI_edgehashIterator_step               (EdgeHashIterator *ehi);
96
97         /* Determine if an iterator is done. */
98 int                                     BLI_edgehashIterator_isDone             (EdgeHashIterator *ehi);
99
100 #endif