aatree_8h.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"/>
<title>libusual: usual/aatree.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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;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&#160;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="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">usual/aatree.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>AA-Tree - Binary tree with embeddable nodes.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_a_tree.html">AATree</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tree header, for storing helper functions.  <a href="struct_a_a_tree.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_a_node.html">AANode</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tree node.  <a href="struct_a_a_node.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#a8477ca7a04ef24eb52f6ef8a502449ed">aatree_cmp_f</a> )(uintptr_t, struct <a class="el" href="struct_a_a_node.html">AANode</a> *node)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for node comparision against value.  <a href="#a8477ca7a04ef24eb52f6ef8a502449ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#ae3855055f37242d29c5771cbc4c67254">aatree_walker_f</a> )(struct <a class="el" href="struct_a_a_node.html">AANode</a> *n, void *arg)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for walking the tree.  <a href="#ae3855055f37242d29c5771cbc4c67254"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#a1d0d0399860e0a87d64743fb4e427b24">AATreeWalkType</a> </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Walk order types.  <a href="aatree_8h.html#a1d0d0399860e0a87d64743fb4e427b24">More...</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">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#a7019ff630481fd809ef557b17b12b8d1">aatree_init</a> (struct <a class="el" href="struct_a_a_tree.html">AATree</a> *tree, <a class="el" href="aatree_8h.html#a8477ca7a04ef24eb52f6ef8a502449ed">aatree_cmp_f</a> cmpfn, <a class="el" href="aatree_8h.html#ae3855055f37242d29c5771cbc4c67254">aatree_walker_f</a> release_cb)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize structure.  <a href="#a7019ff630481fd809ef557b17b12b8d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_a_a_node.html">AANode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#a69ffbc57b2012f97e603ef0001e56b4a">aatree_search</a> (struct <a class="el" href="struct_a_a_tree.html">AATree</a> *tree, uintptr_t value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Search for node.  <a href="#a69ffbc57b2012f97e603ef0001e56b4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#a13500a0f84b627c396b7838a553ac84d">aatree_insert</a> (struct <a class="el" href="struct_a_a_tree.html">AATree</a> *tree, uintptr_t value, struct <a class="el" href="struct_a_a_node.html">AANode</a> *node)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert new node.  <a href="#a13500a0f84b627c396b7838a553ac84d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#aba162e89353c02f4ef27e635b500c03d">aatree_remove</a> (struct <a class="el" href="struct_a_a_tree.html">AATree</a> *tree, uintptr_t value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Remote node.  <a href="#aba162e89353c02f4ef27e635b500c03d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#aef87e78c43c5dea616ecceae78f96b9c">aatree_walk</a> (struct <a class="el" href="struct_a_a_tree.html">AATree</a> *tree, enum <a class="el" href="aatree_8h.html#a1d0d0399860e0a87d64743fb4e427b24">AATreeWalkType</a> wtype, <a class="el" href="aatree_8h.html#ae3855055f37242d29c5771cbc4c67254">aatree_walker_f</a> walker, void *arg)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Walk over all nodes.  <a href="#aef87e78c43c5dea616ecceae78f96b9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#a153c4d70eed5a2572634bccf3f9ef649">aatree_destroy</a> (struct <a class="el" href="struct_a_a_tree.html">AATree</a> *tree)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Free.  <a href="#a153c4d70eed5a2572634bccf3f9ef649"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="aatree_8h.html#ad515b368bcd42014288d95426284a619">aatree_is_nil_node</a> (const struct <a class="el" href="struct_a_a_node.html">AANode</a> *node)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if terminal node.  <a href="#ad515b368bcd42014288d95426284a619"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>AA-Tree - Binary tree with embeddable nodes. </p>
<p>AA-Tree (Arne Andersson tree) is a simplified Red-Black tree. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a8477ca7a04ef24eb52f6ef8a502449ed"></a><!-- doxytag: member="aatree.h::aatree_cmp_f" ref="a8477ca7a04ef24eb52f6ef8a502449ed" args=")(uintptr_t, struct AANode *node)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef int(* <a class="el" href="aatree_8h.html#a8477ca7a04ef24eb52f6ef8a502449ed">aatree_cmp_f</a>)(uintptr_t, struct <a class="el" href="struct_a_a_node.html">AANode</a> *node)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Callback for node comparision against value. </p>

</div>
</div>
<a class="anchor" id="ae3855055f37242d29c5771cbc4c67254"></a><!-- doxytag: member="aatree.h::aatree_walker_f" ref="ae3855055f37242d29c5771cbc4c67254" args=")(struct AANode *n, void *arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* <a class="el" href="aatree_8h.html#ae3855055f37242d29c5771cbc4c67254">aatree_walker_f</a>)(struct <a class="el" href="struct_a_a_node.html">AANode</a> *n, void *arg)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Callback for walking the tree. </p>

