%PDF-
%PDF-
Mini Shell
Mini Shell
<!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"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Nagios: pqueue.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nagios
 <span id="projectnumber">4.4.3</span>
</div>
<div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pqueue.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="pqueue_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2010 Volkan Yazıcı <volkan.yazici@gmail.com></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2006-2010 The Apache Software Foundation</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may not</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * use this file except in compliance with the License. You may obtain a copy of</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * License for the specific language governing permissions and limitations under</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef LIBNAGIOS_PQUEUE_H_INCLUDED</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define LIBNAGIOS_PQUEUE_H_INCLUDED</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @file pqueue.h</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @brief Priority Queue function declarations</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * This priority queue library was originally written by Volkan Yazici</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * <volkan.yazici@gmail.com>. It was lated adapted for Nagios by</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * Andreas Ericsson <ae@op5.se>. Changes compared to the original</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * version are pretty much limited to changing pqueue_pri_t to be</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * an unsigned long long instead of a double, since ULL comparisons</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * are 107 times faster on my 64-bit laptop.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @{</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/** priority data type (used to be double, but ull is 107 times faster) */</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0"> 37</a></span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/** callback functions to get/set/compare the priority of an element */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="pqueue_8h.html#a38084a4351e971e28de23eecceb9d35f"> 40</a></span> <span class="keyword">typedef</span> <a class="code" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a> (*<a class="code" href="pqueue_8h.html#a38084a4351e971e28de23eecceb9d35f">pqueue_get_pri_f</a>)(<span class="keywordtype">void</span> *a);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">typedef</span> void (*pqueue_set_pri_f)(<span class="keywordtype">void</span> *a, <a class="code" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a> pri);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">typedef</span> int (*pqueue_cmp_pri_f)(<a class="code" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a> next, <a class="code" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a> curr);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/** callback functions to get/set the position of an element */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="pqueue_8h.html#a2a2749e6a768ec390487f98a5e635c2c"> 46</a></span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> int (*<a class="code" href="pqueue_8h.html#a2a2749e6a768ec390487f98a5e635c2c">pqueue_get_pos_f</a>)(<span class="keywordtype">void</span> *a);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">typedef</span> void (*pqueue_set_pos_f)(<span class="keywordtype">void</span> *a, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pos);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/** debug callback function to print a entry */</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="pqueue_8h.html#a7783c5555cd76c54e1b47ef0e361452c"> 51</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="pqueue_8h.html#a7783c5555cd76c54e1b47ef0e361452c">pqueue_print_entry_f</a>)(FILE *out, <span class="keywordtype">void</span> *a);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/** the priority queue handle */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structpqueue__t.html"> 55</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpqueue__t.html">pqueue_t</a></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structpqueue__t.html#a6eae83e23ba8eea1e5ac92b11a810f89"> 57</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structpqueue__t.html#a6eae83e23ba8eea1e5ac92b11a810f89">size</a>; <span class="comment">/**< number of elements in this queue */</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structpqueue__t.html#a8345828f69735fd5c42e972e4352b9ec"> 58</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structpqueue__t.html#a8345828f69735fd5c42e972e4352b9ec">avail</a>; <span class="comment">/**< slots available in this queue */</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structpqueue__t.html#a489e4199b546a3122d50673ffa09cb85"> 59</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structpqueue__t.html#a489e4199b546a3122d50673ffa09cb85">step</a>; <span class="comment">/**< growth stepping setting */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structpqueue__t.html#af44c1953e47510529147cfbea33489ef"> 60</a></span>  pqueue_cmp_pri_f <a class="code" href="structpqueue__t.html#af44c1953e47510529147cfbea33489ef">cmppri</a>; <span class="comment">/**< callback to compare nodes */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structpqueue__t.html#ae1c098eb8c14bdfbce6797ede3f0c387"> 61</a></span>  <a class="code" href="pqueue_8h.html#a38084a4351e971e28de23eecceb9d35f">pqueue_get_pri_f</a> <a class="code" href="structpqueue__t.html#ae1c098eb8c14bdfbce6797ede3f0c387">getpri</a>; <span class="comment">/**< callback to get priority of a node */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structpqueue__t.html#ab6c06f219a79bd53f024c6f205cee104"> 62</a></span>  pqueue_set_pri_f <a class="code" href="structpqueue__t.html#ab6c06f219a79bd53f024c6f205cee104">setpri</a>; <span class="comment">/**< callback to set priority of a node */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structpqueue__t.html#a20a38eccf17fb90e2c483503326c3fba"> 63</a></span>  <a class="code" href="pqueue_8h.html#a2a2749e6a768ec390487f98a5e635c2c">pqueue_get_pos_f</a> <a class="code" href="structpqueue__t.html#a20a38eccf17fb90e2c483503326c3fba">getpos</a>; <span class="comment">/**< callback to get position of a node */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structpqueue__t.html#a0960bed72e0c851bccf1591c39360c73"> 64</a></span>  pqueue_set_pos_f <a class="code" href="structpqueue__t.html#a0960bed72e0c851bccf1591c39360c73">setpos</a>; <span class="comment">/**< callback to set position of a node */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structpqueue__t.html#a92b9ee0486259382e9087cd1f05f2792"> 65</a></span>  <span class="keywordtype">void</span> **<a class="code" href="structpqueue__t.html#a92b9ee0486259382e9087cd1f05f2792">d</a>; <span class="comment">/**< The actual queue in binary heap form */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> } <a class="code" href="pqueue_8h.html#a02a7250504cf9d7171525d712ace44c8">pqueue_t</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * initialize the queue</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @param n the initial estimate of the number of queue items for which memory</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * should be preallocated</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @param cmppri The callback function to run to compare two elements</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * This callback should return 0 for 'lower' and non-zero</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * for 'higher', or vice versa if reverse priority is desired</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @param setpri the callback function to run to assign a score to an element</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @param getpri the callback function to run to set a score to an element</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param getpos the callback function to get the current element's position</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param setpos the callback function to set the current element's position</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @return the handle or NULL for insufficient memory</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <a class="code" href="structpqueue__t.html">pqueue_t</a> *</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="pqueue_8h.html#ab2b72569a55517ab868d59217e60699a">pqueue_init</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  pqueue_cmp_pri_f cmppri,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="pqueue_8h.html#a38084a4351e971e28de23eecceb9d35f">pqueue_get_pri_f</a> getpri,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  pqueue_set_pri_f setpri,</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="pqueue_8h.html#a2a2749e6a768ec390487f98a5e635c2c">pqueue_get_pos_f</a> getpos,</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  pqueue_set_pos_f setpos);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * free all memory used by the queue</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">void</span> <a class="code" href="pqueue_8h.html#acceacc4429dd9cd31d5af09f3f473cb0">pqueue_free</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * return the size of the queue.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="pqueue_8h.html#a6dcf77d1704e7735db663f4a3e274133">pqueue_size</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * insert an item into the queue.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param d the item</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @return 0 on success</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">int</span> <a class="code" href="pqueue_8h.html#addd8cdfbc8c47b8cdd7eb4c4560de7aa">pqueue_insert</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q, <span class="keywordtype">void</span> *d);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * move an existing entry to a different priority</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param new_pri the new priority</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param d the entry</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <a class="code" href="pqueue_8h.html#a7dfaa607ca404b915355d4b123c669ee">pqueue_change_priority</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q,</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a> new_pri,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> *d);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"></span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * pop the highest-ranking item from the queue.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @return NULL on error, otherwise the entry</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">void</span> *<a class="code" href="pqueue_8h.html#abec9363c7a9cc89190bf0925a4a1652c">pqueue_pop</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * remove an item from the queue.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @param d the entry</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * @return 0 on success</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">int</span> <a class="code" href="pqueue_8h.html#a9a509654dacb6be3d34ff7a4958ab4dd">pqueue_remove</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q, <span class="keywordtype">void</span> *d);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"></span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * access highest-ranking item without removing it.</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @return NULL on error, otherwise the entry</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="keywordtype">void</span> *<a class="code" href="pqueue_8h.html#a2919d3e817688b81da746d4123f51ba3">pqueue_peek</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"></span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * print the queue</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @internal</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * DEBUG function only</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @param out the output handle</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @param the callback function to print the entry</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <a class="code" href="pqueue_8h.html#a8c5b724e07dbf478147835a06ed64d42">pqueue_print</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q, FILE *out, <a class="code" href="pqueue_8h.html#a7783c5555cd76c54e1b47ef0e361452c">pqueue_print_entry_f</a> print);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"></span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * dump the queue and it's internal structure</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @internal</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * debug function only</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @param out the output handle</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * @param the callback function to print the entry</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="keywordtype">void</span> <a class="code" href="pqueue_8h.html#ae438267d8665f75709c9a9248923f32e">pqueue_dump</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q, FILE *out, <a class="code" href="pqueue_8h.html#a7783c5555cd76c54e1b47ef0e361452c">pqueue_print_entry_f</a> print);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * checks that the pq is in the right order, etc</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * @internal</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * debug function only</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @param q the queue</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keywordtype">int</span> <a class="code" href="pqueue_8h.html#aecb92aa04f03ad7866508bc27778d7e9">pqueue_is_valid</a>(<a class="code" href="structpqueue__t.html">pqueue_t</a> *q);</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor"></span><span class="comment">/** @} */</span></div>
<div class="ttc" id="pqueue_8h_html_a8c5b724e07dbf478147835a06ed64d42"><div class="ttname"><a href="pqueue_8h.html#a8c5b724e07dbf478147835a06ed64d42">pqueue_print</a></div><div class="ttdeci">void pqueue_print(pqueue_t *q, FILE *out, pqueue_print_entry_f print)</div><div class="ttdoc">print the queue </div></div>
<div class="ttc" id="pqueue_8h_html_acceacc4429dd9cd31d5af09f3f473cb0"><div class="ttname"><a href="pqueue_8h.html#acceacc4429dd9cd31d5af09f3f473cb0">pqueue_free</a></div><div class="ttdeci">void pqueue_free(pqueue_t *q)</div><div class="ttdoc">free all memory used by the queue </div></div>
<div class="ttc" id="pqueue_8h_html_ad8239ddc32134716f57e54bb972f6bf0"><div class="ttname"><a href="pqueue_8h.html#ad8239ddc32134716f57e54bb972f6bf0">pqueue_pri_t</a></div><div class="ttdeci">unsigned long long pqueue_pri_t</div><div class="ttdoc">priority data type (used to be double, but ull is 107 times faster) </div><div class="ttdef"><b>Definition:</b> pqueue.h:37</div></div>
<div class="ttc" id="pqueue_8h_html_ae438267d8665f75709c9a9248923f32e"><div class="ttname"><a href="pqueue_8h.html#ae438267d8665f75709c9a9248923f32e">pqueue_dump</a></div><div class="ttdeci">void pqueue_dump(pqueue_t *q, FILE *out, pqueue_print_entry_f print)</div><div class="ttdoc">dump the queue and it&#39;s internal structure </div></div>
<div class="ttc" id="structpqueue__t_html_a489e4199b546a3122d50673ffa09cb85"><div class="ttname"><a href="structpqueue__t.html#a489e4199b546a3122d50673ffa09cb85">pqueue_t::step</a></div><div class="ttdeci">unsigned int step</div><div class="ttdoc">growth stepping setting </div><div class="ttdef"><b>Definition:</b> pqueue.h:59</div></div>
<div class="ttc" id="structpqueue__t_html_ae1c098eb8c14bdfbce6797ede3f0c387"><div class="ttname"><a href="structpqueue__t.html#ae1c098eb8c14bdfbce6797ede3f0c387">pqueue_t::getpri</a></div><div class="ttdeci">pqueue_get_pri_f getpri</div><div class="ttdoc">callback to get priority of a node </div><div class="ttdef"><b>Definition:</b> pqueue.h:61</div></div>
<div class="ttc" id="pqueue_8h_html_addd8cdfbc8c47b8cdd7eb4c4560de7aa"><div class="ttname"><a href="pqueue_8h.html#addd8cdfbc8c47b8cdd7eb4c4560de7aa">pqueue_insert</a></div><div class="ttdeci">int pqueue_insert(pqueue_t *q, void *d)</div><div class="ttdoc">insert an item into the queue. </div></div>
<div class="ttc" id="structpqueue__t_html"><div class="ttname"><a href="structpqueue__t.html">pqueue_t</a></div><div class="ttdoc">the priority queue handle </div><div class="ttdef"><b>Definition:</b> pqueue.h:55</div></div>
<div class="ttc" id="pqueue_8h_html_a2919d3e817688b81da746d4123f51ba3"><div class="ttname"><a href="pqueue_8h.html#a2919d3e817688b81da746d4123f51ba3">pqueue_peek</a></div><div class="ttdeci">void * pqueue_peek(pqueue_t *q)</div><div class="ttdoc">access highest-ranking item without removing it. </div></div>
<div class="ttc" id="pqueue_8h_html_a38084a4351e971e28de23eecceb9d35f"><div class="ttname"><a href="pqueue_8h.html#a38084a4351e971e28de23eecceb9d35f">pqueue_get_pri_f</a></div><div class="ttdeci">pqueue_pri_t(* pqueue_get_pri_f)(void *a)</div><div class="ttdoc">callback functions to get/set/compare the priority of an element </div><div class="ttdef"><b>Definition:</b> pqueue.h:40</div></div>
<div class="ttc" id="pqueue_8h_html_a7dfaa607ca404b915355d4b123c669ee"><div class="ttname"><a href="pqueue_8h.html#a7dfaa607ca404b915355d4b123c669ee">pqueue_change_priority</a></div><div class="ttdeci">void pqueue_change_priority(pqueue_t *q, pqueue_pri_t new_pri, void *d)</div><div class="ttdoc">move an existing entry to a different priority </div></div>
<div class="ttc" id="structpqueue__t_html_a0960bed72e0c851bccf1591c39360c73"><div class="ttname"><a href="structpqueue__t.html#a0960bed72e0c851bccf1591c39360c73">pqueue_t::setpos</a></div><div class="ttdeci">pqueue_set_pos_f setpos</div><div class="ttdoc">callback to set position of a node </div><div class="ttdef"><b>Definition:</b> pqueue.h:64</div></div>
<div class="ttc" id="structpqueue__t_html_a20a38eccf17fb90e2c483503326c3fba"><div class="ttname"><a href="structpqueue__t.html#a20a38eccf17fb90e2c483503326c3fba">pqueue_t::getpos</a></div><div class="ttdeci">pqueue_get_pos_f getpos</div><div class="ttdoc">callback to get position of a node </div><div class="ttdef"><b>Definition:</b> pqueue.h:63</div></div>
<div class="ttc" id="pqueue_8h_html_a9a509654dacb6be3d34ff7a4958ab4dd"><div class="ttname"><a href="pqueue_8h.html#a9a509654dacb6be3d34ff7a4958ab4dd">pqueue_remove</a></div><div class="ttdeci">int pqueue_remove(pqueue_t *q, void *d)</div><div class="ttdoc">remove an item from the queue. </div></div>
<div class="ttc" id="structpqueue__t_html_ab6c06f219a79bd53f024c6f205cee104"><div class="ttname"><a href="structpqueue__t.html#ab6c06f219a79bd53f024c6f205cee104">pqueue_t::setpri</a></div><div class="ttdeci">pqueue_set_pri_f setpri</div><div class="ttdoc">callback to set priority of a node </div><div class="ttdef"><b>Definition:</b> pqueue.h:62</div></div>
<div class="ttc" id="structpqueue__t_html_a6eae83e23ba8eea1e5ac92b11a810f89"><div class="ttname"><a href="structpqueue__t.html#a6eae83e23ba8eea1e5ac92b11a810f89">pqueue_t::size</a></div><div class="ttdeci">unsigned int size</div><div class="ttdoc">number of elements in this queue </div><div class="ttdef"><b>Definition:</b> pqueue.h:57</div></div>
<div class="ttc" id="pqueue_8h_html_ab2b72569a55517ab868d59217e60699a"><div class="ttname"><a href="pqueue_8h.html#ab2b72569a55517ab868d59217e60699a">pqueue_init</a></div><div class="ttdeci">pqueue_t * pqueue_init(unsigned int n, pqueue_cmp_pri_f cmppri, pqueue_get_pri_f getpri, pqueue_set_pri_f setpri, pqueue_get_pos_f getpos, pqueue_set_pos_f setpos)</div><div class="ttdoc">initialize the queue </div></div>
<div class="ttc" id="pqueue_8h_html_a2a2749e6a768ec390487f98a5e635c2c"><div class="ttname"><a href="pqueue_8h.html#a2a2749e6a768ec390487f98a5e635c2c">pqueue_get_pos_f</a></div><div class="ttdeci">unsigned int(* pqueue_get_pos_f)(void *a)</div><div class="ttdoc">callback functions to get/set the position of an element </div><div class="ttdef"><b>Definition:</b> pqueue.h:46</div></div>
<div class="ttc" id="pqueue_8h_html_aecb92aa04f03ad7866508bc27778d7e9"><div class="ttname"><a href="pqueue_8h.html#aecb92aa04f03ad7866508bc27778d7e9">pqueue_is_valid</a></div><div class="ttdeci">int pqueue_is_valid(pqueue_t *q)</div><div class="ttdoc">checks that the pq is in the right order, etc </div></div>
<div class="ttc" id="pqueue_8h_html_a02a7250504cf9d7171525d712ace44c8"><div class="ttname"><a href="pqueue_8h.html#a02a7250504cf9d7171525d712ace44c8">pqueue_t</a></div><div class="ttdeci">struct pqueue_t pqueue_t</div><div class="ttdoc">the priority queue handle </div></div>
<div class="ttc" id="structpqueue__t_html_a92b9ee0486259382e9087cd1f05f2792"><div class="ttname"><a href="structpqueue__t.html#a92b9ee0486259382e9087cd1f05f2792">pqueue_t::d</a></div><div class="ttdeci">void ** d</div><div class="ttdoc">The actual queue in binary heap form. </div><div class="ttdef"><b>Definition:</b> pqueue.h:65</div></div>
<div class="ttc" id="pqueue_8h_html_a6dcf77d1704e7735db663f4a3e274133"><div class="ttname"><a href="pqueue_8h.html#a6dcf77d1704e7735db663f4a3e274133">pqueue_size</a></div><div class="ttdeci">unsigned int pqueue_size(pqueue_t *q)</div><div class="ttdoc">return the size of the queue. </div></div>
<div class="ttc" id="pqueue_8h_html_abec9363c7a9cc89190bf0925a4a1652c"><div class="ttname"><a href="pqueue_8h.html#abec9363c7a9cc89190bf0925a4a1652c">pqueue_pop</a></div><div class="ttdeci">void * pqueue_pop(pqueue_t *q)</div><div class="ttdoc">pop the highest-ranking item from the queue. </div></div>
<div class="ttc" id="structpqueue__t_html_a8345828f69735fd5c42e972e4352b9ec"><div class="ttname"><a href="structpqueue__t.html#a8345828f69735fd5c42e972e4352b9ec">pqueue_t::avail</a></div><div class="ttdeci">unsigned int avail</div><div class="ttdoc">slots available in this queue </div><div class="ttdef"><b>Definition:</b> pqueue.h:58</div></div>
<div class="ttc" id="structpqueue__t_html_af44c1953e47510529147cfbea33489ef"><div class="ttname"><a href="structpqueue__t.html#af44c1953e47510529147cfbea33489ef">pqueue_t::cmppri</a></div><div class="ttdeci">pqueue_cmp_pri_f cmppri</div><div class="ttdoc">callback to compare nodes </div><div class="ttdef"><b>Definition:</b> pqueue.h:60</div></div>
<div class="ttc" id="pqueue_8h_html_a7783c5555cd76c54e1b47ef0e361452c"><div class="ttname"><a href="pqueue_8h.html#a7783c5555cd76c54e1b47ef0e361452c">pqueue_print_entry_f</a></div><div class="ttdeci">void(* pqueue_print_entry_f)(FILE *out, void *a)</div><div class="ttdoc">debug callback function to print a entry </div><div class="ttdef"><b>Definition:</b> pqueue.h:51</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<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.8.5
</small></address>
</body>
</html>
Zerion Mini Shell 1.0