EVOLUTION-MANAGER
Edit File: oggz__table_8h_source.html
<!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>liboggz: oggz_table.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="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">liboggz  <span id="projectnumber">1.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d87111fb9e25a5f2a11bf853c53bb708.html">oggz</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">oggz_table.h</div> </div> </div><!--header--> <div class="contents"> <a href="oggz__table_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 (C) 2003 Commonwealth Scientific and Industrial Research</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Organisation (CSIRO) Australia</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"> Redistribution and use in source and binary forms, with or without</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> modification, are permitted provided that the following conditions</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> are met:</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"> - Redistributions of source code must retain the above copyright</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> notice, this list of conditions and the following disclaimer.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> - Redistributions in binary form must reproduce the above copyright</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> notice, this list of conditions and the following disclaimer in the</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> documentation and/or other materials provided with the distribution.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> - Neither the name of CSIRO Australia nor the names of its</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> contributors may be used to endorse or promote products derived from</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> this software without specific prior written permission.</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</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> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef __OGGZ_TABLE_H__</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_TABLE_H__</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023"> 46</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a>;</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> *</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <a class="code" href="oggz__table_8h.html#a40772505443484de93526882c48f0dd8">oggz_table_new</a> (<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">void</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <a class="code" href="oggz__table_8h.html#a989e307feecf2adc2ebe905c067051c4">oggz_table_delete</a> (<a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * table);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> *</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <a class="code" href="oggz__table_8h.html#adbcdb0cdf6e8392c78956e911cbf6634">oggz_table_insert</a> (<a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * table, <span class="keywordtype">long</span> key, <span class="keywordtype">void</span> * data);</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">int</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <a class="code" href="oggz__table_8h.html#ac137e535f1da63ee52266b47f114020f">oggz_table_remove</a> (<a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * table, <span class="keywordtype">long</span> key);</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">void</span> *</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <a class="code" href="oggz__table_8h.html#a92ea55bffd5657be29cf1972f33364e3">oggz_table_lookup</a> (<a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * table, <span class="keywordtype">long</span> key);</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">int</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <a class="code" href="oggz__table_8h.html#a62db2037df45db88a75b89b8a8ac7766">oggz_table_size</a> (<a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * table);</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">void</span> *</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <a class="code" href="oggz__table_8h.html#a285c3cbdb46e9b8c2a831728182856f1">oggz_table_nth</a> (<a class="code" href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a> * table, <span class="keywordtype">int</span> n, <span class="keywordtype">long</span> * key);</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="preprocessor">#endif </span><span class="comment">/* __OGGZ_TABLE_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="oggz__table_8h_html_a72c5d21d2254089d192176e1c310b023"><div class="ttname"><a href="oggz__table_8h.html#a72c5d21d2254089d192176e1c310b023">OggzTable</a></div><div class="ttdeci">void OggzTable</div><div class="ttdoc">A table of key-value pairs. </div><div class="ttdef"><b>Definition:</b> oggz_table.h:46</div></div> <div class="ttc" id="oggz__table_8h_html_a92ea55bffd5657be29cf1972f33364e3"><div class="ttname"><a href="oggz__table_8h.html#a92ea55bffd5657be29cf1972f33364e3">oggz_table_lookup</a></div><div class="ttdeci">void * oggz_table_lookup(OggzTable *table, long key)</div><div class="ttdoc">Retrieve the element of an OggzTable indexed by a given key. </div></div> <div class="ttc" id="oggz__table_8h_html_a62db2037df45db88a75b89b8a8ac7766"><div class="ttname"><a href="oggz__table_8h.html#a62db2037df45db88a75b89b8a8ac7766">oggz_table_size</a></div><div class="ttdeci">int oggz_table_size(OggzTable *table)</div><div class="ttdoc">Query the number of elements in an OggzTable. </div></div> <div class="ttc" id="oggz__table_8h_html_ac137e535f1da63ee52266b47f114020f"><div class="ttname"><a href="oggz__table_8h.html#ac137e535f1da63ee52266b47f114020f">oggz_table_remove</a></div><div class="ttdeci">int oggz_table_remove(OggzTable *table, long key)</div><div class="ttdoc">Remove the element of an OggzTable indexed by a given key. </div></div> <div class="ttc" id="oggz__table_8h_html_a285c3cbdb46e9b8c2a831728182856f1"><div class="ttname"><a href="oggz__table_8h.html#a285c3cbdb46e9b8c2a831728182856f1">oggz_table_nth</a></div><div class="ttdeci">void * oggz_table_nth(OggzTable *table, int n, long *key)</div><div class="ttdoc">Retrieve the nth element of an OggzTable, and optionally its key. </div></div> <div class="ttc" id="oggz__table_8h_html_adbcdb0cdf6e8392c78956e911cbf6634"><div class="ttname"><a href="oggz__table_8h.html#adbcdb0cdf6e8392c78956e911cbf6634">oggz_table_insert</a></div><div class="ttdeci">void * oggz_table_insert(OggzTable *table, long key, void *data)</div><div class="ttdoc">Insert an element into a table. </div></div> <div class="ttc" id="oggz__table_8h_html_a989e307feecf2adc2ebe905c067051c4"><div class="ttname"><a href="oggz__table_8h.html#a989e307feecf2adc2ebe905c067051c4">oggz_table_delete</a></div><div class="ttdeci">void oggz_table_delete(OggzTable *table)</div><div class="ttdoc">Delete an OggzTable. </div></div> <div class="ttc" id="oggz__table_8h_html_a40772505443484de93526882c48f0dd8"><div class="ttname"><a href="oggz__table_8h.html#a40772505443484de93526882c48f0dd8">oggz_table_new</a></div><div class="ttdeci">OggzTable * oggz_table_new(void)</div><div class="ttdoc">Instantiate a new OggzTable. </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>