</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a1d0d0399860e0a87d64743fb4e427b24"></a><!-- doxytag: member="aatree.h::AATreeWalkType" ref="a1d0d0399860e0a87d64743fb4e427b24" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="aatree_8h.html#a1d0d0399860e0a87d64743fb4e427b24">AATreeWalkType</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Walk order types. </p>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7019ff630481fd809ef557b17b12b8d1"></a><!-- doxytag: member="aatree.h::aatree_init" ref="a7019ff630481fd809ef557b17b12b8d1" args="(struct AATree *tree, aatree_cmp_f cmpfn, aatree_walker_f release_cb)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="aatree_8h.html#a7019ff630481fd809ef557b17b12b8d1">aatree_init</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_tree.html">AATree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="aatree_8h.html#a8477ca7a04ef24eb52f6ef8a502449ed">aatree_cmp_f</a>&#160;</td>
          <td class="paramname"><em>cmpfn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="aatree_8h.html#ae3855055f37242d29c5771cbc4c67254">aatree_walker_f</a>&#160;</td>
          <td class="paramname"><em>release_cb</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize structure. </p>

</div>
</div>
<a class="anchor" id="a69ffbc57b2012f97e603ef0001e56b4a"></a><!-- doxytag: member="aatree.h::aatree_search" ref="a69ffbc57b2012f97e603ef0001e56b4a" args="(struct AATree *tree, uintptr_t value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="struct_a_a_node.html">AANode</a>* <a class="el" href="aatree_8h.html#a69ffbc57b2012f97e603ef0001e56b4a">aatree_search</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_tree.html">AATree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uintptr_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Search for node. </p>

</div>
</div>
<a class="anchor" id="a13500a0f84b627c396b7838a553ac84d"></a><!-- doxytag: member="aatree.h::aatree_insert" ref="a13500a0f84b627c396b7838a553ac84d" args="(struct AATree *tree, uintptr_t value, struct AANode *node)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="aatree_8h.html#a13500a0f84b627c396b7838a553ac84d">aatree_insert</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_tree.html">AATree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uintptr_t&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_node.html">AANode</a> *&#160;</td>
          <td class="paramname"><em>node</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Insert new node. </p>

</div>
</div>
<a class="anchor" id="aba162e89353c02f4ef27e635b500c03d"></a><!-- doxytag: member="aatree.h::aatree_remove" ref="aba162e89353c02f4ef27e635b500c03d" args="(struct AATree *tree, uintptr_t value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="aatree_8h.html#aba162e89353c02f4ef27e635b500c03d">aatree_remove</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_tree.html">AATree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uintptr_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Remote node. </p>

</div>
</div>
<a class="anchor" id="aef87e78c43c5dea616ecceae78f96b9c"></a><!-- doxytag: member="aatree.h::aatree_walk" ref="aef87e78c43c5dea616ecceae78f96b9c" args="(struct AATree *tree, enum AATreeWalkType wtype, aatree_walker_f walker, void *arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="aatree_8h.html#aef87e78c43c5dea616ecceae78f96b9c">aatree_walk</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_tree.html">AATree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="aatree_8h.html#a1d0d0399860e0a87d64743fb4e427b24">AATreeWalkType</a>&#160;</td>
          <td class="paramname"><em>wtype</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="aatree_8h.html#ae3855055f37242d29c5771cbc4c67254">aatree_walker_f</a>&#160;</td>
          <td class="paramname"><em>walker</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Walk over all nodes. </p>

</div>
</div>
<a class="anchor" id="a153c4d70eed5a2572634bccf3f9ef649"></a><!-- doxytag: member="aatree.h::aatree_destroy" ref="a153c4d70eed5a2572634bccf3f9ef649" args="(struct AATree *tree)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="aatree_8h.html#a153c4d70eed5a2572634bccf3f9ef649">aatree_destroy</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="struct_a_a_tree.html">AATree</a> *&#160;</td>
          <td class="paramname"><em>tree</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Free. </p>

</div>
</div>
<a class="anchor" id="ad515b368bcd42014288d95426284a619"></a><!-- doxytag: member="aatree.h::aatree_is_nil_node" ref="ad515b368bcd42014288d95426284a619" args="(const struct AANode *node)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int <a class="el" href="aatree_8h.html#ad515b368bcd42014288d95426284a619">aatree_is_nil_node</a> </td>
          <td>(</td>
          <td class="paramtype">const struct <a class="el" href="struct_a_a_node.html">AANode</a> *&#160;</td>
          <td class="paramname"><em>node</em></td><td>)</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Check if terminal node. </p>

<p>References <a class="el" href="struct_a_a_node.html#aab70f6933e8bc401f0d9d6eb8f45b027">AANode::left</a>.</p>

</div>
</div>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>