20272dd97cdd6a9167111b473e26fa09895ca9f1
[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 typedef struct EdgeHashIterator {
37         EdgeHash *eh;
38         struct EdgeEntry *curEntry;
39         unsigned int curBucket;
40 } EdgeHashIterator;
41
42 typedef void (*EdgeHashFreeFP)(void *key);
43
44 enum {
45         EDGEHASH_FLAG_ALLOW_DUPES = (1 << 0),  /* only checked for in debug mode */
46 };
47
48 EdgeHash       *BLI_edgehash_new_ex(const char *info,
49                                     const unsigned int nentries_reserve);
50 EdgeHash       *BLI_edgehash_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
51 void            BLI_edgehash_free(EdgeHash *eh, EdgeHashFreeFP valfreefp);
52 void            BLI_edgehash_insert(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
53 bool            BLI_edgehash_reinsert(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val);
54 void           *BLI_edgehash_lookup(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
55 void           *BLI_edgehash_lookup_default(EdgeHash *eh, unsigned int v0, unsigned int v1, void *val_default) ATTR_WARN_UNUSED_RESULT;
56 void          **BLI_edgehash_lookup_p(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
57 bool            BLI_edgehash_ensure_p(EdgeHash *eh, unsigned int v0, unsigned int v1, void ***r_val) ATTR_WARN_UNUSED_RESULT;
58 bool            BLI_edgehash_remove(EdgeHash *eh, unsigned int v0, unsigned int v1, EdgeHashFreeFP valfreefp);
59
60 void           *BLI_edgehash_popkey(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
61 bool            BLI_edgehash_haskey(EdgeHash *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
62 int             BLI_edgehash_size(EdgeHash *eh) ATTR_WARN_UNUSED_RESULT;
63 void            BLI_edgehash_clear_ex(EdgeHash *eh, EdgeHashFreeFP valfreefp,
64                                       const unsigned int nentries_reserve);
65 void            BLI_edgehash_clear(EdgeHash *eh, EdgeHashFreeFP valfreefp);
66 void            BLI_edgehash_flag_set(EdgeHash *eh, unsigned int flag);
67 void            BLI_edgehash_flag_clear(EdgeHash *eh, unsigned int flag);
68
69 EdgeHashIterator   *BLI_edgehashIterator_new(EdgeHash *eh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
70 void                BLI_edgehashIterator_init(EdgeHashIterator *ehi, EdgeHash *eh);
71 void                BLI_edgehashIterator_free(EdgeHashIterator *ehi);
72 void                BLI_edgehashIterator_step(EdgeHashIterator *ehi);
73
74 BLI_INLINE bool   BLI_edgehashIterator_isDone(EdgeHashIterator *ehi) ATTR_WARN_UNUSED_RESULT;
75 BLI_INLINE void   BLI_edgehashIterator_getKey(EdgeHashIterator *ehi, unsigned int *r_v0, unsigned int *r_v1);
76 BLI_INLINE void  *BLI_edgehashIterator_getValue(EdgeHashIterator *ehi) ATTR_WARN_UNUSED_RESULT;
77 BLI_INLINE void **BLI_edgehashIterator_getValue_p(EdgeHashIterator *ehi) ATTR_WARN_UNUSED_RESULT;
78 BLI_INLINE void   BLI_edgehashIterator_setValue(EdgeHashIterator *ehi, void *val);
79
80 struct _eh_Entry { void *next; unsigned int v0, v1; void *val; };
81 BLI_INLINE void   BLI_edgehashIterator_getKey(EdgeHashIterator *ehi, unsigned int *r_v0, unsigned int *r_v1)
82 { *r_v0 = ((struct _eh_Entry *)ehi->curEntry)->v0; *r_v1 = ((struct _eh_Entry *)ehi->curEntry)->v1; }
83 BLI_INLINE void  *BLI_edgehashIterator_getValue(EdgeHashIterator *ehi) { return ((struct _eh_Entry *)ehi->curEntry)->val; }
84 BLI_INLINE void **BLI_edgehashIterator_getValue_p(EdgeHashIterator *ehi) { return &((struct _eh_Entry *)ehi->curEntry)->val; }
85 BLI_INLINE void   BLI_edgehashIterator_setValue(EdgeHashIterator *ehi, void *val) { ((struct _eh_Entry *)ehi->curEntry)->val = val; }
86 BLI_INLINE bool   BLI_edgehashIterator_isDone(EdgeHashIterator *ehi) { return (((struct _eh_Entry *)ehi->curEntry) == NULL); }
87 /* disallow further access */
88 #ifdef __GNUC__
89 #  pragma GCC poison _eh_Entry
90 #else
91 #  define _eh_Entry void
92 #endif
93
94 #define BLI_EDGEHASH_SIZE_GUESS_FROM_LOOPS(totloop)  ((totloop) / 2)
95 #define BLI_EDGEHASH_SIZE_GUESS_FROM_POLYS(totpoly)  ((totpoly) * 2)
96
97 /* *** EdgeSet *** */
98
99 struct EdgeSet;
100 struct EdgeSetIterator;
101 typedef struct EdgeSet EdgeSet;
102 typedef struct EdgeSetIterator EdgeSetIterator;
103
104 EdgeSet *BLI_edgeset_new_ex(const char *info,
105                             const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
106 EdgeSet *BLI_edgeset_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
107 int      BLI_edgeset_size(EdgeSet *es) ATTR_WARN_UNUSED_RESULT;
108 bool     BLI_edgeset_add(EdgeSet *es, unsigned int v0, unsigned int v1);
109 void     BLI_edgeset_insert(EdgeSet *es, unsigned int v0, unsigned int v1);
110 bool     BLI_edgeset_haskey(EdgeSet *eh, unsigned int v0, unsigned int v1) ATTR_WARN_UNUSED_RESULT;
111 void     BLI_edgeset_free(EdgeSet *es);
112 void     BLI_edgeset_flag_set(EdgeSet *es, unsigned int flag);
113 void     BLI_edgeset_flag_clear(EdgeSet *es, unsigned int flag);
114
115 /* rely on inline api for now */
116 BLI_INLINE EdgeSetIterator *BLI_edgesetIterator_new(EdgeSet *gs) { return (EdgeSetIterator *)BLI_edgehashIterator_new((EdgeHash *)gs); }
117 BLI_INLINE void BLI_edgesetIterator_free(EdgeSetIterator *esi) { BLI_edgehashIterator_free((EdgeHashIterator *)esi); }
118 BLI_INLINE void BLI_edgesetIterator_getKey(EdgeSetIterator *esi, unsigned int *r_v0, unsigned int *r_v1) { BLI_edgehashIterator_getKey((EdgeHashIterator *)esi, r_v0, r_v1); }
119 BLI_INLINE void BLI_edgesetIterator_step(EdgeSetIterator *esi) { BLI_edgehashIterator_step((EdgeHashIterator *)esi); }
120 BLI_INLINE bool BLI_edgesetIterator_isDone(EdgeSetIterator *esi) { return BLI_edgehashIterator_isDone((EdgeHashIterator *)esi); }
121
122 #ifdef DEBUG
123 double          BLI_edgehash_calc_quality(EdgeHash *eh);
124 double          BLI_edgeset_calc_quality(EdgeSet *es);
125 #endif
126
127 #endif  /* __BLI_EDGEHASH_H__ */