1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16 
17 #pragma once
18 
19 /** \file
20  * \ingroup bli
21  */
22 
23 #include "BLI_compiler_attrs.h"
24 #include "BLI_utildefines.h"
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 struct EdgeHash;
31 typedef struct EdgeHash EdgeHash;
32 
33 struct _EdgeHash_Edge {
34   uint v_low, v_high;
35 };
36 
37 struct _EdgeHash_Entry {
38   struct _EdgeHash_Edge edge;
39   void *value;
40 };
41 
42 typedef struct EdgeHashIterator {
43   struct _EdgeHash_Entry *entries;
44   uint length;
45   uint index;
46 } EdgeHashIterator;
47 
48 typedef void (*EdgeHashFreeFP)(void *key);
49 
50 enum {
51   EDGEHASH_FLAG_ALLOW_DUPES = (1 << 0), /* only checked for in debug mode */
52 };
53 
54 EdgeHash *BLI_edgehash_new_ex(const char *info, const unsigned int nentries_reserve);
55 EdgeHash *BLI_edgehash_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
56 void BLI_edgehash_free(EdgeHash *eh, EdgeHashFreeFP free_value);
57 void BLI_edgehash_print(EdgeHash *eh);
58 void BLI_edgehash_insert(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
59 bool BLI_edgehash_reinsert(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
60 void *BLI_edgehash_lookup(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
61 void *BLI_edgehash_lookup_default(EdgeHash *eh,
62                                   unsigned int v0,
63                                   unsigned int v1,
64                                   void *default_value) ATTR_WARN_UNUSED_RESULT;
65 void **BLI_edgehash_lookup_p(EdgeHash *eh,
66                              unsigned int v0,
67                              unsigned int v1) ATTR_WARN_UNUSED_RESULT;
68 bool BLI_edgehash_ensure_p(EdgeHash *eh, unsigned int v0, unsigned int v1, void ***r_val)
69     ATTR_WARN_UNUSED_RESULT;
70 bool BLI_edgehash_remove(EdgeHash *eh,
71                          unsigned int v0,
72                          unsigned int v1,
73                          EdgeHashFreeFP free_value);
74 
75 void *BLI_edgehash_popkey(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
76 bool BLI_edgehash_haskey(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
77 int BLI_edgehash_len(EdgeHash *eh) ATTR_WARN_UNUSED_RESULT;
78 void BLI_edgehash_clear_ex(EdgeHash *eh, EdgeHashFreeFP free_value, const uint UNUSED(reserve));
79 void BLI_edgehash_clear(EdgeHash *eh, EdgeHashFreeFP free_value);
80 
81 EdgeHashIterator *BLI_edgehashIterator_new(EdgeHash *eh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
82 void BLI_edgehashIterator_init(EdgeHashIterator *ehi, EdgeHash *eh);
83 void BLI_edgehashIterator_free(EdgeHashIterator *ehi);
84 
BLI_edgehashIterator_step(EdgeHashIterator * ehi)85 BLI_INLINE void BLI_edgehashIterator_step(EdgeHashIterator *ehi)
86 {
87   ehi->index++;
88 }
BLI_edgehashIterator_isDone(EdgeHashIterator * ehi)89 BLI_INLINE bool BLI_edgehashIterator_isDone(EdgeHashIterator *ehi)
90 {
91   return ehi->index >= ehi->length;
92 }
BLI_edgehashIterator_getKey(EdgeHashIterator * ehi,unsigned int * r_v0,unsigned int * r_v1)93 BLI_INLINE void BLI_edgehashIterator_getKey(EdgeHashIterator *ehi,
94                                             unsigned int *r_v0,
95                                             unsigned int *r_v1)
96 {
97   struct _EdgeHash_Edge edge = ehi->entries[ehi->index].edge;
98   *r_v0 = edge.v_low;
99   *r_v1 = edge.v_high;
100 }
BLI_edgehashIterator_getValue(EdgeHashIterator * ehi)101 BLI_INLINE void *BLI_edgehashIterator_getValue(EdgeHashIterator *ehi)
102 {
103   return ehi->entries[ehi->index].value;
104 }
BLI_edgehashIterator_getValue_p(EdgeHashIterator * ehi)105 BLI_INLINE void **BLI_edgehashIterator_getValue_p(EdgeHashIterator *ehi)
106 {
107   return &ehi->entries[ehi->index].value;
108 }
BLI_edgehashIterator_setValue(EdgeHashIterator * ehi,void * val)109 BLI_INLINE void BLI_edgehashIterator_setValue(EdgeHashIterator *ehi, void *val)
110 {
111   ehi->entries[ehi->index].value = val;
112 }
113 
114 #define BLI_EDGEHASH_SIZE_GUESS_FROM_LOOPS(totloop) ((totloop) / 2)
115 #define BLI_EDGEHASH_SIZE_GUESS_FROM_POLYS(totpoly) ((totpoly)*2)
116 
117 /* *** EdgeSet *** */
118 
119 struct EdgeSet;
120 typedef struct EdgeSet EdgeSet;
121 
122 typedef struct EdgeSetIterator {
123   struct _EdgeHash_Edge *edges;
124   uint length;
125   uint index;
126 } EdgeSetIterator;
127 
128 EdgeSet *BLI_edgeset_new_ex(const char *info, const unsigned int nentries_reserve)
129     ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
130 EdgeSet *BLI_edgeset_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
131 int BLI_edgeset_len(EdgeSet *es) ATTR_WARN_UNUSED_RESULT;
132 bool BLI_edgeset_add(EdgeSet *es, unsigned int v0, unsigned int v1);
133 void BLI_edgeset_insert(EdgeSet *es, unsigned int v0, unsigned int v1);
134 bool BLI_edgeset_haskey(EdgeSet *es, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
135 void BLI_edgeset_free(EdgeSet *es);
136 
137 /* rely on inline api for now */
138 EdgeSetIterator *BLI_edgesetIterator_new(EdgeSet *es);
139 void BLI_edgesetIterator_free(EdgeSetIterator *esi);
140 
BLI_edgesetIterator_getKey(EdgeSetIterator * esi,unsigned int * r_v0,unsigned int * r_v1)141 BLI_INLINE void BLI_edgesetIterator_getKey(EdgeSetIterator *esi,
142                                            unsigned int *r_v0,
143                                            unsigned int *r_v1)
144 {
145   struct _EdgeHash_Edge edge = esi->edges[esi->index];
146   *r_v0 = edge.v_low;
147   *r_v1 = edge.v_high;
148 }
BLI_edgesetIterator_step(EdgeSetIterator * esi)149 BLI_INLINE void BLI_edgesetIterator_step(EdgeSetIterator *esi)
150 {
151   esi->index++;
152 }
BLI_edgesetIterator_isDone(EdgeSetIterator * esi)153 BLI_INLINE bool BLI_edgesetIterator_isDone(EdgeSetIterator *esi)
154 {
155   return esi->index >= esi->length;
156 }
157 
158 #ifdef __cplusplus
159 }
160 #endif
161