Sat, 23 Nov 2024 14:45:32 +0100
improve consistency for allocator arguments - fixes #485
<!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: UcxMap 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">UcxMap Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Structure for the UCX map. <a href="structUcxMap.html#details">More...</a></p> <p><code>#include <<a class="el" href="map_8h_source.html">map.h</a>></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:a531f3e481c1c331cf037b916192e974d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#a531f3e481c1c331cf037b916192e974d">allocator</a></td></tr> <tr class="memdesc:a531f3e481c1c331cf037b916192e974d"><td class="mdescLeft"> </td><td class="mdescRight">An allocator that is used for the map elements. <a href="#a531f3e481c1c331cf037b916192e974d">More...</a><br /></td></tr> <tr class="separator:a531f3e481c1c331cf037b916192e974d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5792b5037c4f77ea3cb144b66c9b8790"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMapElement.html">UcxMapElement</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#a5792b5037c4f77ea3cb144b66c9b8790">map</a></td></tr> <tr class="memdesc:a5792b5037c4f77ea3cb144b66c9b8790"><td class="mdescLeft"> </td><td class="mdescRight">The array of map element lists. <a href="#a5792b5037c4f77ea3cb144b66c9b8790">More...</a><br /></td></tr> <tr class="separator:a5792b5037c4f77ea3cb144b66c9b8790"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afe120846b26d99580a7ff1276464e838"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#afe120846b26d99580a7ff1276464e838">size</a></td></tr> <tr class="memdesc:afe120846b26d99580a7ff1276464e838"><td class="mdescLeft"> </td><td class="mdescRight">The size of the map is the length of the element list array. <a href="#afe120846b26d99580a7ff1276464e838">More...</a><br /></td></tr> <tr class="separator:afe120846b26d99580a7ff1276464e838"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a14e9163f71f6c014dfa2103de70ae9cd"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#a14e9163f71f6c014dfa2103de70ae9cd">count</a></td></tr> <tr class="memdesc:a14e9163f71f6c014dfa2103de70ae9cd"><td class="mdescLeft"> </td><td class="mdescRight">The count of elements currently stored in this map. <a href="#a14e9163f71f6c014dfa2103de70ae9cd">More...</a><br /></td></tr> <tr class="separator:a14e9163f71f6c014dfa2103de70ae9cd"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Structure for the UCX map. </p> </div><h2 class="groupheader">Field Documentation</h2> <a id="a531f3e481c1c331cf037b916192e974d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a531f3e481c1c331cf037b916192e974d">◆ </a></span>allocator</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structUcxAllocator.html">UcxAllocator</a>* UcxMap::allocator</td> </tr> </table> </div><div class="memdoc"> <p>An allocator that is used for the map elements. </p> </div> </div> <a id="a14e9163f71f6c014dfa2103de70ae9cd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a14e9163f71f6c014dfa2103de70ae9cd">◆ </a></span>count</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t UcxMap::count</td> </tr> </table> </div><div class="memdoc"> <p>The count of elements currently stored in this map. </p> </div> </div> <a id="a5792b5037c4f77ea3cb144b66c9b8790"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5792b5037c4f77ea3cb144b66c9b8790">◆ </a></span>map</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structUcxMapElement.html">UcxMapElement</a>** UcxMap::map</td> </tr> </table> </div><div class="memdoc"> <p>The array of map element lists. </p> </div> </div> <a id="afe120846b26d99580a7ff1276464e838"></a> <h2 class="memtitle"><span class="permalink"><a href="#afe120846b26d99580a7ff1276464e838">◆ </a></span>size</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t UcxMap::size</td> </tr> </table> </div><div class="memdoc"> <p>The size of the map is the length of the element list array. </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="map_8h_source.html">map.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  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>