-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcbtree_8h.html
338 lines (305 loc) · 14.4 KB
/
cbtree_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libusual: usual/cbtree.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libusual
 <span id="projectnumber">0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">usual/cbtree.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Crit-bit tree / binary radix tree.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#a3ec9be73d9a460f3b5b1bd387e4ed14e">cbtree_getkey_func</a> )(void *ctx, void *obj, const void **dst_p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns length of the key <a href="#a3ec9be73d9a460f3b5b1bd387e4ed14e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#a6db2f8bc92bd7ee4dbbae9c3148a9040">cbtree_walker_func</a> )(void *ctx, void *obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">walk over tree <a href="#a6db2f8bc92bd7ee4dbbae9c3148a9040"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct CBTree * </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#adde759d374214dc26e811b8d24b90877">cbtree_create</a> (<a class="el" href="cbtree_8h.html#a3ec9be73d9a460f3b5b1bd387e4ed14e">cbtree_getkey_func</a> obj_key_cb, <a class="el" href="cbtree_8h.html#a6db2f8bc92bd7ee4dbbae9c3148a9040">cbtree_walker_func</a> obj_free_cb, void *cb_ctx, <a class="el" href="struct_cx_mem.html">CxMem</a> *cx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new tree. <a href="#adde759d374214dc26e811b8d24b90877"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#a6a73ed80ee440afcd7d4f28ee8588103">cbtree_destroy</a> (struct CBTree *tree)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">frees all resources allocated. <a href="#a6a73ed80ee440afcd7d4f28ee8588103"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#ac67a3ab11cf65924a5c7e518fa562922">cbtree_insert</a> (struct CBTree *tree, void *obj) <a class="el" href="base_8h.html#a85cd253c2de3e111bd2986b324488888">_MUSTCHECK</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts new node to tree. <a href="#ac67a3ab11cf65924a5c7e518fa562922"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#a63ba3d18af01250d3222327d112eb97b">cbtree_delete</a> (struct CBTree *tree, const void *key, size_t klen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removed node from tree. <a href="#a63ba3d18af01250d3222327d112eb97b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#a9cb05aa0cb6b0c8ea70b27b88715bb15">cbtree_lookup</a> (struct CBTree *tree, const void *key, size_t klen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup a key. <a href="#a9cb05aa0cb6b0c8ea70b27b88715bb15"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="cbtree_8h.html#a64038ef46174a234598cab8dfebaef63">cbtree_walk</a> (struct CBTree *tree, <a class="el" href="cbtree_8h.html#a6db2f8bc92bd7ee4dbbae9c3148a9040">cbtree_walker_func</a> cb_func, void *cb_arg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Walk over tree. <a href="#a64038ef46174a234598cab8dfebaef63"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Crit-bit tree / binary radix tree. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a3ec9be73d9a460f3b5b1bd387e4ed14e"></a><!-- doxytag: member="cbtree.h::cbtree_getkey_func" ref="a3ec9be73d9a460f3b5b1bd387e4ed14e" args=")(void *ctx, void *obj, const void **dst_p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t(* <a class="el" href="cbtree_8h.html#a3ec9be73d9a460f3b5b1bd387e4ed14e">cbtree_getkey_func</a>)(void *ctx, void *obj, const void **dst_p)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns length of the key </p>
</div>
</div>
<a class="anchor" id="a6db2f8bc92bd7ee4dbbae9c3148a9040"></a><!-- doxytag: member="cbtree.h::cbtree_walker_func" ref="a6db2f8bc92bd7ee4dbbae9c3148a9040" args=")(void *ctx, void *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef bool(* <a class="el" href="cbtree_8h.html#a6db2f8bc92bd7ee4dbbae9c3148a9040">cbtree_walker_func</a>)(void *ctx, void *obj)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>walk over tree </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="adde759d374214dc26e811b8d24b90877"></a><!-- doxytag: member="cbtree.h::cbtree_create" ref="adde759d374214dc26e811b8d24b90877" args="(cbtree_getkey_func obj_key_cb, cbtree_walker_func obj_free_cb, void *cb_ctx, CxMem *cx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct CBTree* <a class="el" href="cbtree_8h.html#adde759d374214dc26e811b8d24b90877">cbtree_create</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cbtree_8h.html#a3ec9be73d9a460f3b5b1bd387e4ed14e">cbtree_getkey_func</a> </td>
<td class="paramname"><em>obj_key_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cbtree_8h.html#a6db2f8bc92bd7ee4dbbae9c3148a9040">cbtree_walker_func</a> </td>
<td class="paramname"><em>obj_free_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cb_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_cx_mem.html">CxMem</a> * </td>
<td class="paramname"><em>cx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new tree. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj_key_cb</td><td>callback to get the key for a object </td></tr>
<tr><td class="paramname">obj_free_cb</td><td>callback to free the object when tree node is freed (optional) </td></tr>
<tr><td class="paramname">cb_ctx</td><td>extra pointer passed to callbacks </td></tr>
<tr><td class="paramname">cx</td><td>memory context where from allocate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6a73ed80ee440afcd7d4f28ee8588103"></a><!-- doxytag: member="cbtree.h::cbtree_destroy" ref="a6a73ed80ee440afcd7d4f28ee8588103" args="(struct CBTree *tree)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="cbtree_8h.html#a6a73ed80ee440afcd7d4f28ee8588103">cbtree_destroy</a> </td>
<td>(</td>
<td class="paramtype">struct CBTree * </td>
<td class="paramname"><em>tree</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>frees all resources allocated. </p>
<p>If obj_free_cb is non-NULL, it will be called per each object. </p>
</div>
</div>
<a class="anchor" id="ac67a3ab11cf65924a5c7e518fa562922"></a><!-- doxytag: member="cbtree.h::cbtree_insert" ref="ac67a3ab11cf65924a5c7e518fa562922" args="(struct CBTree *tree, void *obj) _MUSTCHECK" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="cbtree_8h.html#ac67a3ab11cf65924a5c7e518fa562922">cbtree_insert</a> </td>
<td>(</td>
<td class="paramtype">struct CBTree * </td>
<td class="paramname"><em>tree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts new node to tree. </p>
</div>
</div>
<a class="anchor" id="a63ba3d18af01250d3222327d112eb97b"></a><!-- doxytag: member="cbtree.h::cbtree_delete" ref="a63ba3d18af01250d3222327d112eb97b" args="(struct CBTree *tree, const void *key, size_t klen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="cbtree_8h.html#a63ba3d18af01250d3222327d112eb97b">cbtree_delete</a> </td>
<td>(</td>
<td class="paramtype">struct CBTree * </td>
<td class="paramname"><em>tree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>klen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removed node from tree. </p>
<p>If obj_free_cb is non-NULL, it will be called for the object.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if key was found, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a9cb05aa0cb6b0c8ea70b27b88715bb15"></a><!-- doxytag: member="cbtree.h::cbtree_lookup" ref="a9cb05aa0cb6b0c8ea70b27b88715bb15" args="(struct CBTree *tree, const void *key, size_t klen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="cbtree_8h.html#a9cb05aa0cb6b0c8ea70b27b88715bb15">cbtree_lookup</a> </td>
<td>(</td>
<td class="paramtype">struct CBTree * </td>
<td class="paramname"><em>tree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>klen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup a key. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer if found, NULL ohterwise </dd></dl>
</div>
</div>
<a class="anchor" id="a64038ef46174a234598cab8dfebaef63"></a><!-- doxytag: member="cbtree.h::cbtree_walk" ref="a64038ef46174a234598cab8dfebaef63" args="(struct CBTree *tree, cbtree_walker_func cb_func, void *cb_arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="cbtree_8h.html#a64038ef46174a234598cab8dfebaef63">cbtree_walk</a> </td>
<td>(</td>
<td class="paramtype">struct CBTree * </td>
<td class="paramname"><em>tree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cbtree_8h.html#a6db2f8bc92bd7ee4dbbae9c3148a9040">cbtree_walker_func</a> </td>
<td class="paramname"><em>cb_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cb_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Walk over tree. </p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>