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