docs/api-2.1/structUcxMap.html

changeset 390
d345541018fa
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/api-2.1/structUcxMap.html	Sat Feb 06 19:11:44 2021 +0100
     1.3 @@ -0,0 +1,168 @@
     1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
     1.6 +<head>
     1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
     1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
     1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
    1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
    1.11 +<title>ucx: UcxMap Struct Reference</title>
    1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
    1.13 +<script type="text/javascript" src="jquery.js"></script>
    1.14 +<script type="text/javascript" src="dynsections.js"></script>
    1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
    1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
    1.17 +<script type="text/javascript" src="search/search.js"></script>
    1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
    1.19 +</head>
    1.20 +<body>
    1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    1.22 +<div id="titlearea">
    1.23 +<table cellspacing="0" cellpadding="0">
    1.24 + <tbody>
    1.25 + <tr style="height: 56px;">
    1.26 +  <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
    1.27 +  <td id="projectalign" style="padding-left: 0.5em;">
    1.28 +   <div id="projectname">ucx
    1.29 +   </div>
    1.30 +   <div id="projectbrief">UAP Common Extensions</div>
    1.31 +  </td>
    1.32 + </tr>
    1.33 + </tbody>
    1.34 +</table>
    1.35 +</div>
    1.36 +<!-- end header part -->
    1.37 +<!-- Generated by Doxygen 1.8.13 -->
    1.38 +<script type="text/javascript">
    1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
    1.40 +</script>
    1.41 +<script type="text/javascript" src="menudata.js"></script>
    1.42 +<script type="text/javascript" src="menu.js"></script>
    1.43 +<script type="text/javascript">
    1.44 +$(function() {
    1.45 +  initMenu('',true,false,'search.php','Search');
    1.46 +  $(document).ready(function() { init_search(); });
    1.47 +});
    1.48 +</script>
    1.49 +<div id="main-nav"></div>
    1.50 +<!-- window showing the filter options -->
    1.51 +<div id="MSearchSelectWindow"
    1.52 +     onmouseover="return searchBox.OnSearchSelectShow()"
    1.53 +     onmouseout="return searchBox.OnSearchSelectHide()"
    1.54 +     onkeydown="return searchBox.OnSearchSelectKey(event)">
    1.55 +</div>
    1.56 +
    1.57 +<!-- iframe showing the search results (closed by default) -->
    1.58 +<div id="MSearchResultsWindow">
    1.59 +<iframe src="javascript:void(0)" frameborder="0" 
    1.60 +        name="MSearchResults" id="MSearchResults">
    1.61 +</iframe>
    1.62 +</div>
    1.63 +
    1.64 +</div><!-- top -->
    1.65 +<div class="header">
    1.66 +  <div class="summary">
    1.67 +<a href="#pub-attribs">Data Fields</a>  </div>
    1.68 +  <div class="headertitle">
    1.69 +<div class="title">UcxMap Struct Reference</div>  </div>
    1.70 +</div><!--header-->
    1.71 +<div class="contents">
    1.72 +
    1.73 +<p>Structure for the UCX map.  
    1.74 + <a href="structUcxMap.html#details">More...</a></p>
    1.75 +
    1.76 +<p><code>#include &lt;<a class="el" href="map_8h_source.html">map.h</a>&gt;</code></p>
    1.77 +<table class="memberdecls">
    1.78 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
    1.79 +Data Fields</h2></td></tr>
    1.80 +<tr class="memitem:a531f3e481c1c331cf037b916192e974d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#a531f3e481c1c331cf037b916192e974d">allocator</a></td></tr>
    1.81 +<tr class="memdesc:a531f3e481c1c331cf037b916192e974d"><td class="mdescLeft">&#160;</td><td class="mdescRight">An allocator that is used for the map elements.  <a href="#a531f3e481c1c331cf037b916192e974d">More...</a><br /></td></tr>
    1.82 +<tr class="separator:a531f3e481c1c331cf037b916192e974d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.83 +<tr class="memitem:a5792b5037c4f77ea3cb144b66c9b8790"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMapElement.html">UcxMapElement</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#a5792b5037c4f77ea3cb144b66c9b8790">map</a></td></tr>
    1.84 +<tr class="memdesc:a5792b5037c4f77ea3cb144b66c9b8790"><td class="mdescLeft">&#160;</td><td class="mdescRight">The array of map element lists.  <a href="#a5792b5037c4f77ea3cb144b66c9b8790">More...</a><br /></td></tr>
    1.85 +<tr class="separator:a5792b5037c4f77ea3cb144b66c9b8790"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.86 +<tr class="memitem:afe120846b26d99580a7ff1276464e838"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#afe120846b26d99580a7ff1276464e838">size</a></td></tr>
    1.87 +<tr class="memdesc:afe120846b26d99580a7ff1276464e838"><td class="mdescLeft">&#160;</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>
    1.88 +<tr class="separator:afe120846b26d99580a7ff1276464e838"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.89 +<tr class="memitem:a14e9163f71f6c014dfa2103de70ae9cd"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html#a14e9163f71f6c014dfa2103de70ae9cd">count</a></td></tr>
    1.90 +<tr class="memdesc:a14e9163f71f6c014dfa2103de70ae9cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The count of elements currently stored in this map.  <a href="#a14e9163f71f6c014dfa2103de70ae9cd">More...</a><br /></td></tr>
    1.91 +<tr class="separator:a14e9163f71f6c014dfa2103de70ae9cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    1.92 +</table>
    1.93 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    1.94 +<div class="textblock"><p>Structure for the UCX map. </p>
    1.95 +</div><h2 class="groupheader">Field Documentation</h2>
    1.96 +<a id="a531f3e481c1c331cf037b916192e974d"></a>
    1.97 +<h2 class="memtitle"><span class="permalink"><a href="#a531f3e481c1c331cf037b916192e974d">&#9670;&nbsp;</a></span>allocator</h2>
    1.98 +
    1.99 +<div class="memitem">
   1.100 +<div class="memproto">
   1.101 +      <table class="memname">
   1.102 +        <tr>
   1.103 +          <td class="memname"><a class="el" href="structUcxAllocator.html">UcxAllocator</a>* UcxMap::allocator</td>
   1.104 +        </tr>
   1.105 +      </table>
   1.106 +</div><div class="memdoc">
   1.107 +
   1.108 +<p>An allocator that is used for the map elements. </p>
   1.109 +
   1.110 +</div>
   1.111 +</div>
   1.112 +<a id="a14e9163f71f6c014dfa2103de70ae9cd"></a>
   1.113 +<h2 class="memtitle"><span class="permalink"><a href="#a14e9163f71f6c014dfa2103de70ae9cd">&#9670;&nbsp;</a></span>count</h2>
   1.114 +
   1.115 +<div class="memitem">
   1.116 +<div class="memproto">
   1.117 +      <table class="memname">
   1.118 +        <tr>
   1.119 +          <td class="memname">size_t UcxMap::count</td>
   1.120 +        </tr>
   1.121 +      </table>
   1.122 +</div><div class="memdoc">
   1.123 +
   1.124 +<p>The count of elements currently stored in this map. </p>
   1.125 +
   1.126 +</div>
   1.127 +</div>
   1.128 +<a id="a5792b5037c4f77ea3cb144b66c9b8790"></a>
   1.129 +<h2 class="memtitle"><span class="permalink"><a href="#a5792b5037c4f77ea3cb144b66c9b8790">&#9670;&nbsp;</a></span>map</h2>
   1.130 +
   1.131 +<div class="memitem">
   1.132 +<div class="memproto">
   1.133 +      <table class="memname">
   1.134 +        <tr>
   1.135 +          <td class="memname"><a class="el" href="structUcxMapElement.html">UcxMapElement</a>** UcxMap::map</td>
   1.136 +        </tr>
   1.137 +      </table>
   1.138 +</div><div class="memdoc">
   1.139 +
   1.140 +<p>The array of map element lists. </p>
   1.141 +
   1.142 +</div>
   1.143 +</div>
   1.144 +<a id="afe120846b26d99580a7ff1276464e838"></a>
   1.145 +<h2 class="memtitle"><span class="permalink"><a href="#afe120846b26d99580a7ff1276464e838">&#9670;&nbsp;</a></span>size</h2>
   1.146 +
   1.147 +<div class="memitem">
   1.148 +<div class="memproto">
   1.149 +      <table class="memname">
   1.150 +        <tr>
   1.151 +          <td class="memname">size_t UcxMap::size</td>
   1.152 +        </tr>
   1.153 +      </table>
   1.154 +</div><div class="memdoc">
   1.155 +
   1.156 +<p>The size of the map is the length of the element list array. </p>
   1.157 +
   1.158 +</div>
   1.159 +</div>
   1.160 +<hr/>The documentation for this struct was generated from the following file:<ul>
   1.161 +<li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="map_8h_source.html">map.h</a></li>
   1.162 +</ul>
   1.163 +</div><!-- contents -->
   1.164 +<!-- start footer part -->
   1.165 +<hr class="footer"/><address class="footer"><small>
   1.166 +Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
   1.167 +<img class="footer" src="doxygen.png" alt="doxygen"/>
   1.168 +</a> 1.8.13
   1.169 +</small></address>
   1.170 +</body>
   1.171 +</html>

mercurial