/usr/share/gtk-doc/html/libdazzle/libdazzle-dzl-heap.html is in libdazzle-doc 3.28.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dzl-heap: Dazzle Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Dazzle Reference Manual">
<link rel="up" href="dazzle-data-structures.html" title="Part XV. Data Structures">
<link rel="prev" href="libdazzle-dzl-int-pair.html" title="dzl-int-pair">
<link rel="next" href="libdazzle-dzl-ring.html" title="dzl-ring">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libdazzle-dzl-heap.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libdazzle-dzl-heap.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="dazzle-data-structures.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libdazzle-dzl-int-pair.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libdazzle-dzl-ring.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libdazzle-dzl-heap"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdazzle-dzl-heap.top_of_page"></a>dzl-heap</span></h2>
<p>dzl-heap</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdazzle-dzl-heap.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-insert-val" title="dzl_heap_insert_val()">dzl_heap_insert_val</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-index" title="dzl_heap_index()">dzl_heap_index</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-peek" title="dzl_heap_peek()">dzl_heap_peek</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="returnvalue">DzlHeap</span></a> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-new" title="dzl_heap_new ()">dzl_heap_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="returnvalue">DzlHeap</span></a> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-ref" title="dzl_heap_ref ()">dzl_heap_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-unref" title="dzl_heap_unref ()">dzl_heap_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-insert-vals" title="dzl_heap_insert_vals ()">dzl_heap_insert_vals</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-extract" title="dzl_heap_extract ()">dzl_heap_extract</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-heap.html#dzl-heap-extract-index" title="dzl_heap_extract_index ()">dzl_heap_extract_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="DzlHeap"></a><div class="refsect1">
<a name="libdazzle-dzl-heap.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GBoxed
<span class="lineart">╰──</span> DzlHeap
</pre>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-heap.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-heap.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dzl-heap-insert-val"></a><h3>dzl_heap_insert_val()</h3>
<pre class="programlisting">#define dzl_heap_insert_val(h,v) dzl_heap_insert_vals(h,&(v),1)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-index"></a><h3>dzl_heap_index()</h3>
<pre class="programlisting">#define dzl_heap_index(h,t,i) (((t*)(void*)(h)->data)[i])
</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-peek"></a><h3>dzl_heap_peek()</h3>
<pre class="programlisting">#define dzl_heap_peek(h,t) dzl_heap_index(h,t,0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-new"></a><h3>dzl_heap_new ()</h3>
<pre class="programlisting"><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="returnvalue">DzlHeap</span></a> *
dzl_heap_new (<em class="parameter"><code><span class="type">guint</span> element_size</code></em>,
<em class="parameter"><code><span class="type">GCompareFunc</span> compare_func</code></em>);</pre>
<p>Creates a new <a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a>. A heap is a tree-like structure stored in
an array that is not fully sorted, but head is guaranteed to be either
the max, or min value based on <em class="parameter"><code>compare_func</code></em>
. This is also known as
a priority queue.</p>
<div class="refsect3">
<a name="dzl-heap-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>element_size</p></td>
<td class="parameter_description"><p>the size of each element in the heap</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>compare_func</p></td>
<td class="parameter_description"><p>a function to compare to elements. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-heap-new.returns"></a><h4>Returns</h4>
<p>A newly allocated <a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-ref"></a><h3>dzl_heap_ref ()</h3>
<pre class="programlisting"><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="returnvalue">DzlHeap</span></a> *
dzl_heap_ref (<em class="parameter"><code><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a> *heap</code></em>);</pre>
<p>Increments the reference count of <em class="parameter"><code>heap</code></em>
by one.</p>
<div class="refsect3">
<a name="dzl-heap-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>heap</p></td>
<td class="parameter_description"><p>An <a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-heap-ref.returns"></a><h4>Returns</h4>
<p><em class="parameter"><code>heap</code></em>
. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-unref"></a><h3>dzl_heap_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dzl_heap_unref (<em class="parameter"><code><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a> *heap</code></em>);</pre>
<p>Decrements the reference count of <em class="parameter"><code>heap</code></em>
by one, freeing the structure
when the reference count reaches zero.</p>
<div class="refsect3">
<a name="dzl-heap-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>heap</p></td>
<td class="parameter_description"><p>An <a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-insert-vals"></a><h3>dzl_heap_insert_vals ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dzl_heap_insert_vals (<em class="parameter"><code><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a> *heap</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>,
<em class="parameter"><code><span class="type">guint</span> len</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-extract"></a><h3>dzl_heap_extract ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dzl_heap_extract (<em class="parameter"><code><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a> *heap</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> result</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-heap-extract-index"></a><h3>dzl_heap_extract_index ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dzl_heap_extract_index (<em class="parameter"><code><a class="link" href="libdazzle-dzl-heap.html#DzlHeap"><span class="type">DzlHeap</span></a> *heap</code></em>,
<em class="parameter"><code><span class="type">gsize</span> index_</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> result</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-heap.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|