Mercurial > hg > ucx / file revision

docs/api-2.1/structUcxAVLTree.html@3d8235c96a27

docs/api-2.1/structUcxAVLTree.html

Sun, 26 Sep 2021 16:12:21 +0200

author
Mike Becker <universe@uap-core.de>
date
Sun, 26 Sep 2021 16:12:21 +0200
changeset 429
3d8235c96a27
parent 390
d345541018fa
permissions
-rw-r--r--

add documentation to allocator.h

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ucx: UcxAVLTree Struct Reference</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ucx
   </div>
   <div id="projectbrief">UAP Common Extensions</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">UcxAVLTree Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>UCX AVL Tree.  
 <a href="structUcxAVLTree.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="avl_8h_source.html">avl.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a30652776b540156ad54c7d52833e4e28"><td class="memItemLeft" align="right" valign="top"><a id="a30652776b540156ad54c7d52833e4e28"></a>
<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxAVLTree.html#a30652776b540156ad54c7d52833e4e28">allocator</a></td></tr>
<tr class="memdesc:a30652776b540156ad54c7d52833e4e28"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> that shall be used to manage the memory for node data. <br /></td></tr>
<tr class="separator:a30652776b540156ad54c7d52833e4e28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a393a8fc99eb2c290d3cb67170081d742"><td class="memItemLeft" align="right" valign="top"><a id="a393a8fc99eb2c290d3cb67170081d742"></a>
<a class="el" href="structUcxAVLNode.html">UcxAVLNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxAVLTree.html#a393a8fc99eb2c290d3cb67170081d742">root</a></td></tr>
<tr class="memdesc:a393a8fc99eb2c290d3cb67170081d742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Root node of the tree. <br /></td></tr>
<tr class="separator:a393a8fc99eb2c290d3cb67170081d742"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87aff25cb726cb9eb88eb815a10d1004"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxAVLTree.html#a87aff25cb726cb9eb88eb815a10d1004">cmpfunc</a></td></tr>
<tr class="memdesc:a87aff25cb726cb9eb88eb815a10d1004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare function that shall be used to compare the <a class="el" href="structUcxAVLNode.html" title="UCX AVL Node. ">UcxAVLNode</a> keys.  <a href="#a87aff25cb726cb9eb88eb815a10d1004">More...</a><br /></td></tr>
<tr class="separator:a87aff25cb726cb9eb88eb815a10d1004"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae92a3bfad3fe33c8dcbdad85112f83fd"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxAVLTree.html#ae92a3bfad3fe33c8dcbdad85112f83fd">userdata</a></td></tr>
<tr class="memdesc:ae92a3bfad3fe33c8dcbdad85112f83fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom user data.  <a href="#ae92a3bfad3fe33c8dcbdad85112f83fd">More...</a><br /></td></tr>
<tr class="separator:ae92a3bfad3fe33c8dcbdad85112f83fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>UCX AVL Tree. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a87aff25cb726cb9eb88eb815a10d1004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87aff25cb726cb9eb88eb815a10d1004">&#9670;&nbsp;</a></span>cmpfunc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> UcxAVLTree::cmpfunc</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Compare function that shall be used to compare the <a class="el" href="structUcxAVLNode.html" title="UCX AVL Node. ">UcxAVLNode</a> keys. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAVLNode.html#ab65a31010d26a3df898e6ba534702af6" title="The key for this node. ">UcxAVLNode.key</a> </dd></dl>

</div>
</div>
<a id="ae92a3bfad3fe33c8dcbdad85112f83fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae92a3bfad3fe33c8dcbdad85112f83fd">&#9670;&nbsp;</a></span>userdata</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* UcxAVLTree::userdata</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Custom user data. </p>
<p>This data will also be provided to the cmpfunc. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="avl_8h_source.html">avl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

Mercurial Repository: ucx

mercurial