-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathheap_8h.html
350 lines (313 loc) · 15.2 KB
/
heap_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
339
340
341
342
343
344
345
346
347
348
349
350
<!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/heap.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/heap.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary heap.
<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 bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#ade458efc5a8528c137bd8e8d846891d0">heap_is_better_f</a> )(const void *a, const void *b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Object comparision function. <a href="#ade458efc5a8528c137bd8e8d846891d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a6bead63b8a558fe05c2756c5e08eab3d">heap_save_pos_f</a> )(void *a, unsigned pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Heap position storage. <a href="#a6bead63b8a558fe05c2756c5e08eab3d"></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 Heap * </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a82260a50a84135a11d23ad123b0d3135">heap_create</a> (<a class="el" href="heap_8h.html#ade458efc5a8528c137bd8e8d846891d0">heap_is_better_f</a> is_better_cb, <a class="el" href="heap_8h.html#a6bead63b8a558fe05c2756c5e08eab3d">heap_save_pos_f</a> save_pos_cb, <a class="el" href="struct_cx_mem.html">CxMem</a> *cx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new heap object. <a href="#a82260a50a84135a11d23ad123b0d3135"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a9291a184af3035b7155a17d95f003903">heap_destroy</a> (struct Heap *h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release memory allocated by heap. <a href="#a9291a184af3035b7155a17d95f003903"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a10293158702cb44e1a30e4f2e5d57ab6">heap_push</a> (struct Heap *h, void *ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put new object into heap. <a href="#a10293158702cb44e1a30e4f2e5d57ab6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a5f1402e2a3aef05aaf8efa261f93cb23">heap_pop</a> (struct Heap *h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove and return topmost object from heap. <a href="#a5f1402e2a3aef05aaf8efa261f93cb23"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a86d0c16ac720c1e39fe2f6d3b198c1ad">heap_top</a> (struct Heap *h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return topmost object in heap. <a href="#a86d0c16ac720c1e39fe2f6d3b198c1ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#aff592c6e0dd7154844db32d2eceac84e">heap_remove</a> (struct Heap *h, unsigned pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove and return any object from heap by index. <a href="#aff592c6e0dd7154844db32d2eceac84e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#a95ba38631786f31387100ff3dc7829c5">heap_reserve</a> (struct Heap *h, unsigned extra)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reserve room for more elements. <a href="#a95ba38631786f31387100ff3dc7829c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="heap_8h.html#aca651bb9ef1f65b6f478edfb04e3a589">heap_size</a> (struct Heap *h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return number of objects in heap. <a href="#aca651bb9ef1f65b6f478edfb04e3a589"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Binary heap. </p>
<p>Binary heap is sort of binary tree held inside array, with following 2 properties:</p>
<ul>
<li>heap property: each node is "better" than it's childs.</li>
<li>shape property: binary tree is complete, meaning all levels except the last one are fully filled.</li>
</ul>
<p>Instead of "min"- or "max"-heap, this is "best"-heap, as it operates with user-defined heap_is_better() functions, which is used to bubble elements on top. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ade458efc5a8528c137bd8e8d846891d0"></a><!-- doxytag: member="heap.h::heap_is_better_f" ref="ade458efc5a8528c137bd8e8d846891d0" args=")(const void *a, const void *b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef bool(* <a class="el" href="heap_8h.html#ade458efc5a8528c137bd8e8d846891d0">heap_is_better_f</a>)(const void *a, const void *b)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Object comparision function. </p>
<p>Should return true if a needs to reach top before b, false if not or equal. </p>
</div>
</div>
<a class="anchor" id="a6bead63b8a558fe05c2756c5e08eab3d"></a><!-- doxytag: member="heap.h::heap_save_pos_f" ref="a6bead63b8a558fe05c2756c5e08eab3d" args=")(void *a, unsigned pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="heap_8h.html#a6bead63b8a558fe05c2756c5e08eab3d">heap_save_pos_f</a>)(void *a, unsigned pos)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Heap position storage. </p>
<p>If user wants to delete elements from the middle of heap, this function should be used to keep track where the element is located. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a82260a50a84135a11d23ad123b0d3135"></a><!-- doxytag: member="heap.h::heap_create" ref="a82260a50a84135a11d23ad123b0d3135" args="(heap_is_better_f is_better_cb, heap_save_pos_f save_pos_cb, CxMem *cx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct Heap* <a class="el" href="heap_8h.html#a82260a50a84135a11d23ad123b0d3135">heap_create</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="heap_8h.html#ade458efc5a8528c137bd8e8d846891d0">heap_is_better_f</a> </td>
<td class="paramname"><em>is_better_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="heap_8h.html#a6bead63b8a558fe05c2756c5e08eab3d">heap_save_pos_f</a> </td>
<td class="paramname"><em>save_pos_cb</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 heap object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">is_better_cb</td><td>Callback to decide priority. </td></tr>
<tr><td class="paramname">save_pos_cb</td><td>Callback to store current index. </td></tr>
<tr><td class="paramname">cx</td><td>Allocation context. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9291a184af3035b7155a17d95f003903"></a><!-- doxytag: member="heap.h::heap_destroy" ref="a9291a184af3035b7155a17d95f003903" args="(struct Heap *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="heap_8h.html#a9291a184af3035b7155a17d95f003903">heap_destroy</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release memory allocated by heap. </p>
</div>
</div>
<a class="anchor" id="a10293158702cb44e1a30e4f2e5d57ab6"></a><!-- doxytag: member="heap.h::heap_push" ref="a10293158702cb44e1a30e4f2e5d57ab6" args="(struct Heap *h, void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="heap_8h.html#a10293158702cb44e1a30e4f2e5d57ab6">heap_push</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put new object into heap. </p>
</div>
</div>
<a class="anchor" id="a5f1402e2a3aef05aaf8efa261f93cb23"></a><!-- doxytag: member="heap.h::heap_pop" ref="a5f1402e2a3aef05aaf8efa261f93cb23" args="(struct Heap *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="heap_8h.html#a5f1402e2a3aef05aaf8efa261f93cb23">heap_pop</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove and return topmost object from heap. </p>
</div>
</div>
<a class="anchor" id="a86d0c16ac720c1e39fe2f6d3b198c1ad"></a><!-- doxytag: member="heap.h::heap_top" ref="a86d0c16ac720c1e39fe2f6d3b198c1ad" args="(struct Heap *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="heap_8h.html#a86d0c16ac720c1e39fe2f6d3b198c1ad">heap_top</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return topmost object in heap. </p>
</div>
</div>
<a class="anchor" id="aff592c6e0dd7154844db32d2eceac84e"></a><!-- doxytag: member="heap.h::heap_remove" ref="aff592c6e0dd7154844db32d2eceac84e" args="(struct Heap *h, unsigned pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="heap_8h.html#aff592c6e0dd7154844db32d2eceac84e">heap_remove</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>pos</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove and return any object from heap by index. </p>
</div>
</div>
<a class="anchor" id="a95ba38631786f31387100ff3dc7829c5"></a><!-- doxytag: member="heap.h::heap_reserve" ref="a95ba38631786f31387100ff3dc7829c5" args="(struct Heap *h, unsigned extra)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="heap_8h.html#a95ba38631786f31387100ff3dc7829c5">heap_reserve</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>extra</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reserve room for more elements. </p>
<p>Returns false if allocation failed. </p>
</div>
</div>
<a class="anchor" id="aca651bb9ef1f65b6f478edfb04e3a589"></a><!-- doxytag: member="heap.h::heap_size" ref="aca651bb9ef1f65b6f478edfb04e3a589" args="(struct Heap *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="heap_8h.html#aca651bb9ef1f65b6f478edfb04e3a589">heap_size</a> </td>
<td>(</td>
<td class="paramtype">struct Heap * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return number of objects in heap. </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>