BLI: New Edgehash and EdgeSet implementation
[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  * Contributor(s): Daniel Dunbar
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BLI_EDGEHASH_H__
24 #define __BLI_EDGEHASH_H__
25
26 /** \file BLI_edgehash.h
27  *  \ingroup bli
28  *  \author Daniel Dunbar
29  */
30
31 #include "BLI_compiler_attrs.h"
32
33 struct EdgeHash;
34 typedef struct EdgeHash EdgeHash;
35
36 struct _EdgeHash_Edge {
37         uint v_low, v_high;
38 };
39
40 struct _EdgeHash_Entry {
41         struct _EdgeHash_Edge edge;
42         void *value;
43 };
44
45 typedef struct EdgeHashIterator {
46         struct _EdgeHash_Entry *entries;
47         uint length;
48         uint index;
49 } EdgeHashIterator;
50
51 typedef void (*EdgeHashFreeFP)(void *key);
52
53 enum {
54         EDGEHASH_FLAG_ALLOW_DUPES = (1 << 0),  /* only checked for in debug mode */
55 };
56
57 EdgeHash       *BLI_edgehash_new_ex(const char *info,
58                                     const unsigned int nentries_reserve);
59 EdgeHash       *BLI_edgehash_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
60 void            BLI_edgehash_free(EdgeHash *eh, EdgeHashFreeFP valfreefp);
61 void            BLI_edgehash_print(EdgeHash *eh);
62 void            BLI_edgehash_insert(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
63 bool            BLI_edgehash_reinsert(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
64 void           *BLI_edgehash_lookup(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
65 void           *BLI_edgehash_lookup_default(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val_default) ATTR_WARN_UNUSED_RESULT;
66 void          **BLI_edgehash_lookup_p(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
67 bool            BLI_edgehash_ensure_p(EdgeHash *eh, unsigned int v0, unsigned int v1, void ***r_val) ATTR_WARN_UNUSED_RESULT;
68 bool            BLI_edgehash_remove(EdgeHash *eh, unsigned int v0, unsigned int v1, EdgeHashFreeFP valfreefp);
69
70 void           *BLI_edgehash_popkey(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
71 bool            BLI_edgehash_haskey(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
72 int             BLI_edgehash_len(EdgeHash *eh) ATTR_WARN_UNUSED_RESULT;
73 void            BLI_edgehash_clear_ex(EdgeHash *eh, EdgeHashFreeFP valfreefp,
74                                       const unsigned int nentries_reserve);
75 void            BLI_edgehash_clear(EdgeHash *eh, EdgeHashFreeFP valfreefp);
76
77 EdgeHashIterator   *BLI_edgehashIterator_new(EdgeHash *eh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
78 void                BLI_edgehashIterator_init(EdgeHashIterator *ehi, EdgeHash *eh);
79 void                BLI_edgehashIterator_free(EdgeHashIterator *ehi);
80
81 BLI_INLINE void   BLI_edgehashIterator_step(EdgeHashIterator *ehi)
82 { ehi->index++; }
83 BLI_INLINE bool   BLI_edgehashIterator_isDone(EdgeHashIterator *ehi)
84 { return ehi->index >= ehi->length; }
85 BLI_INLINE void   BLI_edgehashIterator_getKey(EdgeHashIterator *ehi, unsigned int *r_v0, unsigned int *r_v1)
86 { struct _EdgeHash_Edge edge = ehi->entries[ehi->index].edge; *r_v0 = edge.v_low; *r_v1 = edge.v_high; }
87 BLI_INLINE void  *BLI_edgehashIterator_getValue(EdgeHashIterator *ehi)
88 { return ehi->entries[ehi->index].value; }
89 BLI_INLINE void **BLI_edgehashIterator_getValue_p(EdgeHashIterator *ehi)
90 { return &ehi->entries[ehi->index].value; }
91 BLI_INLINE void   BLI_edgehashIterator_setValue(EdgeHashIterator *ehi, void *val)
92 { ehi->entries[ehi->index].value = val; }
93
94
95 #define BLI_EDGEHASH_SIZE_GUESS_FROM_LOOPS(totloop)  ((totloop) / 2)
96 #define BLI_EDGEHASH_SIZE_GUESS_FROM_POLYS(totpoly)  ((totpoly) * 2)
97
98 /* *** EdgeSet *** */
99
100 struct EdgeSet;
101 typedef struct EdgeSet EdgeSet;
102
103 typedef struct EdgeSetIterator {
104         struct _EdgeHash_Edge *edges;
105         uint length;
106         uint index;
107 } EdgeSetIterator;
108
109 EdgeSet *BLI_edgeset_new_ex(const char *info,
110                             const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
111 EdgeSet *BLI_edgeset_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
112 int      BLI_edgeset_len(EdgeSet *es) ATTR_WARN_UNUSED_RESULT;
113 bool     BLI_edgeset_add(EdgeSet *es, unsigned int v0, unsigned int v1);
114 void     BLI_edgeset_insert(EdgeSet *es, unsigned int v0, unsigned int v1);
115 bool     BLI_edgeset_haskey(EdgeSet *es, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
116 void     BLI_edgeset_free(EdgeSet *es);
117
118 /* rely on inline api for now */
119 EdgeSetIterator *BLI_edgesetIterator_new(EdgeSet *gs);
120 void BLI_edgesetIterator_free(EdgeSetIterator *esi);
121
122 BLI_INLINE void BLI_edgesetIterator_getKey(EdgeSetIterator *esi, unsigned int *r_v0, unsigned int *r_v1)
123 { struct _EdgeHash_Edge edge = esi->edges[esi->index]; *r_v0 = edge.v_low; *r_v1 = edge.v_high; }
124 BLI_INLINE void BLI_edgesetIterator_step(EdgeSetIterator *esi)
125 { esi->index++; }
126 BLI_INLINE bool BLI_edgesetIterator_isDone(EdgeSetIterator *esi)
127 { return esi->index >= esi->length; }
128
129 #endif  /* __BLI_EDGEHASH_H__ */