docs/api-2.1/map_8h.html@d345541018fa (annotated)
docs/api-2.1/map_8h.html
Sat, 06 Feb 2021 19:11:44 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sat, 06 Feb 2021 19:11:44 +0100
- changeset 390
- d345541018fa
- permissions
- -rw-r--r--
starts ucx 3.0 development
| universe@390 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| universe@390 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| universe@390 | 3 | <head> |
| universe@390 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| universe@390 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| universe@390 | 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
| universe@390 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| universe@390 | 8 | <title>ucx: /home/mike/workspace/c/ucx/src/ucx/map.h File Reference</title> |
| universe@390 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| universe@390 | 10 | <script type="text/javascript" src="jquery.js"></script> |
| universe@390 | 11 | <script type="text/javascript" src="dynsections.js"></script> |
| universe@390 | 12 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| universe@390 | 13 | <script type="text/javascript" src="search/searchdata.js"></script> |
| universe@390 | 14 | <script type="text/javascript" src="search/search.js"></script> |
| universe@390 | 15 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| universe@390 | 16 | </head> |
| universe@390 | 17 | <body> |
| universe@390 | 18 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| universe@390 | 19 | <div id="titlearea"> |
| universe@390 | 20 | <table cellspacing="0" cellpadding="0"> |
| universe@390 | 21 | <tbody> |
| universe@390 | 22 | <tr style="height: 56px;"> |
| universe@390 | 23 | <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td> |
| universe@390 | 24 | <td id="projectalign" style="padding-left: 0.5em;"> |
| universe@390 | 25 | <div id="projectname">ucx |
| universe@390 | 26 | </div> |
| universe@390 | 27 | <div id="projectbrief">UAP Common Extensions</div> |
| universe@390 | 28 | </td> |
| universe@390 | 29 | </tr> |
| universe@390 | 30 | </tbody> |
| universe@390 | 31 | </table> |
| universe@390 | 32 | </div> |
| universe@390 | 33 | <!-- end header part --> |
| universe@390 | 34 | <!-- Generated by Doxygen 1.8.13 --> |
| universe@390 | 35 | <script type="text/javascript"> |
| universe@390 | 36 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| universe@390 | 37 | </script> |
| universe@390 | 38 | <script type="text/javascript" src="menudata.js"></script> |
| universe@390 | 39 | <script type="text/javascript" src="menu.js"></script> |
| universe@390 | 40 | <script type="text/javascript"> |
| universe@390 | 41 | $(function() { |
| universe@390 | 42 | initMenu('',true,false,'search.php','Search'); |
| universe@390 | 43 | $(document).ready(function() { init_search(); }); |
| universe@390 | 44 | }); |
| universe@390 | 45 | </script> |
| universe@390 | 46 | <div id="main-nav"></div> |
| universe@390 | 47 | <!-- window showing the filter options --> |
| universe@390 | 48 | <div id="MSearchSelectWindow" |
| universe@390 | 49 | onmouseover="return searchBox.OnSearchSelectShow()" |
| universe@390 | 50 | onmouseout="return searchBox.OnSearchSelectHide()" |
| universe@390 | 51 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| universe@390 | 52 | </div> |
| universe@390 | 53 | |
| universe@390 | 54 | <!-- iframe showing the search results (closed by default) --> |
| universe@390 | 55 | <div id="MSearchResultsWindow"> |
| universe@390 | 56 | <iframe src="javascript:void(0)" frameborder="0" |
| universe@390 | 57 | name="MSearchResults" id="MSearchResults"> |
| universe@390 | 58 | </iframe> |
| universe@390 | 59 | </div> |
| universe@390 | 60 | |
| universe@390 | 61 | <div id="nav-path" class="navpath"> |
| universe@390 | 62 | <ul> |
| universe@390 | 63 | <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_69f4ea29401808fe6229564976cde3ce.html">ucx</a></li> </ul> |
| universe@390 | 64 | </div> |
| universe@390 | 65 | </div><!-- top --> |
| universe@390 | 66 | <div class="header"> |
| universe@390 | 67 | <div class="summary"> |
| universe@390 | 68 | <a href="#nested-classes">Data Structures</a> | |
| universe@390 | 69 | <a href="#define-members">Macros</a> | |
| universe@390 | 70 | <a href="#typedef-members">Typedefs</a> | |
| universe@390 | 71 | <a href="#func-members">Functions</a> </div> |
| universe@390 | 72 | <div class="headertitle"> |
| universe@390 | 73 | <div class="title">map.h File Reference</div> </div> |
| universe@390 | 74 | </div><!--header--> |
| universe@390 | 75 | <div class="contents"> |
| universe@390 | 76 | |
| universe@390 | 77 | <p>Hash map implementation. |
| universe@390 | 78 | <a href="#details">More...</a></p> |
| universe@390 | 79 | <div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br /> |
| universe@390 | 80 | <code>#include "<a class="el" href="string_8h_source.html">string.h</a>"</code><br /> |
| universe@390 | 81 | <code>#include "<a class="el" href="allocator_8h_source.html">allocator.h</a>"</code><br /> |
| universe@390 | 82 | <code>#include <stdio.h></code><br /> |
| universe@390 | 83 | </div> |
| universe@390 | 84 | <p><a href="map_8h_source.html">Go to the source code of this file.</a></p> |
| universe@390 | 85 | <table class="memberdecls"> |
| universe@390 | 86 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| universe@390 | 87 | Data Structures</h2></td></tr> |
| universe@390 | 88 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMap.html">UcxMap</a></td></tr> |
| universe@390 | 89 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure for the UCX map. <a href="structUcxMap.html#details">More...</a><br /></td></tr> |
| universe@390 | 90 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 91 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxKey.html">UcxKey</a></td></tr> |
| universe@390 | 92 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure to publicly denote a key of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="structUcxKey.html#details">More...</a><br /></td></tr> |
| universe@390 | 93 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 94 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMapKey.html">UcxMapKey</a></td></tr> |
| universe@390 | 95 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal structure for a key of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="structUcxMapKey.html#details">More...</a><br /></td></tr> |
| universe@390 | 96 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 97 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMapElement.html">UcxMapElement</a></td></tr> |
| universe@390 | 98 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure for an element of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="structUcxMapElement.html#details">More...</a><br /></td></tr> |
| universe@390 | 99 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 100 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMapIterator.html">UcxMapIterator</a></td></tr> |
| universe@390 | 101 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="structUcxMapIterator.html#details">More...</a><br /></td></tr> |
| universe@390 | 102 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 103 | </table><table class="memberdecls"> |
| universe@390 | 104 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| universe@390 | 105 | Macros</h2></td></tr> |
| universe@390 | 106 | <tr class="memitem:a940896c4aa1b13e54c55c04c3efc186b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a940896c4aa1b13e54c55c04c3efc186b">UCX_MAP_FOREACH</a>(key, value, iter)   for(<a class="el" href="structUcxKey.html">UcxKey</a> key;<a class="el" href="map_8h.html#aceb8675abf44860b4bbc301bbada5b91">ucx_map_iter_next</a>(&iter,&key, (void**)&value);)</td></tr> |
| universe@390 | 107 | <tr class="memdesc:a940896c4aa1b13e54c55c04c3efc186b"><td class="mdescLeft"> </td><td class="mdescRight">Loop statement for UCX maps. <a href="#a940896c4aa1b13e54c55c04c3efc186b">More...</a><br /></td></tr> |
| universe@390 | 108 | <tr class="separator:a940896c4aa1b13e54c55c04c3efc186b"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 109 | <tr class="memitem:ac26a8615bfc8f47ee9eaceb47645f98e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ac26a8615bfc8f47ee9eaceb47645f98e">ucx_map_sstr_put</a>(map, key, value)   <a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key.ptr, key.length), (void*)value)</td></tr> |
| universe@390 | 110 | <tr class="memdesc:ac26a8615bfc8f47ee9eaceb47645f98e"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for putting data with a <a class="el" href="structsstr__t.html" title="The UCX string structure. ">sstr_t</a> key into the map. <a href="#ac26a8615bfc8f47ee9eaceb47645f98e">More...</a><br /></td></tr> |
| universe@390 | 111 | <tr class="separator:ac26a8615bfc8f47ee9eaceb47645f98e"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 112 | <tr class="memitem:ad9356b01425b934ab237b52339ac0cc3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ad9356b01425b934ab237b52339ac0cc3">ucx_map_cstr_put</a>(map, key, value)   <a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key, strlen(key)), (void*)value)</td></tr> |
| universe@390 | 113 | <tr class="memdesc:ad9356b01425b934ab237b52339ac0cc3"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for putting data with a C string key into the map. <a href="#ad9356b01425b934ab237b52339ac0cc3">More...</a><br /></td></tr> |
| universe@390 | 114 | <tr class="separator:ad9356b01425b934ab237b52339ac0cc3"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 115 | <tr class="memitem:aaa30af79b4068c923895619e83f44367"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aaa30af79b4068c923895619e83f44367">ucx_map_int_put</a>(map, key, value)   <a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(&key, sizeof(key)), (void*)value)</td></tr> |
| universe@390 | 116 | <tr class="memdesc:aaa30af79b4068c923895619e83f44367"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for putting data with an integer key into the map. <a href="#aaa30af79b4068c923895619e83f44367">More...</a><br /></td></tr> |
| universe@390 | 117 | <tr class="separator:aaa30af79b4068c923895619e83f44367"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 118 | <tr class="memitem:a14d385f6b7f371f0507861cabd2eab4e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a14d385f6b7f371f0507861cabd2eab4e">ucx_map_sstr_get</a>(map, key)   <a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key.ptr, key.length))</td></tr> |
| universe@390 | 119 | <tr class="memdesc:a14d385f6b7f371f0507861cabd2eab4e"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for getting data from the map with a <a class="el" href="structsstr__t.html" title="The UCX string structure. ">sstr_t</a> key. <a href="#a14d385f6b7f371f0507861cabd2eab4e">More...</a><br /></td></tr> |
| universe@390 | 120 | <tr class="separator:a14d385f6b7f371f0507861cabd2eab4e"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 121 | <tr class="memitem:a64e1fb55498fa502dd2ed8ed69062cdd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a64e1fb55498fa502dd2ed8ed69062cdd">ucx_map_cstr_get</a>(map, key)   <a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key, strlen(key)))</td></tr> |
| universe@390 | 122 | <tr class="memdesc:a64e1fb55498fa502dd2ed8ed69062cdd"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for getting data from the map with a C string key. <a href="#a64e1fb55498fa502dd2ed8ed69062cdd">More...</a><br /></td></tr> |
| universe@390 | 123 | <tr class="separator:a64e1fb55498fa502dd2ed8ed69062cdd"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 124 | <tr class="memitem:aa1681bd2178553cd092fd24c4d681d3c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aa1681bd2178553cd092fd24c4d681d3c">ucx_map_int_get</a>(map, key)   <a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(&key, sizeof(int)))</td></tr> |
| universe@390 | 125 | <tr class="memdesc:aa1681bd2178553cd092fd24c4d681d3c"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for getting data from the map with an integer key. <a href="#aa1681bd2178553cd092fd24c4d681d3c">More...</a><br /></td></tr> |
| universe@390 | 126 | <tr class="separator:aa1681bd2178553cd092fd24c4d681d3c"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 127 | <tr class="memitem:a48700ea86fadb9ea54d13010f9124df2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a48700ea86fadb9ea54d13010f9124df2">ucx_map_sstr_remove</a>(map, key)   <a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key.ptr, key.length))</td></tr> |
| universe@390 | 128 | <tr class="memdesc:a48700ea86fadb9ea54d13010f9124df2"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for removing data from the map with a <a class="el" href="structsstr__t.html" title="The UCX string structure. ">sstr_t</a> key. <a href="#a48700ea86fadb9ea54d13010f9124df2">More...</a><br /></td></tr> |
| universe@390 | 129 | <tr class="separator:a48700ea86fadb9ea54d13010f9124df2"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 130 | <tr class="memitem:a9c4405a5a75ecf64e2ef3d0c6501a9fe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a9c4405a5a75ecf64e2ef3d0c6501a9fe">ucx_map_cstr_remove</a>(map, key)   <a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key, strlen(key)))</td></tr> |
| universe@390 | 131 | <tr class="memdesc:a9c4405a5a75ecf64e2ef3d0c6501a9fe"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for removing data from the map with a C string key. <a href="#a9c4405a5a75ecf64e2ef3d0c6501a9fe">More...</a><br /></td></tr> |
| universe@390 | 132 | <tr class="separator:a9c4405a5a75ecf64e2ef3d0c6501a9fe"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 133 | <tr class="memitem:aa767958b5468737755c09f7185b1770c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aa767958b5468737755c09f7185b1770c">ucx_map_int_remove</a>(map, key)   <a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(&key, sizeof(key)))</td></tr> |
| universe@390 | 134 | <tr class="memdesc:aa767958b5468737755c09f7185b1770c"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for removing data from the map with an integer key. <a href="#aa767958b5468737755c09f7185b1770c">More...</a><br /></td></tr> |
| universe@390 | 135 | <tr class="separator:aa767958b5468737755c09f7185b1770c"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 136 | </table><table class="memberdecls"> |
| universe@390 | 137 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| universe@390 | 138 | Typedefs</h2></td></tr> |
| universe@390 | 139 | <tr class="memitem:a18e21948725b2da68c35da587a722033"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUcxMap.html">UcxMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a18e21948725b2da68c35da587a722033">UcxMap</a></td></tr> |
| universe@390 | 140 | <tr class="memdesc:a18e21948725b2da68c35da587a722033"><td class="mdescLeft"> </td><td class="mdescRight">Type for the UCX map. <a href="#a18e21948725b2da68c35da587a722033">More...</a><br /></td></tr> |
| universe@390 | 141 | <tr class="separator:a18e21948725b2da68c35da587a722033"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 142 | <tr class="memitem:ad63828bb23123fc01a5315a2bac3b142"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUcxKey.html">UcxKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ad63828bb23123fc01a5315a2bac3b142">UcxKey</a></td></tr> |
| universe@390 | 143 | <tr class="memdesc:ad63828bb23123fc01a5315a2bac3b142"><td class="mdescLeft"> </td><td class="mdescRight">Type for a key of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="#ad63828bb23123fc01a5315a2bac3b142">More...</a><br /></td></tr> |
| universe@390 | 144 | <tr class="separator:ad63828bb23123fc01a5315a2bac3b142"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 145 | <tr class="memitem:ad7d7a910a32113eb93eae11c3dc97b4b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUcxMapElement.html">UcxMapElement</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ad7d7a910a32113eb93eae11c3dc97b4b">UcxMapElement</a></td></tr> |
| universe@390 | 146 | <tr class="memdesc:ad7d7a910a32113eb93eae11c3dc97b4b"><td class="mdescLeft"> </td><td class="mdescRight">Type for an element of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="#ad7d7a910a32113eb93eae11c3dc97b4b">More...</a><br /></td></tr> |
| universe@390 | 147 | <tr class="separator:ad7d7a910a32113eb93eae11c3dc97b4b"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 148 | <tr class="memitem:ae36aff5f645948c54f51578b11fd87fb"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUcxMapIterator.html">UcxMapIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ae36aff5f645948c54f51578b11fd87fb">UcxMapIterator</a></td></tr> |
| universe@390 | 149 | <tr class="memdesc:ae36aff5f645948c54f51578b11fd87fb"><td class="mdescLeft"> </td><td class="mdescRight">Type for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. <a href="#ae36aff5f645948c54f51578b11fd87fb">More...</a><br /></td></tr> |
| universe@390 | 150 | <tr class="separator:ae36aff5f645948c54f51578b11fd87fb"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 151 | </table><table class="memberdecls"> |
| universe@390 | 152 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| universe@390 | 153 | Functions</h2></td></tr> |
| universe@390 | 154 | <tr class="memitem:a79f31de8b93814493759dbc8b940cf0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a79f31de8b93814493759dbc8b940cf0c">ucx_map_new</a> (size_t size)</td></tr> |
| universe@390 | 155 | <tr class="memdesc:a79f31de8b93814493759dbc8b940cf0c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new hash map with the specified size. <a href="#a79f31de8b93814493759dbc8b940cf0c">More...</a><br /></td></tr> |
| universe@390 | 156 | <tr class="separator:a79f31de8b93814493759dbc8b940cf0c"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 157 | <tr class="memitem:aed508a94c66cc15372503c64b70eb03e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aed508a94c66cc15372503c64b70eb03e">ucx_map_new_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator, size_t size)</td></tr> |
| universe@390 | 158 | <tr class="memdesc:aed508a94c66cc15372503c64b70eb03e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new hash map with the specified size using a <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a>. <a href="#aed508a94c66cc15372503c64b70eb03e">More...</a><br /></td></tr> |
| universe@390 | 159 | <tr class="separator:aed508a94c66cc15372503c64b70eb03e"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 160 | <tr class="memitem:abe3d9688e4224bf7bb962abf25ff8c2e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#abe3d9688e4224bf7bb962abf25ff8c2e">ucx_map_free</a> (<a class="el" href="structUcxMap.html">UcxMap</a> *map)</td></tr> |
| universe@390 | 161 | <tr class="memdesc:abe3d9688e4224bf7bb962abf25ff8c2e"><td class="mdescLeft"> </td><td class="mdescRight">Frees a hash map. <a href="#abe3d9688e4224bf7bb962abf25ff8c2e">More...</a><br /></td></tr> |
| universe@390 | 162 | <tr class="separator:abe3d9688e4224bf7bb962abf25ff8c2e"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 163 | <tr class="memitem:a750f3d9d83e2f3788a14c17a9d160618"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a750f3d9d83e2f3788a14c17a9d160618">ucx_map_free_content</a> (<a class="el" href="structUcxMap.html">UcxMap</a> *map, <a class="el" href="ucx_8h.html#ad2b370c2809914c8b7fedab163c266b3">ucx_destructor</a> destr)</td></tr> |
| universe@390 | 164 | <tr class="memdesc:a750f3d9d83e2f3788a14c17a9d160618"><td class="mdescLeft"> </td><td class="mdescRight">Frees the contents of a hash map. <a href="#a750f3d9d83e2f3788a14c17a9d160618">More...</a><br /></td></tr> |
| universe@390 | 165 | <tr class="separator:a750f3d9d83e2f3788a14c17a9d160618"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 166 | <tr class="memitem:a285e90e40681c6d9631c935dda0967f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a285e90e40681c6d9631c935dda0967f2">ucx_map_clear</a> (<a class="el" href="structUcxMap.html">UcxMap</a> *map)</td></tr> |
| universe@390 | 167 | <tr class="memdesc:a285e90e40681c6d9631c935dda0967f2"><td class="mdescLeft"> </td><td class="mdescRight">Clears a hash map. <a href="#a285e90e40681c6d9631c935dda0967f2">More...</a><br /></td></tr> |
| universe@390 | 168 | <tr class="separator:a285e90e40681c6d9631c935dda0967f2"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 169 | <tr class="memitem:adfeb2d61003fd2896bcfdc9a57f36425"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#adfeb2d61003fd2896bcfdc9a57f36425">ucx_map_copy</a> (<a class="el" href="structUcxMap.html">UcxMap</a> const *from, <a class="el" href="structUcxMap.html">UcxMap</a> *to, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> fnc, void *data)</td></tr> |
| universe@390 | 170 | <tr class="memdesc:adfeb2d61003fd2896bcfdc9a57f36425"><td class="mdescLeft"> </td><td class="mdescRight">Copies contents from a map to another map using a copy function. <a href="#adfeb2d61003fd2896bcfdc9a57f36425">More...</a><br /></td></tr> |
| universe@390 | 171 | <tr class="separator:adfeb2d61003fd2896bcfdc9a57f36425"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 172 | <tr class="memitem:a62c6c30cbb0d824ba710f5030ff9a4e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a62c6c30cbb0d824ba710f5030ff9a4e4">ucx_map_clone</a> (<a class="el" href="structUcxMap.html">UcxMap</a> const *map, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> fnc, void *data)</td></tr> |
| universe@390 | 173 | <tr class="memdesc:a62c6c30cbb0d824ba710f5030ff9a4e4"><td class="mdescLeft"> </td><td class="mdescRight">Clones the map and rehashes if necessary. <a href="#a62c6c30cbb0d824ba710f5030ff9a4e4">More...</a><br /></td></tr> |
| universe@390 | 174 | <tr class="separator:a62c6c30cbb0d824ba710f5030ff9a4e4"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 175 | <tr class="memitem:a9aea9103703d5c168420bb6bf85549ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a9aea9103703d5c168420bb6bf85549ea">ucx_map_clone_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator, <a class="el" href="structUcxMap.html">UcxMap</a> const *map, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> fnc, void *data)</td></tr> |
| universe@390 | 176 | <tr class="memdesc:a9aea9103703d5c168420bb6bf85549ea"><td class="mdescLeft"> </td><td class="mdescRight">Clones the map and rehashes if necessary. <a href="#a9aea9103703d5c168420bb6bf85549ea">More...</a><br /></td></tr> |
| universe@390 | 177 | <tr class="separator:a9aea9103703d5c168420bb6bf85549ea"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 178 | <tr class="memitem:a174bce9fad554dd92b8da354e0d32512"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a174bce9fad554dd92b8da354e0d32512">ucx_map_rehash</a> (<a class="el" href="structUcxMap.html">UcxMap</a> *map)</td></tr> |
| universe@390 | 179 | <tr class="memdesc:a174bce9fad554dd92b8da354e0d32512"><td class="mdescLeft"> </td><td class="mdescRight">Increases size of the hash map, if necessary. <a href="#a174bce9fad554dd92b8da354e0d32512">More...</a><br /></td></tr> |
| universe@390 | 180 | <tr class="separator:a174bce9fad554dd92b8da354e0d32512"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 181 | <tr class="memitem:ac04a08b604217070254d4c58f0e82498"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a> (<a class="el" href="structUcxMap.html">UcxMap</a> *map, <a class="el" href="structUcxKey.html">UcxKey</a> key, void *value)</td></tr> |
| universe@390 | 182 | <tr class="memdesc:ac04a08b604217070254d4c58f0e82498"><td class="mdescLeft"> </td><td class="mdescRight">Puts a key/value-pair into the map. <a href="#ac04a08b604217070254d4c58f0e82498">More...</a><br /></td></tr> |
| universe@390 | 183 | <tr class="separator:ac04a08b604217070254d4c58f0e82498"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 184 | <tr class="memitem:ab61192c5af2e06ecb9ad73880d1c95a6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a> (<a class="el" href="structUcxMap.html">UcxMap</a> const *map, <a class="el" href="structUcxKey.html">UcxKey</a> key)</td></tr> |
| universe@390 | 185 | <tr class="memdesc:ab61192c5af2e06ecb9ad73880d1c95a6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a value by using a key. <a href="#ab61192c5af2e06ecb9ad73880d1c95a6">More...</a><br /></td></tr> |
| universe@390 | 186 | <tr class="separator:ab61192c5af2e06ecb9ad73880d1c95a6"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 187 | <tr class="memitem:a17248a4888eb8f9ae18be522d64632aa"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a> (<a class="el" href="structUcxMap.html">UcxMap</a> *map, <a class="el" href="structUcxKey.html">UcxKey</a> key)</td></tr> |
| universe@390 | 188 | <tr class="memdesc:a17248a4888eb8f9ae18be522d64632aa"><td class="mdescLeft"> </td><td class="mdescRight">Removes a key/value-pair from the map by using the key. <a href="#a17248a4888eb8f9ae18be522d64632aa">More...</a><br /></td></tr> |
| universe@390 | 189 | <tr class="separator:a17248a4888eb8f9ae18be522d64632aa"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 190 | <tr class="memitem:a3e540bb46b8ee19789aed63fd8919200"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxKey.html">UcxKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a> (const void *data, size_t len)</td></tr> |
| universe@390 | 191 | <tr class="memdesc:a3e540bb46b8ee19789aed63fd8919200"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="structUcxKey.html" title="Structure to publicly denote a key of a UcxMap. ">UcxKey</a> based on the given data. <a href="#a3e540bb46b8ee19789aed63fd8919200">More...</a><br /></td></tr> |
| universe@390 | 192 | <tr class="separator:a3e540bb46b8ee19789aed63fd8919200"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 193 | <tr class="memitem:aea3be97254c05595d986ef6a9faae87b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aea3be97254c05595d986ef6a9faae87b">ucx_hash</a> (const char *data, size_t len)</td></tr> |
| universe@390 | 194 | <tr class="memdesc:aea3be97254c05595d986ef6a9faae87b"><td class="mdescLeft"> </td><td class="mdescRight">Computes a murmur hash-2. <a href="#aea3be97254c05595d986ef6a9faae87b">More...</a><br /></td></tr> |
| universe@390 | 195 | <tr class="separator:aea3be97254c05595d986ef6a9faae87b"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 196 | <tr class="memitem:a9150e9c64fdf4dfcc2cad106b91aa110"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMapIterator.html">UcxMapIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a9150e9c64fdf4dfcc2cad106b91aa110">ucx_map_iterator</a> (<a class="el" href="structUcxMap.html">UcxMap</a> const *map)</td></tr> |
| universe@390 | 197 | <tr class="memdesc:a9150e9c64fdf4dfcc2cad106b91aa110"><td class="mdescLeft"> </td><td class="mdescRight">Creates an iterator for a map. <a href="#a9150e9c64fdf4dfcc2cad106b91aa110">More...</a><br /></td></tr> |
| universe@390 | 198 | <tr class="separator:a9150e9c64fdf4dfcc2cad106b91aa110"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 199 | <tr class="memitem:aceb8675abf44860b4bbc301bbada5b91"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aceb8675abf44860b4bbc301bbada5b91">ucx_map_iter_next</a> (<a class="el" href="structUcxMapIterator.html">UcxMapIterator</a> *iterator, <a class="el" href="structUcxKey.html">UcxKey</a> *key, void **value)</td></tr> |
| universe@390 | 200 | <tr class="memdesc:aceb8675abf44860b4bbc301bbada5b91"><td class="mdescLeft"> </td><td class="mdescRight">Proceeds to the next element of the map (if any). <a href="#aceb8675abf44860b4bbc301bbada5b91">More...</a><br /></td></tr> |
| universe@390 | 201 | <tr class="separator:aceb8675abf44860b4bbc301bbada5b91"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 202 | <tr class="memitem:a3f65978c481af7f637cad021d93522d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a3f65978c481af7f637cad021d93522d5">ucx_map_union</a> (const <a class="el" href="structUcxMap.html">UcxMap</a> *first, const <a class="el" href="structUcxMap.html">UcxMap</a> *second, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> cpfnc, void *cpdata)</td></tr> |
| universe@390 | 203 | <tr class="memdesc:a3f65978c481af7f637cad021d93522d5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the union of two maps. <a href="#a3f65978c481af7f637cad021d93522d5">More...</a><br /></td></tr> |
| universe@390 | 204 | <tr class="separator:a3f65978c481af7f637cad021d93522d5"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 205 | <tr class="memitem:ab6370c3fa8113fdad593ce4b0460c9c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ab6370c3fa8113fdad593ce4b0460c9c6">ucx_map_union_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator, const <a class="el" href="structUcxMap.html">UcxMap</a> *first, const <a class="el" href="structUcxMap.html">UcxMap</a> *second, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> cpfnc, void *cpdata)</td></tr> |
| universe@390 | 206 | <tr class="memdesc:ab6370c3fa8113fdad593ce4b0460c9c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the union of two maps. <a href="#ab6370c3fa8113fdad593ce4b0460c9c6">More...</a><br /></td></tr> |
| universe@390 | 207 | <tr class="separator:ab6370c3fa8113fdad593ce4b0460c9c6"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 208 | <tr class="memitem:aa594d7a5afebc3bed6bb265348cf6b0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#aa594d7a5afebc3bed6bb265348cf6b0d">ucx_map_intersection</a> (const <a class="el" href="structUcxMap.html">UcxMap</a> *first, const <a class="el" href="structUcxMap.html">UcxMap</a> *second, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> cpfnc, void *cpdata)</td></tr> |
| universe@390 | 209 | <tr class="memdesc:aa594d7a5afebc3bed6bb265348cf6b0d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the intersection of two maps. <a href="#aa594d7a5afebc3bed6bb265348cf6b0d">More...</a><br /></td></tr> |
| universe@390 | 210 | <tr class="separator:aa594d7a5afebc3bed6bb265348cf6b0d"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 211 | <tr class="memitem:a169e0470a20484dd76425fdf77e3651e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a169e0470a20484dd76425fdf77e3651e">ucx_map_intersection_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator, const <a class="el" href="structUcxMap.html">UcxMap</a> *first, const <a class="el" href="structUcxMap.html">UcxMap</a> *second, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> cpfnc, void *cpdata)</td></tr> |
| universe@390 | 212 | <tr class="memdesc:a169e0470a20484dd76425fdf77e3651e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the intersection of two maps. <a href="#a169e0470a20484dd76425fdf77e3651e">More...</a><br /></td></tr> |
| universe@390 | 213 | <tr class="separator:a169e0470a20484dd76425fdf77e3651e"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 214 | <tr class="memitem:a774fcff87d1e58b6c5af77dd19a8c3dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a774fcff87d1e58b6c5af77dd19a8c3dc">ucx_map_difference</a> (const <a class="el" href="structUcxMap.html">UcxMap</a> *first, const <a class="el" href="structUcxMap.html">UcxMap</a> *second, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> cpfnc, void *cpdata)</td></tr> |
| universe@390 | 215 | <tr class="memdesc:a774fcff87d1e58b6c5af77dd19a8c3dc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the difference of two maps. <a href="#a774fcff87d1e58b6c5af77dd19a8c3dc">More...</a><br /></td></tr> |
| universe@390 | 216 | <tr class="separator:a774fcff87d1e58b6c5af77dd19a8c3dc"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 217 | <tr class="memitem:ad0ba103494247d798ac3037c50fc8831"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#ad0ba103494247d798ac3037c50fc8831">ucx_map_difference_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator, const <a class="el" href="structUcxMap.html">UcxMap</a> *first, const <a class="el" href="structUcxMap.html">UcxMap</a> *second, <a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> cpfnc, void *cpdata)</td></tr> |
| universe@390 | 218 | <tr class="memdesc:ad0ba103494247d798ac3037c50fc8831"><td class="mdescLeft"> </td><td class="mdescRight">Returns the difference of two maps. <a href="#ad0ba103494247d798ac3037c50fc8831">More...</a><br /></td></tr> |
| universe@390 | 219 | <tr class="separator:ad0ba103494247d798ac3037c50fc8831"><td class="memSeparator" colspan="2"> </td></tr> |
| universe@390 | 220 | </table> |
| universe@390 | 221 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| universe@390 | 222 | <div class="textblock"><p>Hash map implementation. </p> |
| universe@390 | 223 | <p>This implementation uses murmur hash 2 and separate chaining with linked lists.</p> |
| universe@390 | 224 | <dl class="section author"><dt>Author</dt><dd>Mike Becker </dd> |
| universe@390 | 225 | <dd> |
| universe@390 | 226 | Olaf Wintermann </dd></dl> |
| universe@390 | 227 | </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| universe@390 | 228 | <a id="a64e1fb55498fa502dd2ed8ed69062cdd"></a> |
| universe@390 | 229 | <h2 class="memtitle"><span class="permalink"><a href="#a64e1fb55498fa502dd2ed8ed69062cdd">◆ </a></span>ucx_map_cstr_get</h2> |
| universe@390 | 230 | |
| universe@390 | 231 | <div class="memitem"> |
| universe@390 | 232 | <div class="memproto"> |
| universe@390 | 233 | <table class="memname"> |
| universe@390 | 234 | <tr> |
| universe@390 | 235 | <td class="memname">#define ucx_map_cstr_get</td> |
| universe@390 | 236 | <td>(</td> |
| universe@390 | 237 | <td class="paramtype"> </td> |
| universe@390 | 238 | <td class="paramname">map, </td> |
| universe@390 | 239 | </tr> |
| universe@390 | 240 | <tr> |
| universe@390 | 241 | <td class="paramkey"></td> |
| universe@390 | 242 | <td></td> |
| universe@390 | 243 | <td class="paramtype"> </td> |
| universe@390 | 244 | <td class="paramname">key </td> |
| universe@390 | 245 | </tr> |
| universe@390 | 246 | <tr> |
| universe@390 | 247 | <td></td> |
| universe@390 | 248 | <td>)</td> |
| universe@390 | 249 | <td></td><td>   <a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key, strlen(key)))</td> |
| universe@390 | 250 | </tr> |
| universe@390 | 251 | </table> |
| universe@390 | 252 | </div><div class="memdoc"> |
| universe@390 | 253 | |
| universe@390 | 254 | <p>Shorthand for getting data from the map with a C string key. </p> |
| universe@390 | 255 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 256 | <table class="params"> |
| universe@390 | 257 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 258 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 259 | </table> |
| universe@390 | 260 | </dd> |
| universe@390 | 261 | </dl> |
| universe@390 | 262 | <dl class="section return"><dt>Returns</dt><dd>the value </dd></dl> |
| universe@390 | 263 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6" title="Retrieves a value by using a key. ">ucx_map_get()</a> </dd></dl> |
| universe@390 | 264 | |
| universe@390 | 265 | </div> |
| universe@390 | 266 | </div> |
| universe@390 | 267 | <a id="ad9356b01425b934ab237b52339ac0cc3"></a> |
| universe@390 | 268 | <h2 class="memtitle"><span class="permalink"><a href="#ad9356b01425b934ab237b52339ac0cc3">◆ </a></span>ucx_map_cstr_put</h2> |
| universe@390 | 269 | |
| universe@390 | 270 | <div class="memitem"> |
| universe@390 | 271 | <div class="memproto"> |
| universe@390 | 272 | <table class="memname"> |
| universe@390 | 273 | <tr> |
| universe@390 | 274 | <td class="memname">#define ucx_map_cstr_put</td> |
| universe@390 | 275 | <td>(</td> |
| universe@390 | 276 | <td class="paramtype"> </td> |
| universe@390 | 277 | <td class="paramname">map, </td> |
| universe@390 | 278 | </tr> |
| universe@390 | 279 | <tr> |
| universe@390 | 280 | <td class="paramkey"></td> |
| universe@390 | 281 | <td></td> |
| universe@390 | 282 | <td class="paramtype"> </td> |
| universe@390 | 283 | <td class="paramname">key, </td> |
| universe@390 | 284 | </tr> |
| universe@390 | 285 | <tr> |
| universe@390 | 286 | <td class="paramkey"></td> |
| universe@390 | 287 | <td></td> |
| universe@390 | 288 | <td class="paramtype"> </td> |
| universe@390 | 289 | <td class="paramname">value </td> |
| universe@390 | 290 | </tr> |
| universe@390 | 291 | <tr> |
| universe@390 | 292 | <td></td> |
| universe@390 | 293 | <td>)</td> |
| universe@390 | 294 | <td></td><td>   <a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key, strlen(key)), (void*)value)</td> |
| universe@390 | 295 | </tr> |
| universe@390 | 296 | </table> |
| universe@390 | 297 | </div><div class="memdoc"> |
| universe@390 | 298 | |
| universe@390 | 299 | <p>Shorthand for putting data with a C string key into the map. </p> |
| universe@390 | 300 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 301 | <table class="params"> |
| universe@390 | 302 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 303 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 304 | <tr><td class="paramname">value</td><td>the value </td></tr> |
| universe@390 | 305 | </table> |
| universe@390 | 306 | </dd> |
| universe@390 | 307 | </dl> |
| universe@390 | 308 | <dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero value on failure </dd></dl> |
| universe@390 | 309 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498" title="Puts a key/value-pair into the map. ">ucx_map_put()</a> </dd></dl> |
| universe@390 | 310 | |
| universe@390 | 311 | </div> |
| universe@390 | 312 | </div> |
| universe@390 | 313 | <a id="a9c4405a5a75ecf64e2ef3d0c6501a9fe"></a> |
| universe@390 | 314 | <h2 class="memtitle"><span class="permalink"><a href="#a9c4405a5a75ecf64e2ef3d0c6501a9fe">◆ </a></span>ucx_map_cstr_remove</h2> |
| universe@390 | 315 | |
| universe@390 | 316 | <div class="memitem"> |
| universe@390 | 317 | <div class="memproto"> |
| universe@390 | 318 | <table class="memname"> |
| universe@390 | 319 | <tr> |
| universe@390 | 320 | <td class="memname">#define ucx_map_cstr_remove</td> |
| universe@390 | 321 | <td>(</td> |
| universe@390 | 322 | <td class="paramtype"> </td> |
| universe@390 | 323 | <td class="paramname">map, </td> |
| universe@390 | 324 | </tr> |
| universe@390 | 325 | <tr> |
| universe@390 | 326 | <td class="paramkey"></td> |
| universe@390 | 327 | <td></td> |
| universe@390 | 328 | <td class="paramtype"> </td> |
| universe@390 | 329 | <td class="paramname">key </td> |
| universe@390 | 330 | </tr> |
| universe@390 | 331 | <tr> |
| universe@390 | 332 | <td></td> |
| universe@390 | 333 | <td>)</td> |
| universe@390 | 334 | <td></td><td>   <a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key, strlen(key)))</td> |
| universe@390 | 335 | </tr> |
| universe@390 | 336 | </table> |
| universe@390 | 337 | </div><div class="memdoc"> |
| universe@390 | 338 | |
| universe@390 | 339 | <p>Shorthand for removing data from the map with a C string key. </p> |
| universe@390 | 340 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 341 | <table class="params"> |
| universe@390 | 342 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 343 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 344 | </table> |
| universe@390 | 345 | </dd> |
| universe@390 | 346 | </dl> |
| universe@390 | 347 | <dl class="section return"><dt>Returns</dt><dd>the removed value </dd></dl> |
| universe@390 | 348 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa" title="Removes a key/value-pair from the map by using the key. ">ucx_map_remove()</a> </dd></dl> |
| universe@390 | 349 | |
| universe@390 | 350 | </div> |
| universe@390 | 351 | </div> |
| universe@390 | 352 | <a id="a940896c4aa1b13e54c55c04c3efc186b"></a> |
| universe@390 | 353 | <h2 class="memtitle"><span class="permalink"><a href="#a940896c4aa1b13e54c55c04c3efc186b">◆ </a></span>UCX_MAP_FOREACH</h2> |
| universe@390 | 354 | |
| universe@390 | 355 | <div class="memitem"> |
| universe@390 | 356 | <div class="memproto"> |
| universe@390 | 357 | <table class="memname"> |
| universe@390 | 358 | <tr> |
| universe@390 | 359 | <td class="memname">#define UCX_MAP_FOREACH</td> |
| universe@390 | 360 | <td>(</td> |
| universe@390 | 361 | <td class="paramtype"> </td> |
| universe@390 | 362 | <td class="paramname">key, </td> |
| universe@390 | 363 | </tr> |
| universe@390 | 364 | <tr> |
| universe@390 | 365 | <td class="paramkey"></td> |
| universe@390 | 366 | <td></td> |
| universe@390 | 367 | <td class="paramtype"> </td> |
| universe@390 | 368 | <td class="paramname">value, </td> |
| universe@390 | 369 | </tr> |
| universe@390 | 370 | <tr> |
| universe@390 | 371 | <td class="paramkey"></td> |
| universe@390 | 372 | <td></td> |
| universe@390 | 373 | <td class="paramtype"> </td> |
| universe@390 | 374 | <td class="paramname">iter </td> |
| universe@390 | 375 | </tr> |
| universe@390 | 376 | <tr> |
| universe@390 | 377 | <td></td> |
| universe@390 | 378 | <td>)</td> |
| universe@390 | 379 | <td></td><td>   for(<a class="el" href="structUcxKey.html">UcxKey</a> key;<a class="el" href="map_8h.html#aceb8675abf44860b4bbc301bbada5b91">ucx_map_iter_next</a>(&iter,&key, (void**)&value);)</td> |
| universe@390 | 380 | </tr> |
| universe@390 | 381 | </table> |
| universe@390 | 382 | </div><div class="memdoc"> |
| universe@390 | 383 | |
| universe@390 | 384 | <p>Loop statement for UCX maps. </p> |
| universe@390 | 385 | <p>The <code>key</code> variable is implicitly defined, but the <code>value</code> variable must be already declared as type information cannot be inferred.</p> |
| universe@390 | 386 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 387 | <table class="params"> |
| universe@390 | 388 | <tr><td class="paramname">key</td><td>the variable name for the key </td></tr> |
| universe@390 | 389 | <tr><td class="paramname">value</td><td>the variable name for the value </td></tr> |
| universe@390 | 390 | <tr><td class="paramname">iter</td><td>a <a class="el" href="structUcxMapIterator.html" title="Structure for an iterator over a UcxMap. ">UcxMapIterator</a> </td></tr> |
| universe@390 | 391 | </table> |
| universe@390 | 392 | </dd> |
| universe@390 | 393 | </dl> |
| universe@390 | 394 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a9150e9c64fdf4dfcc2cad106b91aa110" title="Creates an iterator for a map. ">ucx_map_iterator()</a> </dd></dl> |
| universe@390 | 395 | |
| universe@390 | 396 | </div> |
| universe@390 | 397 | </div> |
| universe@390 | 398 | <a id="aa1681bd2178553cd092fd24c4d681d3c"></a> |
| universe@390 | 399 | <h2 class="memtitle"><span class="permalink"><a href="#aa1681bd2178553cd092fd24c4d681d3c">◆ </a></span>ucx_map_int_get</h2> |
| universe@390 | 400 | |
| universe@390 | 401 | <div class="memitem"> |
| universe@390 | 402 | <div class="memproto"> |
| universe@390 | 403 | <table class="memname"> |
| universe@390 | 404 | <tr> |
| universe@390 | 405 | <td class="memname">#define ucx_map_int_get</td> |
| universe@390 | 406 | <td>(</td> |
| universe@390 | 407 | <td class="paramtype"> </td> |
| universe@390 | 408 | <td class="paramname">map, </td> |
| universe@390 | 409 | </tr> |
| universe@390 | 410 | <tr> |
| universe@390 | 411 | <td class="paramkey"></td> |
| universe@390 | 412 | <td></td> |
| universe@390 | 413 | <td class="paramtype"> </td> |
| universe@390 | 414 | <td class="paramname">key </td> |
| universe@390 | 415 | </tr> |
| universe@390 | 416 | <tr> |
| universe@390 | 417 | <td></td> |
| universe@390 | 418 | <td>)</td> |
| universe@390 | 419 | <td></td><td>   <a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(&key, sizeof(int)))</td> |
| universe@390 | 420 | </tr> |
| universe@390 | 421 | </table> |
| universe@390 | 422 | </div><div class="memdoc"> |
| universe@390 | 423 | |
| universe@390 | 424 | <p>Shorthand for getting data from the map with an integer key. </p> |
| universe@390 | 425 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 426 | <table class="params"> |
| universe@390 | 427 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 428 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 429 | </table> |
| universe@390 | 430 | </dd> |
| universe@390 | 431 | </dl> |
| universe@390 | 432 | <dl class="section return"><dt>Returns</dt><dd>the value </dd></dl> |
| universe@390 | 433 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6" title="Retrieves a value by using a key. ">ucx_map_get()</a> </dd></dl> |
| universe@390 | 434 | |
| universe@390 | 435 | </div> |
| universe@390 | 436 | </div> |
| universe@390 | 437 | <a id="aaa30af79b4068c923895619e83f44367"></a> |
| universe@390 | 438 | <h2 class="memtitle"><span class="permalink"><a href="#aaa30af79b4068c923895619e83f44367">◆ </a></span>ucx_map_int_put</h2> |
| universe@390 | 439 | |
| universe@390 | 440 | <div class="memitem"> |
| universe@390 | 441 | <div class="memproto"> |
| universe@390 | 442 | <table class="memname"> |
| universe@390 | 443 | <tr> |
| universe@390 | 444 | <td class="memname">#define ucx_map_int_put</td> |
| universe@390 | 445 | <td>(</td> |
| universe@390 | 446 | <td class="paramtype"> </td> |
| universe@390 | 447 | <td class="paramname">map, </td> |
| universe@390 | 448 | </tr> |
| universe@390 | 449 | <tr> |
| universe@390 | 450 | <td class="paramkey"></td> |
| universe@390 | 451 | <td></td> |
| universe@390 | 452 | <td class="paramtype"> </td> |
| universe@390 | 453 | <td class="paramname">key, </td> |
| universe@390 | 454 | </tr> |
| universe@390 | 455 | <tr> |
| universe@390 | 456 | <td class="paramkey"></td> |
| universe@390 | 457 | <td></td> |
| universe@390 | 458 | <td class="paramtype"> </td> |
| universe@390 | 459 | <td class="paramname">value </td> |
| universe@390 | 460 | </tr> |
| universe@390 | 461 | <tr> |
| universe@390 | 462 | <td></td> |
| universe@390 | 463 | <td>)</td> |
| universe@390 | 464 | <td></td><td>   <a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(&key, sizeof(key)), (void*)value)</td> |
| universe@390 | 465 | </tr> |
| universe@390 | 466 | </table> |
| universe@390 | 467 | </div><div class="memdoc"> |
| universe@390 | 468 | |
| universe@390 | 469 | <p>Shorthand for putting data with an integer key into the map. </p> |
| universe@390 | 470 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 471 | <table class="params"> |
| universe@390 | 472 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 473 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 474 | <tr><td class="paramname">value</td><td>the value </td></tr> |
| universe@390 | 475 | </table> |
| universe@390 | 476 | </dd> |
| universe@390 | 477 | </dl> |
| universe@390 | 478 | <dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero value on failure </dd></dl> |
| universe@390 | 479 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498" title="Puts a key/value-pair into the map. ">ucx_map_put()</a> </dd></dl> |
| universe@390 | 480 | |
| universe@390 | 481 | </div> |
| universe@390 | 482 | </div> |
| universe@390 | 483 | <a id="aa767958b5468737755c09f7185b1770c"></a> |
| universe@390 | 484 | <h2 class="memtitle"><span class="permalink"><a href="#aa767958b5468737755c09f7185b1770c">◆ </a></span>ucx_map_int_remove</h2> |
| universe@390 | 485 | |
| universe@390 | 486 | <div class="memitem"> |
| universe@390 | 487 | <div class="memproto"> |
| universe@390 | 488 | <table class="memname"> |
| universe@390 | 489 | <tr> |
| universe@390 | 490 | <td class="memname">#define ucx_map_int_remove</td> |
| universe@390 | 491 | <td>(</td> |
| universe@390 | 492 | <td class="paramtype"> </td> |
| universe@390 | 493 | <td class="paramname">map, </td> |
| universe@390 | 494 | </tr> |
| universe@390 | 495 | <tr> |
| universe@390 | 496 | <td class="paramkey"></td> |
| universe@390 | 497 | <td></td> |
| universe@390 | 498 | <td class="paramtype"> </td> |
| universe@390 | 499 | <td class="paramname">key </td> |
| universe@390 | 500 | </tr> |
| universe@390 | 501 | <tr> |
| universe@390 | 502 | <td></td> |
| universe@390 | 503 | <td>)</td> |
| universe@390 | 504 | <td></td><td>   <a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(&key, sizeof(key)))</td> |
| universe@390 | 505 | </tr> |
| universe@390 | 506 | </table> |
| universe@390 | 507 | </div><div class="memdoc"> |
| universe@390 | 508 | |
| universe@390 | 509 | <p>Shorthand for removing data from the map with an integer key. </p> |
| universe@390 | 510 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 511 | <table class="params"> |
| universe@390 | 512 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 513 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 514 | </table> |
| universe@390 | 515 | </dd> |
| universe@390 | 516 | </dl> |
| universe@390 | 517 | <dl class="section return"><dt>Returns</dt><dd>the removed value </dd></dl> |
| universe@390 | 518 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa" title="Removes a key/value-pair from the map by using the key. ">ucx_map_remove()</a> </dd></dl> |
| universe@390 | 519 | |
| universe@390 | 520 | </div> |
| universe@390 | 521 | </div> |
| universe@390 | 522 | <a id="a14d385f6b7f371f0507861cabd2eab4e"></a> |
| universe@390 | 523 | <h2 class="memtitle"><span class="permalink"><a href="#a14d385f6b7f371f0507861cabd2eab4e">◆ </a></span>ucx_map_sstr_get</h2> |
| universe@390 | 524 | |
| universe@390 | 525 | <div class="memitem"> |
| universe@390 | 526 | <div class="memproto"> |
| universe@390 | 527 | <table class="memname"> |
| universe@390 | 528 | <tr> |
| universe@390 | 529 | <td class="memname">#define ucx_map_sstr_get</td> |
| universe@390 | 530 | <td>(</td> |
| universe@390 | 531 | <td class="paramtype"> </td> |
| universe@390 | 532 | <td class="paramname">map, </td> |
| universe@390 | 533 | </tr> |
| universe@390 | 534 | <tr> |
| universe@390 | 535 | <td class="paramkey"></td> |
| universe@390 | 536 | <td></td> |
| universe@390 | 537 | <td class="paramtype"> </td> |
| universe@390 | 538 | <td class="paramname">key </td> |
| universe@390 | 539 | </tr> |
| universe@390 | 540 | <tr> |
| universe@390 | 541 | <td></td> |
| universe@390 | 542 | <td>)</td> |
| universe@390 | 543 | <td></td><td>   <a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6">ucx_map_get</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key.ptr, key.length))</td> |
| universe@390 | 544 | </tr> |
| universe@390 | 545 | </table> |
| universe@390 | 546 | </div><div class="memdoc"> |
| universe@390 | 547 | |
| universe@390 | 548 | <p>Shorthand for getting data from the map with a <a class="el" href="structsstr__t.html" title="The UCX string structure. ">sstr_t</a> key. </p> |
| universe@390 | 549 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 550 | <table class="params"> |
| universe@390 | 551 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 552 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 553 | </table> |
| universe@390 | 554 | </dd> |
| universe@390 | 555 | </dl> |
| universe@390 | 556 | <dl class="section return"><dt>Returns</dt><dd>the value </dd></dl> |
| universe@390 | 557 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#ab61192c5af2e06ecb9ad73880d1c95a6" title="Retrieves a value by using a key. ">ucx_map_get()</a> </dd></dl> |
| universe@390 | 558 | |
| universe@390 | 559 | </div> |
| universe@390 | 560 | </div> |
| universe@390 | 561 | <a id="ac26a8615bfc8f47ee9eaceb47645f98e"></a> |
| universe@390 | 562 | <h2 class="memtitle"><span class="permalink"><a href="#ac26a8615bfc8f47ee9eaceb47645f98e">◆ </a></span>ucx_map_sstr_put</h2> |
| universe@390 | 563 | |
| universe@390 | 564 | <div class="memitem"> |
| universe@390 | 565 | <div class="memproto"> |
| universe@390 | 566 | <table class="memname"> |
| universe@390 | 567 | <tr> |
| universe@390 | 568 | <td class="memname">#define ucx_map_sstr_put</td> |
| universe@390 | 569 | <td>(</td> |
| universe@390 | 570 | <td class="paramtype"> </td> |
| universe@390 | 571 | <td class="paramname">map, </td> |
| universe@390 | 572 | </tr> |
| universe@390 | 573 | <tr> |
| universe@390 | 574 | <td class="paramkey"></td> |
| universe@390 | 575 | <td></td> |
| universe@390 | 576 | <td class="paramtype"> </td> |
| universe@390 | 577 | <td class="paramname">key, </td> |
| universe@390 | 578 | </tr> |
| universe@390 | 579 | <tr> |
| universe@390 | 580 | <td class="paramkey"></td> |
| universe@390 | 581 | <td></td> |
| universe@390 | 582 | <td class="paramtype"> </td> |
| universe@390 | 583 | <td class="paramname">value </td> |
| universe@390 | 584 | </tr> |
| universe@390 | 585 | <tr> |
| universe@390 | 586 | <td></td> |
| universe@390 | 587 | <td>)</td> |
| universe@390 | 588 | <td></td><td>   <a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498">ucx_map_put</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key.ptr, key.length), (void*)value)</td> |
| universe@390 | 589 | </tr> |
| universe@390 | 590 | </table> |
| universe@390 | 591 | </div><div class="memdoc"> |
| universe@390 | 592 | |
| universe@390 | 593 | <p>Shorthand for putting data with a <a class="el" href="structsstr__t.html" title="The UCX string structure. ">sstr_t</a> key into the map. </p> |
| universe@390 | 594 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 595 | <table class="params"> |
| universe@390 | 596 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 597 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 598 | <tr><td class="paramname">value</td><td>the value </td></tr> |
| universe@390 | 599 | </table> |
| universe@390 | 600 | </dd> |
| universe@390 | 601 | </dl> |
| universe@390 | 602 | <dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero value on failure </dd></dl> |
| universe@390 | 603 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#ac04a08b604217070254d4c58f0e82498" title="Puts a key/value-pair into the map. ">ucx_map_put()</a> </dd></dl> |
| universe@390 | 604 | |
| universe@390 | 605 | </div> |
| universe@390 | 606 | </div> |
| universe@390 | 607 | <a id="a48700ea86fadb9ea54d13010f9124df2"></a> |
| universe@390 | 608 | <h2 class="memtitle"><span class="permalink"><a href="#a48700ea86fadb9ea54d13010f9124df2">◆ </a></span>ucx_map_sstr_remove</h2> |
| universe@390 | 609 | |
| universe@390 | 610 | <div class="memitem"> |
| universe@390 | 611 | <div class="memproto"> |
| universe@390 | 612 | <table class="memname"> |
| universe@390 | 613 | <tr> |
| universe@390 | 614 | <td class="memname">#define ucx_map_sstr_remove</td> |
| universe@390 | 615 | <td>(</td> |
| universe@390 | 616 | <td class="paramtype"> </td> |
| universe@390 | 617 | <td class="paramname">map, </td> |
| universe@390 | 618 | </tr> |
| universe@390 | 619 | <tr> |
| universe@390 | 620 | <td class="paramkey"></td> |
| universe@390 | 621 | <td></td> |
| universe@390 | 622 | <td class="paramtype"> </td> |
| universe@390 | 623 | <td class="paramname">key </td> |
| universe@390 | 624 | </tr> |
| universe@390 | 625 | <tr> |
| universe@390 | 626 | <td></td> |
| universe@390 | 627 | <td>)</td> |
| universe@390 | 628 | <td></td><td>   <a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa">ucx_map_remove</a>(map, <a class="el" href="map_8h.html#a3e540bb46b8ee19789aed63fd8919200">ucx_key</a>(key.ptr, key.length))</td> |
| universe@390 | 629 | </tr> |
| universe@390 | 630 | </table> |
| universe@390 | 631 | </div><div class="memdoc"> |
| universe@390 | 632 | |
| universe@390 | 633 | <p>Shorthand for removing data from the map with a <a class="el" href="structsstr__t.html" title="The UCX string structure. ">sstr_t</a> key. </p> |
| universe@390 | 634 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 635 | <table class="params"> |
| universe@390 | 636 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 637 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 638 | </table> |
| universe@390 | 639 | </dd> |
| universe@390 | 640 | </dl> |
| universe@390 | 641 | <dl class="section return"><dt>Returns</dt><dd>the removed value </dd></dl> |
| universe@390 | 642 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a17248a4888eb8f9ae18be522d64632aa" title="Removes a key/value-pair from the map by using the key. ">ucx_map_remove()</a> </dd></dl> |
| universe@390 | 643 | |
| universe@390 | 644 | </div> |
| universe@390 | 645 | </div> |
| universe@390 | 646 | <h2 class="groupheader">Typedef Documentation</h2> |
| universe@390 | 647 | <a id="ad63828bb23123fc01a5315a2bac3b142"></a> |
| universe@390 | 648 | <h2 class="memtitle"><span class="permalink"><a href="#ad63828bb23123fc01a5315a2bac3b142">◆ </a></span>UcxKey</h2> |
| universe@390 | 649 | |
| universe@390 | 650 | <div class="memitem"> |
| universe@390 | 651 | <div class="memproto"> |
| universe@390 | 652 | <table class="memname"> |
| universe@390 | 653 | <tr> |
| universe@390 | 654 | <td class="memname">typedef struct <a class="el" href="structUcxKey.html">UcxKey</a> <a class="el" href="structUcxKey.html">UcxKey</a></td> |
| universe@390 | 655 | </tr> |
| universe@390 | 656 | </table> |
| universe@390 | 657 | </div><div class="memdoc"> |
| universe@390 | 658 | |
| universe@390 | 659 | <p>Type for a key of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. </p> |
| universe@390 | 660 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxKey.html" title="Structure to publicly denote a key of a UcxMap. ">UcxKey</a> </dd></dl> |
| universe@390 | 661 | |
| universe@390 | 662 | </div> |
| universe@390 | 663 | </div> |
| universe@390 | 664 | <a id="a18e21948725b2da68c35da587a722033"></a> |
| universe@390 | 665 | <h2 class="memtitle"><span class="permalink"><a href="#a18e21948725b2da68c35da587a722033">◆ </a></span>UcxMap</h2> |
| universe@390 | 666 | |
| universe@390 | 667 | <div class="memitem"> |
| universe@390 | 668 | <div class="memproto"> |
| universe@390 | 669 | <table class="memname"> |
| universe@390 | 670 | <tr> |
| universe@390 | 671 | <td class="memname">typedef struct <a class="el" href="structUcxMap.html">UcxMap</a> <a class="el" href="structUcxMap.html">UcxMap</a></td> |
| universe@390 | 672 | </tr> |
| universe@390 | 673 | </table> |
| universe@390 | 674 | </div><div class="memdoc"> |
| universe@390 | 675 | |
| universe@390 | 676 | <p>Type for the UCX map. </p> |
| universe@390 | 677 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a> </dd></dl> |
| universe@390 | 678 | |
| universe@390 | 679 | </div> |
| universe@390 | 680 | </div> |
| universe@390 | 681 | <a id="ad7d7a910a32113eb93eae11c3dc97b4b"></a> |
| universe@390 | 682 | <h2 class="memtitle"><span class="permalink"><a href="#ad7d7a910a32113eb93eae11c3dc97b4b">◆ </a></span>UcxMapElement</h2> |
| universe@390 | 683 | |
| universe@390 | 684 | <div class="memitem"> |
| universe@390 | 685 | <div class="memproto"> |
| universe@390 | 686 | <table class="memname"> |
| universe@390 | 687 | <tr> |
| universe@390 | 688 | <td class="memname">typedef struct <a class="el" href="structUcxMapElement.html">UcxMapElement</a> <a class="el" href="structUcxMapElement.html">UcxMapElement</a></td> |
| universe@390 | 689 | </tr> |
| universe@390 | 690 | </table> |
| universe@390 | 691 | </div><div class="memdoc"> |
| universe@390 | 692 | |
| universe@390 | 693 | <p>Type for an element of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. </p> |
| universe@390 | 694 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxMapElement.html" title="Structure for an element of a UcxMap. ">UcxMapElement</a> </dd></dl> |
| universe@390 | 695 | |
| universe@390 | 696 | </div> |
| universe@390 | 697 | </div> |
| universe@390 | 698 | <a id="ae36aff5f645948c54f51578b11fd87fb"></a> |
| universe@390 | 699 | <h2 class="memtitle"><span class="permalink"><a href="#ae36aff5f645948c54f51578b11fd87fb">◆ </a></span>UcxMapIterator</h2> |
| universe@390 | 700 | |
| universe@390 | 701 | <div class="memitem"> |
| universe@390 | 702 | <div class="memproto"> |
| universe@390 | 703 | <table class="memname"> |
| universe@390 | 704 | <tr> |
| universe@390 | 705 | <td class="memname">typedef struct <a class="el" href="structUcxMapIterator.html">UcxMapIterator</a> <a class="el" href="structUcxMapIterator.html">UcxMapIterator</a></td> |
| universe@390 | 706 | </tr> |
| universe@390 | 707 | </table> |
| universe@390 | 708 | </div><div class="memdoc"> |
| universe@390 | 709 | |
| universe@390 | 710 | <p>Type for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a>. </p> |
| universe@390 | 711 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxMapIterator.html" title="Structure for an iterator over a UcxMap. ">UcxMapIterator</a> </dd></dl> |
| universe@390 | 712 | |
| universe@390 | 713 | </div> |
| universe@390 | 714 | </div> |
| universe@390 | 715 | <h2 class="groupheader">Function Documentation</h2> |
| universe@390 | 716 | <a id="aea3be97254c05595d986ef6a9faae87b"></a> |
| universe@390 | 717 | <h2 class="memtitle"><span class="permalink"><a href="#aea3be97254c05595d986ef6a9faae87b">◆ </a></span>ucx_hash()</h2> |
| universe@390 | 718 | |
| universe@390 | 719 | <div class="memitem"> |
| universe@390 | 720 | <div class="memproto"> |
| universe@390 | 721 | <table class="memname"> |
| universe@390 | 722 | <tr> |
| universe@390 | 723 | <td class="memname">int ucx_hash </td> |
| universe@390 | 724 | <td>(</td> |
| universe@390 | 725 | <td class="paramtype">const char * </td> |
| universe@390 | 726 | <td class="paramname"><em>data</em>, </td> |
| universe@390 | 727 | </tr> |
| universe@390 | 728 | <tr> |
| universe@390 | 729 | <td class="paramkey"></td> |
| universe@390 | 730 | <td></td> |
| universe@390 | 731 | <td class="paramtype">size_t </td> |
| universe@390 | 732 | <td class="paramname"><em>len</em> </td> |
| universe@390 | 733 | </tr> |
| universe@390 | 734 | <tr> |
| universe@390 | 735 | <td></td> |
| universe@390 | 736 | <td>)</td> |
| universe@390 | 737 | <td></td><td></td> |
| universe@390 | 738 | </tr> |
| universe@390 | 739 | </table> |
| universe@390 | 740 | </div><div class="memdoc"> |
| universe@390 | 741 | |
| universe@390 | 742 | <p>Computes a murmur hash-2. </p> |
| universe@390 | 743 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 744 | <table class="params"> |
| universe@390 | 745 | <tr><td class="paramname">data</td><td>the data to hash </td></tr> |
| universe@390 | 746 | <tr><td class="paramname">len</td><td>the length of the data </td></tr> |
| universe@390 | 747 | </table> |
| universe@390 | 748 | </dd> |
| universe@390 | 749 | </dl> |
| universe@390 | 750 | <dl class="section return"><dt>Returns</dt><dd>the murmur hash-2 of the data </dd></dl> |
| universe@390 | 751 | |
| universe@390 | 752 | </div> |
| universe@390 | 753 | </div> |
| universe@390 | 754 | <a id="a3e540bb46b8ee19789aed63fd8919200"></a> |
| universe@390 | 755 | <h2 class="memtitle"><span class="permalink"><a href="#a3e540bb46b8ee19789aed63fd8919200">◆ </a></span>ucx_key()</h2> |
| universe@390 | 756 | |
| universe@390 | 757 | <div class="memitem"> |
| universe@390 | 758 | <div class="memproto"> |
| universe@390 | 759 | <table class="memname"> |
| universe@390 | 760 | <tr> |
| universe@390 | 761 | <td class="memname"><a class="el" href="structUcxKey.html">UcxKey</a> ucx_key </td> |
| universe@390 | 762 | <td>(</td> |
| universe@390 | 763 | <td class="paramtype">const void * </td> |
| universe@390 | 764 | <td class="paramname"><em>data</em>, </td> |
| universe@390 | 765 | </tr> |
| universe@390 | 766 | <tr> |
| universe@390 | 767 | <td class="paramkey"></td> |
| universe@390 | 768 | <td></td> |
| universe@390 | 769 | <td class="paramtype">size_t </td> |
| universe@390 | 770 | <td class="paramname"><em>len</em> </td> |
| universe@390 | 771 | </tr> |
| universe@390 | 772 | <tr> |
| universe@390 | 773 | <td></td> |
| universe@390 | 774 | <td>)</td> |
| universe@390 | 775 | <td></td><td></td> |
| universe@390 | 776 | </tr> |
| universe@390 | 777 | </table> |
| universe@390 | 778 | </div><div class="memdoc"> |
| universe@390 | 779 | |
| universe@390 | 780 | <p>Creates a <a class="el" href="structUcxKey.html" title="Structure to publicly denote a key of a UcxMap. ">UcxKey</a> based on the given data. </p> |
| universe@390 | 781 | <p>This function implicitly computes the hash.</p> |
| universe@390 | 782 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 783 | <table class="params"> |
| universe@390 | 784 | <tr><td class="paramname">data</td><td>the data for the key </td></tr> |
| universe@390 | 785 | <tr><td class="paramname">len</td><td>the length of the data </td></tr> |
| universe@390 | 786 | </table> |
| universe@390 | 787 | </dd> |
| universe@390 | 788 | </dl> |
| universe@390 | 789 | <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="structUcxKey.html" title="Structure to publicly denote a key of a UcxMap. ">UcxKey</a> with implicitly computed hash </dd></dl> |
| universe@390 | 790 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#aea3be97254c05595d986ef6a9faae87b" title="Computes a murmur hash-2. ">ucx_hash()</a> </dd></dl> |
| universe@390 | 791 | |
| universe@390 | 792 | </div> |
| universe@390 | 793 | </div> |
| universe@390 | 794 | <a id="a285e90e40681c6d9631c935dda0967f2"></a> |
| universe@390 | 795 | <h2 class="memtitle"><span class="permalink"><a href="#a285e90e40681c6d9631c935dda0967f2">◆ </a></span>ucx_map_clear()</h2> |
| universe@390 | 796 | |
| universe@390 | 797 | <div class="memitem"> |
| universe@390 | 798 | <div class="memproto"> |
| universe@390 | 799 | <table class="memname"> |
| universe@390 | 800 | <tr> |
| universe@390 | 801 | <td class="memname">void ucx_map_clear </td> |
| universe@390 | 802 | <td>(</td> |
| universe@390 | 803 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 804 | <td class="paramname"><em>map</em></td><td>)</td> |
| universe@390 | 805 | <td></td> |
| universe@390 | 806 | </tr> |
| universe@390 | 807 | </table> |
| universe@390 | 808 | </div><div class="memdoc"> |
| universe@390 | 809 | |
| universe@390 | 810 | <p>Clears a hash map. </p> |
| universe@390 | 811 | <p><b>Note:</b> the contents are <b>not</b> freed, use <a class="el" href="map_8h.html#a750f3d9d83e2f3788a14c17a9d160618" title="Frees the contents of a hash map. ">ucx_map_free_content()</a> before calling this function to achieve that.</p> |
| universe@390 | 812 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 813 | <table class="params"> |
| universe@390 | 814 | <tr><td class="paramname">map</td><td>the map to be cleared </td></tr> |
| universe@390 | 815 | </table> |
| universe@390 | 816 | </dd> |
| universe@390 | 817 | </dl> |
| universe@390 | 818 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a750f3d9d83e2f3788a14c17a9d160618" title="Frees the contents of a hash map. ">ucx_map_free_content()</a> </dd></dl> |
| universe@390 | 819 | |
| universe@390 | 820 | </div> |
| universe@390 | 821 | </div> |
| universe@390 | 822 | <a id="a62c6c30cbb0d824ba710f5030ff9a4e4"></a> |
| universe@390 | 823 | <h2 class="memtitle"><span class="permalink"><a href="#a62c6c30cbb0d824ba710f5030ff9a4e4">◆ </a></span>ucx_map_clone()</h2> |
| universe@390 | 824 | |
| universe@390 | 825 | <div class="memitem"> |
| universe@390 | 826 | <div class="memproto"> |
| universe@390 | 827 | <table class="memname"> |
| universe@390 | 828 | <tr> |
| universe@390 | 829 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_clone </td> |
| universe@390 | 830 | <td>(</td> |
| universe@390 | 831 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> const * </td> |
| universe@390 | 832 | <td class="paramname"><em>map</em>, </td> |
| universe@390 | 833 | </tr> |
| universe@390 | 834 | <tr> |
| universe@390 | 835 | <td class="paramkey"></td> |
| universe@390 | 836 | <td></td> |
| universe@390 | 837 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 838 | <td class="paramname"><em>fnc</em>, </td> |
| universe@390 | 839 | </tr> |
| universe@390 | 840 | <tr> |
| universe@390 | 841 | <td class="paramkey"></td> |
| universe@390 | 842 | <td></td> |
| universe@390 | 843 | <td class="paramtype">void * </td> |
| universe@390 | 844 | <td class="paramname"><em>data</em> </td> |
| universe@390 | 845 | </tr> |
| universe@390 | 846 | <tr> |
| universe@390 | 847 | <td></td> |
| universe@390 | 848 | <td>)</td> |
| universe@390 | 849 | <td></td><td></td> |
| universe@390 | 850 | </tr> |
| universe@390 | 851 | </table> |
| universe@390 | 852 | </div><div class="memdoc"> |
| universe@390 | 853 | |
| universe@390 | 854 | <p>Clones the map and rehashes if necessary. </p> |
| universe@390 | 855 | <p><b>Note:</b> In contrast to <a class="el" href="map_8h.html#a174bce9fad554dd92b8da354e0d32512" title="Increases size of the hash map, if necessary. ">ucx_map_rehash()</a> the load factor is irrelevant. This function <em>always</em> ensures a new <a class="el" href="structUcxMap.html#afe120846b26d99580a7ff1276464e838" title="The size of the map is the length of the element list array. ">UcxMap.size</a> of at least 2.5*UcxMap.count.</p> |
| universe@390 | 856 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 857 | <table class="params"> |
| universe@390 | 858 | <tr><td class="paramname">map</td><td>the map to clone </td></tr> |
| universe@390 | 859 | <tr><td class="paramname">fnc</td><td>the copy function to use or <code>NULL</code> if the new and the old map shall share the data pointers </td></tr> |
| universe@390 | 860 | <tr><td class="paramname">data</td><td>additional data for the copy function </td></tr> |
| universe@390 | 861 | </table> |
| universe@390 | 862 | </dd> |
| universe@390 | 863 | </dl> |
| universe@390 | 864 | <dl class="section return"><dt>Returns</dt><dd>the cloned map </dd></dl> |
| universe@390 | 865 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#adfeb2d61003fd2896bcfdc9a57f36425" title="Copies contents from a map to another map using a copy function. ">ucx_map_copy()</a> </dd></dl> |
| universe@390 | 866 | |
| universe@390 | 867 | </div> |
| universe@390 | 868 | </div> |
| universe@390 | 869 | <a id="a9aea9103703d5c168420bb6bf85549ea"></a> |
| universe@390 | 870 | <h2 class="memtitle"><span class="permalink"><a href="#a9aea9103703d5c168420bb6bf85549ea">◆ </a></span>ucx_map_clone_a()</h2> |
| universe@390 | 871 | |
| universe@390 | 872 | <div class="memitem"> |
| universe@390 | 873 | <div class="memproto"> |
| universe@390 | 874 | <table class="memname"> |
| universe@390 | 875 | <tr> |
| universe@390 | 876 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_clone_a </td> |
| universe@390 | 877 | <td>(</td> |
| universe@390 | 878 | <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td> |
| universe@390 | 879 | <td class="paramname"><em>allocator</em>, </td> |
| universe@390 | 880 | </tr> |
| universe@390 | 881 | <tr> |
| universe@390 | 882 | <td class="paramkey"></td> |
| universe@390 | 883 | <td></td> |
| universe@390 | 884 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> const * </td> |
| universe@390 | 885 | <td class="paramname"><em>map</em>, </td> |
| universe@390 | 886 | </tr> |
| universe@390 | 887 | <tr> |
| universe@390 | 888 | <td class="paramkey"></td> |
| universe@390 | 889 | <td></td> |
| universe@390 | 890 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 891 | <td class="paramname"><em>fnc</em>, </td> |
| universe@390 | 892 | </tr> |
| universe@390 | 893 | <tr> |
| universe@390 | 894 | <td class="paramkey"></td> |
| universe@390 | 895 | <td></td> |
| universe@390 | 896 | <td class="paramtype">void * </td> |
| universe@390 | 897 | <td class="paramname"><em>data</em> </td> |
| universe@390 | 898 | </tr> |
| universe@390 | 899 | <tr> |
| universe@390 | 900 | <td></td> |
| universe@390 | 901 | <td>)</td> |
| universe@390 | 902 | <td></td><td></td> |
| universe@390 | 903 | </tr> |
| universe@390 | 904 | </table> |
| universe@390 | 905 | </div><div class="memdoc"> |
| universe@390 | 906 | |
| universe@390 | 907 | <p>Clones the map and rehashes if necessary. </p> |
| universe@390 | 908 | <p><b>Note:</b> In contrast to <a class="el" href="map_8h.html#a174bce9fad554dd92b8da354e0d32512" title="Increases size of the hash map, if necessary. ">ucx_map_rehash()</a> the load factor is irrelevant. This function <em>always</em> ensures a new <a class="el" href="structUcxMap.html#afe120846b26d99580a7ff1276464e838" title="The size of the map is the length of the element list array. ">UcxMap.size</a> of at least 2.5*UcxMap.count.</p> |
| universe@390 | 909 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 910 | <table class="params"> |
| universe@390 | 911 | <tr><td class="paramname">allocator</td><td>the allocator to use for the cloned map </td></tr> |
| universe@390 | 912 | <tr><td class="paramname">map</td><td>the map to clone </td></tr> |
| universe@390 | 913 | <tr><td class="paramname">fnc</td><td>the copy function to use or <code>NULL</code> if the new and the old map shall share the data pointers </td></tr> |
| universe@390 | 914 | <tr><td class="paramname">data</td><td>additional data for the copy function </td></tr> |
| universe@390 | 915 | </table> |
| universe@390 | 916 | </dd> |
| universe@390 | 917 | </dl> |
| universe@390 | 918 | <dl class="section return"><dt>Returns</dt><dd>the cloned map </dd></dl> |
| universe@390 | 919 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#adfeb2d61003fd2896bcfdc9a57f36425" title="Copies contents from a map to another map using a copy function. ">ucx_map_copy()</a> </dd></dl> |
| universe@390 | 920 | |
| universe@390 | 921 | </div> |
| universe@390 | 922 | </div> |
| universe@390 | 923 | <a id="adfeb2d61003fd2896bcfdc9a57f36425"></a> |
| universe@390 | 924 | <h2 class="memtitle"><span class="permalink"><a href="#adfeb2d61003fd2896bcfdc9a57f36425">◆ </a></span>ucx_map_copy()</h2> |
| universe@390 | 925 | |
| universe@390 | 926 | <div class="memitem"> |
| universe@390 | 927 | <div class="memproto"> |
| universe@390 | 928 | <table class="memname"> |
| universe@390 | 929 | <tr> |
| universe@390 | 930 | <td class="memname">int ucx_map_copy </td> |
| universe@390 | 931 | <td>(</td> |
| universe@390 | 932 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> const * </td> |
| universe@390 | 933 | <td class="paramname"><em>from</em>, </td> |
| universe@390 | 934 | </tr> |
| universe@390 | 935 | <tr> |
| universe@390 | 936 | <td class="paramkey"></td> |
| universe@390 | 937 | <td></td> |
| universe@390 | 938 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 939 | <td class="paramname"><em>to</em>, </td> |
| universe@390 | 940 | </tr> |
| universe@390 | 941 | <tr> |
| universe@390 | 942 | <td class="paramkey"></td> |
| universe@390 | 943 | <td></td> |
| universe@390 | 944 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 945 | <td class="paramname"><em>fnc</em>, </td> |
| universe@390 | 946 | </tr> |
| universe@390 | 947 | <tr> |
| universe@390 | 948 | <td class="paramkey"></td> |
| universe@390 | 949 | <td></td> |
| universe@390 | 950 | <td class="paramtype">void * </td> |
| universe@390 | 951 | <td class="paramname"><em>data</em> </td> |
| universe@390 | 952 | </tr> |
| universe@390 | 953 | <tr> |
| universe@390 | 954 | <td></td> |
| universe@390 | 955 | <td>)</td> |
| universe@390 | 956 | <td></td><td></td> |
| universe@390 | 957 | </tr> |
| universe@390 | 958 | </table> |
| universe@390 | 959 | </div><div class="memdoc"> |
| universe@390 | 960 | |
| universe@390 | 961 | <p>Copies contents from a map to another map using a copy function. </p> |
| universe@390 | 962 | <p><b>Note:</b> The destination map does not need to be empty. However, if it contains data with keys that are also present in the source map, the contents are overwritten.</p> |
| universe@390 | 963 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 964 | <table class="params"> |
| universe@390 | 965 | <tr><td class="paramname">from</td><td>the source map </td></tr> |
| universe@390 | 966 | <tr><td class="paramname">to</td><td>the destination map </td></tr> |
| universe@390 | 967 | <tr><td class="paramname">fnc</td><td>the copy function or <code>NULL</code> if the pointer address shall be copied </td></tr> |
| universe@390 | 968 | <tr><td class="paramname">data</td><td>additional data for the copy function </td></tr> |
| universe@390 | 969 | </table> |
| universe@390 | 970 | </dd> |
| universe@390 | 971 | </dl> |
| universe@390 | 972 | <dl class="section return"><dt>Returns</dt><dd>0 on success or a non-zero value on memory allocation errors </dd></dl> |
| universe@390 | 973 | |
| universe@390 | 974 | </div> |
| universe@390 | 975 | </div> |
| universe@390 | 976 | <a id="a774fcff87d1e58b6c5af77dd19a8c3dc"></a> |
| universe@390 | 977 | <h2 class="memtitle"><span class="permalink"><a href="#a774fcff87d1e58b6c5af77dd19a8c3dc">◆ </a></span>ucx_map_difference()</h2> |
| universe@390 | 978 | |
| universe@390 | 979 | <div class="memitem"> |
| universe@390 | 980 | <div class="memproto"> |
| universe@390 | 981 | <table class="memname"> |
| universe@390 | 982 | <tr> |
| universe@390 | 983 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_difference </td> |
| universe@390 | 984 | <td>(</td> |
| universe@390 | 985 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 986 | <td class="paramname"><em>first</em>, </td> |
| universe@390 | 987 | </tr> |
| universe@390 | 988 | <tr> |
| universe@390 | 989 | <td class="paramkey"></td> |
| universe@390 | 990 | <td></td> |
| universe@390 | 991 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 992 | <td class="paramname"><em>second</em>, </td> |
| universe@390 | 993 | </tr> |
| universe@390 | 994 | <tr> |
| universe@390 | 995 | <td class="paramkey"></td> |
| universe@390 | 996 | <td></td> |
| universe@390 | 997 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 998 | <td class="paramname"><em>cpfnc</em>, </td> |
| universe@390 | 999 | </tr> |
| universe@390 | 1000 | <tr> |
| universe@390 | 1001 | <td class="paramkey"></td> |
| universe@390 | 1002 | <td></td> |
| universe@390 | 1003 | <td class="paramtype">void * </td> |
| universe@390 | 1004 | <td class="paramname"><em>cpdata</em> </td> |
| universe@390 | 1005 | </tr> |
| universe@390 | 1006 | <tr> |
| universe@390 | 1007 | <td></td> |
| universe@390 | 1008 | <td>)</td> |
| universe@390 | 1009 | <td></td><td></td> |
| universe@390 | 1010 | </tr> |
| universe@390 | 1011 | </table> |
| universe@390 | 1012 | </div><div class="memdoc"> |
| universe@390 | 1013 | |
| universe@390 | 1014 | <p>Returns the difference of two maps. </p> |
| universe@390 | 1015 | <p>The difference contains a copy of all elements of the first map for which the corresponding keys cannot be found in the second map.</p> |
| universe@390 | 1016 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1017 | <table class="params"> |
| universe@390 | 1018 | <tr><td class="paramname">first</td><td>the first source map </td></tr> |
| universe@390 | 1019 | <tr><td class="paramname">second</td><td>the second source map </td></tr> |
| universe@390 | 1020 | <tr><td class="paramname">cpfnc</td><td>a function to copy the elements </td></tr> |
| universe@390 | 1021 | <tr><td class="paramname">cpdata</td><td>additional data for the copy function </td></tr> |
| universe@390 | 1022 | </table> |
| universe@390 | 1023 | </dd> |
| universe@390 | 1024 | </dl> |
| universe@390 | 1025 | <dl class="section return"><dt>Returns</dt><dd>a new list containing the difference </dd></dl> |
| universe@390 | 1026 | |
| universe@390 | 1027 | </div> |
| universe@390 | 1028 | </div> |
| universe@390 | 1029 | <a id="ad0ba103494247d798ac3037c50fc8831"></a> |
| universe@390 | 1030 | <h2 class="memtitle"><span class="permalink"><a href="#ad0ba103494247d798ac3037c50fc8831">◆ </a></span>ucx_map_difference_a()</h2> |
| universe@390 | 1031 | |
| universe@390 | 1032 | <div class="memitem"> |
| universe@390 | 1033 | <div class="memproto"> |
| universe@390 | 1034 | <table class="memname"> |
| universe@390 | 1035 | <tr> |
| universe@390 | 1036 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_difference_a </td> |
| universe@390 | 1037 | <td>(</td> |
| universe@390 | 1038 | <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td> |
| universe@390 | 1039 | <td class="paramname"><em>allocator</em>, </td> |
| universe@390 | 1040 | </tr> |
| universe@390 | 1041 | <tr> |
| universe@390 | 1042 | <td class="paramkey"></td> |
| universe@390 | 1043 | <td></td> |
| universe@390 | 1044 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1045 | <td class="paramname"><em>first</em>, </td> |
| universe@390 | 1046 | </tr> |
| universe@390 | 1047 | <tr> |
| universe@390 | 1048 | <td class="paramkey"></td> |
| universe@390 | 1049 | <td></td> |
| universe@390 | 1050 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1051 | <td class="paramname"><em>second</em>, </td> |
| universe@390 | 1052 | </tr> |
| universe@390 | 1053 | <tr> |
| universe@390 | 1054 | <td class="paramkey"></td> |
| universe@390 | 1055 | <td></td> |
| universe@390 | 1056 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 1057 | <td class="paramname"><em>cpfnc</em>, </td> |
| universe@390 | 1058 | </tr> |
| universe@390 | 1059 | <tr> |
| universe@390 | 1060 | <td class="paramkey"></td> |
| universe@390 | 1061 | <td></td> |
| universe@390 | 1062 | <td class="paramtype">void * </td> |
| universe@390 | 1063 | <td class="paramname"><em>cpdata</em> </td> |
| universe@390 | 1064 | </tr> |
| universe@390 | 1065 | <tr> |
| universe@390 | 1066 | <td></td> |
| universe@390 | 1067 | <td>)</td> |
| universe@390 | 1068 | <td></td><td></td> |
| universe@390 | 1069 | </tr> |
| universe@390 | 1070 | </table> |
| universe@390 | 1071 | </div><div class="memdoc"> |
| universe@390 | 1072 | |
| universe@390 | 1073 | <p>Returns the difference of two maps. </p> |
| universe@390 | 1074 | <p>The difference contains a copy of all elements of the first map for which the corresponding keys cannot be found in the second map.</p> |
| universe@390 | 1075 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1076 | <table class="params"> |
| universe@390 | 1077 | <tr><td class="paramname">allocator</td><td>the allocator that shall be used by the new map </td></tr> |
| universe@390 | 1078 | <tr><td class="paramname">first</td><td>the first source map </td></tr> |
| universe@390 | 1079 | <tr><td class="paramname">second</td><td>the second source map </td></tr> |
| universe@390 | 1080 | <tr><td class="paramname">cpfnc</td><td>a function to copy the elements </td></tr> |
| universe@390 | 1081 | <tr><td class="paramname">cpdata</td><td>additional data for the copy function </td></tr> |
| universe@390 | 1082 | </table> |
| universe@390 | 1083 | </dd> |
| universe@390 | 1084 | </dl> |
| universe@390 | 1085 | <dl class="section return"><dt>Returns</dt><dd>a new list containing the difference </dd></dl> |
| universe@390 | 1086 | |
| universe@390 | 1087 | </div> |
| universe@390 | 1088 | </div> |
| universe@390 | 1089 | <a id="abe3d9688e4224bf7bb962abf25ff8c2e"></a> |
| universe@390 | 1090 | <h2 class="memtitle"><span class="permalink"><a href="#abe3d9688e4224bf7bb962abf25ff8c2e">◆ </a></span>ucx_map_free()</h2> |
| universe@390 | 1091 | |
| universe@390 | 1092 | <div class="memitem"> |
| universe@390 | 1093 | <div class="memproto"> |
| universe@390 | 1094 | <table class="memname"> |
| universe@390 | 1095 | <tr> |
| universe@390 | 1096 | <td class="memname">void ucx_map_free </td> |
| universe@390 | 1097 | <td>(</td> |
| universe@390 | 1098 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1099 | <td class="paramname"><em>map</em></td><td>)</td> |
| universe@390 | 1100 | <td></td> |
| universe@390 | 1101 | </tr> |
| universe@390 | 1102 | </table> |
| universe@390 | 1103 | </div><div class="memdoc"> |
| universe@390 | 1104 | |
| universe@390 | 1105 | <p>Frees a hash map. </p> |
| universe@390 | 1106 | <p><b>Note:</b> the contents are <b>not</b> freed, use <a class="el" href="map_8h.html#a750f3d9d83e2f3788a14c17a9d160618" title="Frees the contents of a hash map. ">ucx_map_free_content()</a> before calling this function to achieve that.</p> |
| universe@390 | 1107 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1108 | <table class="params"> |
| universe@390 | 1109 | <tr><td class="paramname">map</td><td>the map to be freed </td></tr> |
| universe@390 | 1110 | </table> |
| universe@390 | 1111 | </dd> |
| universe@390 | 1112 | </dl> |
| universe@390 | 1113 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a750f3d9d83e2f3788a14c17a9d160618" title="Frees the contents of a hash map. ">ucx_map_free_content()</a> </dd></dl> |
| universe@390 | 1114 | |
| universe@390 | 1115 | </div> |
| universe@390 | 1116 | </div> |
| universe@390 | 1117 | <a id="a750f3d9d83e2f3788a14c17a9d160618"></a> |
| universe@390 | 1118 | <h2 class="memtitle"><span class="permalink"><a href="#a750f3d9d83e2f3788a14c17a9d160618">◆ </a></span>ucx_map_free_content()</h2> |
| universe@390 | 1119 | |
| universe@390 | 1120 | <div class="memitem"> |
| universe@390 | 1121 | <div class="memproto"> |
| universe@390 | 1122 | <table class="memname"> |
| universe@390 | 1123 | <tr> |
| universe@390 | 1124 | <td class="memname">void ucx_map_free_content </td> |
| universe@390 | 1125 | <td>(</td> |
| universe@390 | 1126 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1127 | <td class="paramname"><em>map</em>, </td> |
| universe@390 | 1128 | </tr> |
| universe@390 | 1129 | <tr> |
| universe@390 | 1130 | <td class="paramkey"></td> |
| universe@390 | 1131 | <td></td> |
| universe@390 | 1132 | <td class="paramtype"><a class="el" href="ucx_8h.html#ad2b370c2809914c8b7fedab163c266b3">ucx_destructor</a> </td> |
| universe@390 | 1133 | <td class="paramname"><em>destr</em> </td> |
| universe@390 | 1134 | </tr> |
| universe@390 | 1135 | <tr> |
| universe@390 | 1136 | <td></td> |
| universe@390 | 1137 | <td>)</td> |
| universe@390 | 1138 | <td></td><td></td> |
| universe@390 | 1139 | </tr> |
| universe@390 | 1140 | </table> |
| universe@390 | 1141 | </div><div class="memdoc"> |
| universe@390 | 1142 | |
| universe@390 | 1143 | <p>Frees the contents of a hash map. </p> |
| universe@390 | 1144 | <p>This is a convenience function that iterates over the map and passes all values to the specified destructor function.</p> |
| universe@390 | 1145 | <p>If no destructor is specified (<code>NULL</code>), the free() function of the map's own allocator is used.</p> |
| universe@390 | 1146 | <p>You must ensure, that it is valid to pass each value in the map to the same destructor function.</p> |
| universe@390 | 1147 | <p>You should free or clear the map afterwards, as the contents will be invalid.</p> |
| universe@390 | 1148 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1149 | <table class="params"> |
| universe@390 | 1150 | <tr><td class="paramname">map</td><td>for which the contents shall be freed </td></tr> |
| universe@390 | 1151 | <tr><td class="paramname">destr</td><td>optional pointer to a destructor function </td></tr> |
| universe@390 | 1152 | </table> |
| universe@390 | 1153 | </dd> |
| universe@390 | 1154 | </dl> |
| universe@390 | 1155 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#abe3d9688e4224bf7bb962abf25ff8c2e" title="Frees a hash map. ">ucx_map_free()</a> </dd> |
| universe@390 | 1156 | <dd> |
| universe@390 | 1157 | <a class="el" href="map_8h.html#a285e90e40681c6d9631c935dda0967f2" title="Clears a hash map. ">ucx_map_clear()</a> </dd></dl> |
| universe@390 | 1158 | |
| universe@390 | 1159 | </div> |
| universe@390 | 1160 | </div> |
| universe@390 | 1161 | <a id="ab61192c5af2e06ecb9ad73880d1c95a6"></a> |
| universe@390 | 1162 | <h2 class="memtitle"><span class="permalink"><a href="#ab61192c5af2e06ecb9ad73880d1c95a6">◆ </a></span>ucx_map_get()</h2> |
| universe@390 | 1163 | |
| universe@390 | 1164 | <div class="memitem"> |
| universe@390 | 1165 | <div class="memproto"> |
| universe@390 | 1166 | <table class="memname"> |
| universe@390 | 1167 | <tr> |
| universe@390 | 1168 | <td class="memname">void* ucx_map_get </td> |
| universe@390 | 1169 | <td>(</td> |
| universe@390 | 1170 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> const * </td> |
| universe@390 | 1171 | <td class="paramname"><em>map</em>, </td> |
| universe@390 | 1172 | </tr> |
| universe@390 | 1173 | <tr> |
| universe@390 | 1174 | <td class="paramkey"></td> |
| universe@390 | 1175 | <td></td> |
| universe@390 | 1176 | <td class="paramtype"><a class="el" href="structUcxKey.html">UcxKey</a> </td> |
| universe@390 | 1177 | <td class="paramname"><em>key</em> </td> |
| universe@390 | 1178 | </tr> |
| universe@390 | 1179 | <tr> |
| universe@390 | 1180 | <td></td> |
| universe@390 | 1181 | <td>)</td> |
| universe@390 | 1182 | <td></td><td></td> |
| universe@390 | 1183 | </tr> |
| universe@390 | 1184 | </table> |
| universe@390 | 1185 | </div><div class="memdoc"> |
| universe@390 | 1186 | |
| universe@390 | 1187 | <p>Retrieves a value by using a key. </p> |
| universe@390 | 1188 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1189 | <table class="params"> |
| universe@390 | 1190 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 1191 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 1192 | </table> |
| universe@390 | 1193 | </dd> |
| universe@390 | 1194 | </dl> |
| universe@390 | 1195 | <dl class="section return"><dt>Returns</dt><dd>the value </dd></dl> |
| universe@390 | 1196 | |
| universe@390 | 1197 | </div> |
| universe@390 | 1198 | </div> |
| universe@390 | 1199 | <a id="aa594d7a5afebc3bed6bb265348cf6b0d"></a> |
| universe@390 | 1200 | <h2 class="memtitle"><span class="permalink"><a href="#aa594d7a5afebc3bed6bb265348cf6b0d">◆ </a></span>ucx_map_intersection()</h2> |
| universe@390 | 1201 | |
| universe@390 | 1202 | <div class="memitem"> |
| universe@390 | 1203 | <div class="memproto"> |
| universe@390 | 1204 | <table class="memname"> |
| universe@390 | 1205 | <tr> |
| universe@390 | 1206 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_intersection </td> |
| universe@390 | 1207 | <td>(</td> |
| universe@390 | 1208 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1209 | <td class="paramname"><em>first</em>, </td> |
| universe@390 | 1210 | </tr> |
| universe@390 | 1211 | <tr> |
| universe@390 | 1212 | <td class="paramkey"></td> |
| universe@390 | 1213 | <td></td> |
| universe@390 | 1214 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1215 | <td class="paramname"><em>second</em>, </td> |
| universe@390 | 1216 | </tr> |
| universe@390 | 1217 | <tr> |
| universe@390 | 1218 | <td class="paramkey"></td> |
| universe@390 | 1219 | <td></td> |
| universe@390 | 1220 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 1221 | <td class="paramname"><em>cpfnc</em>, </td> |
| universe@390 | 1222 | </tr> |
| universe@390 | 1223 | <tr> |
| universe@390 | 1224 | <td class="paramkey"></td> |
| universe@390 | 1225 | <td></td> |
| universe@390 | 1226 | <td class="paramtype">void * </td> |
| universe@390 | 1227 | <td class="paramname"><em>cpdata</em> </td> |
| universe@390 | 1228 | </tr> |
| universe@390 | 1229 | <tr> |
| universe@390 | 1230 | <td></td> |
| universe@390 | 1231 | <td>)</td> |
| universe@390 | 1232 | <td></td><td></td> |
| universe@390 | 1233 | </tr> |
| universe@390 | 1234 | </table> |
| universe@390 | 1235 | </div><div class="memdoc"> |
| universe@390 | 1236 | |
| universe@390 | 1237 | <p>Returns the intersection of two maps. </p> |
| universe@390 | 1238 | <p>The intersection is defined as a copy of the first map with every element removed that has no valid key in the second map.</p> |
| universe@390 | 1239 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1240 | <table class="params"> |
| universe@390 | 1241 | <tr><td class="paramname">first</td><td>the first source map </td></tr> |
| universe@390 | 1242 | <tr><td class="paramname">second</td><td>the second source map </td></tr> |
| universe@390 | 1243 | <tr><td class="paramname">cpfnc</td><td>a function to copy the elements </td></tr> |
| universe@390 | 1244 | <tr><td class="paramname">cpdata</td><td>additional data for the copy function </td></tr> |
| universe@390 | 1245 | </table> |
| universe@390 | 1246 | </dd> |
| universe@390 | 1247 | </dl> |
| universe@390 | 1248 | <dl class="section return"><dt>Returns</dt><dd>a new map containing the intersection </dd></dl> |
| universe@390 | 1249 | |
| universe@390 | 1250 | </div> |
| universe@390 | 1251 | </div> |
| universe@390 | 1252 | <a id="a169e0470a20484dd76425fdf77e3651e"></a> |
| universe@390 | 1253 | <h2 class="memtitle"><span class="permalink"><a href="#a169e0470a20484dd76425fdf77e3651e">◆ </a></span>ucx_map_intersection_a()</h2> |
| universe@390 | 1254 | |
| universe@390 | 1255 | <div class="memitem"> |
| universe@390 | 1256 | <div class="memproto"> |
| universe@390 | 1257 | <table class="memname"> |
| universe@390 | 1258 | <tr> |
| universe@390 | 1259 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_intersection_a </td> |
| universe@390 | 1260 | <td>(</td> |
| universe@390 | 1261 | <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td> |
| universe@390 | 1262 | <td class="paramname"><em>allocator</em>, </td> |
| universe@390 | 1263 | </tr> |
| universe@390 | 1264 | <tr> |
| universe@390 | 1265 | <td class="paramkey"></td> |
| universe@390 | 1266 | <td></td> |
| universe@390 | 1267 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1268 | <td class="paramname"><em>first</em>, </td> |
| universe@390 | 1269 | </tr> |
| universe@390 | 1270 | <tr> |
| universe@390 | 1271 | <td class="paramkey"></td> |
| universe@390 | 1272 | <td></td> |
| universe@390 | 1273 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1274 | <td class="paramname"><em>second</em>, </td> |
| universe@390 | 1275 | </tr> |
| universe@390 | 1276 | <tr> |
| universe@390 | 1277 | <td class="paramkey"></td> |
| universe@390 | 1278 | <td></td> |
| universe@390 | 1279 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 1280 | <td class="paramname"><em>cpfnc</em>, </td> |
| universe@390 | 1281 | </tr> |
| universe@390 | 1282 | <tr> |
| universe@390 | 1283 | <td class="paramkey"></td> |
| universe@390 | 1284 | <td></td> |
| universe@390 | 1285 | <td class="paramtype">void * </td> |
| universe@390 | 1286 | <td class="paramname"><em>cpdata</em> </td> |
| universe@390 | 1287 | </tr> |
| universe@390 | 1288 | <tr> |
| universe@390 | 1289 | <td></td> |
| universe@390 | 1290 | <td>)</td> |
| universe@390 | 1291 | <td></td><td></td> |
| universe@390 | 1292 | </tr> |
| universe@390 | 1293 | </table> |
| universe@390 | 1294 | </div><div class="memdoc"> |
| universe@390 | 1295 | |
| universe@390 | 1296 | <p>Returns the intersection of two maps. </p> |
| universe@390 | 1297 | <p>The intersection is defined as a copy of the first map with every element removed that has no valid key in the second map.</p> |
| universe@390 | 1298 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1299 | <table class="params"> |
| universe@390 | 1300 | <tr><td class="paramname">allocator</td><td>the allocator that shall be used by the new map </td></tr> |
| universe@390 | 1301 | <tr><td class="paramname">first</td><td>the first source map </td></tr> |
| universe@390 | 1302 | <tr><td class="paramname">second</td><td>the second source map </td></tr> |
| universe@390 | 1303 | <tr><td class="paramname">cpfnc</td><td>a function to copy the elements </td></tr> |
| universe@390 | 1304 | <tr><td class="paramname">cpdata</td><td>additional data for the copy function </td></tr> |
| universe@390 | 1305 | </table> |
| universe@390 | 1306 | </dd> |
| universe@390 | 1307 | </dl> |
| universe@390 | 1308 | <dl class="section return"><dt>Returns</dt><dd>a new map containing the intersection </dd></dl> |
| universe@390 | 1309 | |
| universe@390 | 1310 | </div> |
| universe@390 | 1311 | </div> |
| universe@390 | 1312 | <a id="aceb8675abf44860b4bbc301bbada5b91"></a> |
| universe@390 | 1313 | <h2 class="memtitle"><span class="permalink"><a href="#aceb8675abf44860b4bbc301bbada5b91">◆ </a></span>ucx_map_iter_next()</h2> |
| universe@390 | 1314 | |
| universe@390 | 1315 | <div class="memitem"> |
| universe@390 | 1316 | <div class="memproto"> |
| universe@390 | 1317 | <table class="memname"> |
| universe@390 | 1318 | <tr> |
| universe@390 | 1319 | <td class="memname">int ucx_map_iter_next </td> |
| universe@390 | 1320 | <td>(</td> |
| universe@390 | 1321 | <td class="paramtype"><a class="el" href="structUcxMapIterator.html">UcxMapIterator</a> * </td> |
| universe@390 | 1322 | <td class="paramname"><em>iterator</em>, </td> |
| universe@390 | 1323 | </tr> |
| universe@390 | 1324 | <tr> |
| universe@390 | 1325 | <td class="paramkey"></td> |
| universe@390 | 1326 | <td></td> |
| universe@390 | 1327 | <td class="paramtype"><a class="el" href="structUcxKey.html">UcxKey</a> * </td> |
| universe@390 | 1328 | <td class="paramname"><em>key</em>, </td> |
| universe@390 | 1329 | </tr> |
| universe@390 | 1330 | <tr> |
| universe@390 | 1331 | <td class="paramkey"></td> |
| universe@390 | 1332 | <td></td> |
| universe@390 | 1333 | <td class="paramtype">void ** </td> |
| universe@390 | 1334 | <td class="paramname"><em>value</em> </td> |
| universe@390 | 1335 | </tr> |
| universe@390 | 1336 | <tr> |
| universe@390 | 1337 | <td></td> |
| universe@390 | 1338 | <td>)</td> |
| universe@390 | 1339 | <td></td><td></td> |
| universe@390 | 1340 | </tr> |
| universe@390 | 1341 | </table> |
| universe@390 | 1342 | </div><div class="memdoc"> |
| universe@390 | 1343 | |
| universe@390 | 1344 | <p>Proceeds to the next element of the map (if any). </p> |
| universe@390 | 1345 | <p>Subsequent calls on the same iterator proceed to the next element and store the key/value-pair into the memory specified as arguments of this function.</p> |
| universe@390 | 1346 | <p>If no further elements are found, this function returns zero and leaves the last found key/value-pair in memory.</p> |
| universe@390 | 1347 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1348 | <table class="params"> |
| universe@390 | 1349 | <tr><td class="paramname">iterator</td><td>the iterator to use </td></tr> |
| universe@390 | 1350 | <tr><td class="paramname">key</td><td>a pointer to the memory where to store the key </td></tr> |
| universe@390 | 1351 | <tr><td class="paramname">value</td><td>a pointer to the memory where to store the value </td></tr> |
| universe@390 | 1352 | </table> |
| universe@390 | 1353 | </dd> |
| universe@390 | 1354 | </dl> |
| universe@390 | 1355 | <dl class="section return"><dt>Returns</dt><dd>1, if another element was found, 0 if all elements has been processed </dd></dl> |
| universe@390 | 1356 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#a9150e9c64fdf4dfcc2cad106b91aa110" title="Creates an iterator for a map. ">ucx_map_iterator()</a> </dd></dl> |
| universe@390 | 1357 | |
| universe@390 | 1358 | </div> |
| universe@390 | 1359 | </div> |
| universe@390 | 1360 | <a id="a9150e9c64fdf4dfcc2cad106b91aa110"></a> |
| universe@390 | 1361 | <h2 class="memtitle"><span class="permalink"><a href="#a9150e9c64fdf4dfcc2cad106b91aa110">◆ </a></span>ucx_map_iterator()</h2> |
| universe@390 | 1362 | |
| universe@390 | 1363 | <div class="memitem"> |
| universe@390 | 1364 | <div class="memproto"> |
| universe@390 | 1365 | <table class="memname"> |
| universe@390 | 1366 | <tr> |
| universe@390 | 1367 | <td class="memname"><a class="el" href="structUcxMapIterator.html">UcxMapIterator</a> ucx_map_iterator </td> |
| universe@390 | 1368 | <td>(</td> |
| universe@390 | 1369 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> const * </td> |
| universe@390 | 1370 | <td class="paramname"><em>map</em></td><td>)</td> |
| universe@390 | 1371 | <td></td> |
| universe@390 | 1372 | </tr> |
| universe@390 | 1373 | </table> |
| universe@390 | 1374 | </div><div class="memdoc"> |
| universe@390 | 1375 | |
| universe@390 | 1376 | <p>Creates an iterator for a map. </p> |
| universe@390 | 1377 | <p><b>Note:</b> A <a class="el" href="structUcxMapIterator.html" title="Structure for an iterator over a UcxMap. ">UcxMapIterator</a> iterates over all elements in all element lists successively. Therefore the order highly depends on the key hashes and may vary under different map sizes. So generally you may <b>NOT</b> rely on the iteration order.</p> |
| universe@390 | 1378 | <p><b>Note:</b> The iterator is <b>NOT</b> initialized. You need to call <a class="el" href="map_8h.html#aceb8675abf44860b4bbc301bbada5b91" title="Proceeds to the next element of the map (if any). ">ucx_map_iter_next()</a> at least once before accessing any information. However, it is not recommended to access the fields of a <a class="el" href="structUcxMapIterator.html" title="Structure for an iterator over a UcxMap. ">UcxMapIterator</a> directly.</p> |
| universe@390 | 1379 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1380 | <table class="params"> |
| universe@390 | 1381 | <tr><td class="paramname">map</td><td>the map to create the iterator for </td></tr> |
| universe@390 | 1382 | </table> |
| universe@390 | 1383 | </dd> |
| universe@390 | 1384 | </dl> |
| universe@390 | 1385 | <dl class="section return"><dt>Returns</dt><dd>an iterator initialized on the first element of the first element list </dd></dl> |
| universe@390 | 1386 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html#aceb8675abf44860b4bbc301bbada5b91" title="Proceeds to the next element of the map (if any). ">ucx_map_iter_next()</a> </dd></dl> |
| universe@390 | 1387 | |
| universe@390 | 1388 | </div> |
| universe@390 | 1389 | </div> |
| universe@390 | 1390 | <a id="a79f31de8b93814493759dbc8b940cf0c"></a> |
| universe@390 | 1391 | <h2 class="memtitle"><span class="permalink"><a href="#a79f31de8b93814493759dbc8b940cf0c">◆ </a></span>ucx_map_new()</h2> |
| universe@390 | 1392 | |
| universe@390 | 1393 | <div class="memitem"> |
| universe@390 | 1394 | <div class="memproto"> |
| universe@390 | 1395 | <table class="memname"> |
| universe@390 | 1396 | <tr> |
| universe@390 | 1397 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_new </td> |
| universe@390 | 1398 | <td>(</td> |
| universe@390 | 1399 | <td class="paramtype">size_t </td> |
| universe@390 | 1400 | <td class="paramname"><em>size</em></td><td>)</td> |
| universe@390 | 1401 | <td></td> |
| universe@390 | 1402 | </tr> |
| universe@390 | 1403 | </table> |
| universe@390 | 1404 | </div><div class="memdoc"> |
| universe@390 | 1405 | |
| universe@390 | 1406 | <p>Creates a new hash map with the specified size. </p> |
| universe@390 | 1407 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1408 | <table class="params"> |
| universe@390 | 1409 | <tr><td class="paramname">size</td><td>the size of the hash map </td></tr> |
| universe@390 | 1410 | </table> |
| universe@390 | 1411 | </dd> |
| universe@390 | 1412 | </dl> |
| universe@390 | 1413 | <dl class="section return"><dt>Returns</dt><dd>a pointer to the new hash map </dd></dl> |
| universe@390 | 1414 | |
| universe@390 | 1415 | </div> |
| universe@390 | 1416 | </div> |
| universe@390 | 1417 | <a id="aed508a94c66cc15372503c64b70eb03e"></a> |
| universe@390 | 1418 | <h2 class="memtitle"><span class="permalink"><a href="#aed508a94c66cc15372503c64b70eb03e">◆ </a></span>ucx_map_new_a()</h2> |
| universe@390 | 1419 | |
| universe@390 | 1420 | <div class="memitem"> |
| universe@390 | 1421 | <div class="memproto"> |
| universe@390 | 1422 | <table class="memname"> |
| universe@390 | 1423 | <tr> |
| universe@390 | 1424 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_new_a </td> |
| universe@390 | 1425 | <td>(</td> |
| universe@390 | 1426 | <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td> |
| universe@390 | 1427 | <td class="paramname"><em>allocator</em>, </td> |
| universe@390 | 1428 | </tr> |
| universe@390 | 1429 | <tr> |
| universe@390 | 1430 | <td class="paramkey"></td> |
| universe@390 | 1431 | <td></td> |
| universe@390 | 1432 | <td class="paramtype">size_t </td> |
| universe@390 | 1433 | <td class="paramname"><em>size</em> </td> |
| universe@390 | 1434 | </tr> |
| universe@390 | 1435 | <tr> |
| universe@390 | 1436 | <td></td> |
| universe@390 | 1437 | <td>)</td> |
| universe@390 | 1438 | <td></td><td></td> |
| universe@390 | 1439 | </tr> |
| universe@390 | 1440 | </table> |
| universe@390 | 1441 | </div><div class="memdoc"> |
| universe@390 | 1442 | |
| universe@390 | 1443 | <p>Creates a new hash map with the specified size using a <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a>. </p> |
| universe@390 | 1444 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1445 | <table class="params"> |
| universe@390 | 1446 | <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr> |
| universe@390 | 1447 | <tr><td class="paramname">size</td><td>the size of the hash map </td></tr> |
| universe@390 | 1448 | </table> |
| universe@390 | 1449 | </dd> |
| universe@390 | 1450 | </dl> |
| universe@390 | 1451 | <dl class="section return"><dt>Returns</dt><dd>a pointer to the new hash map </dd></dl> |
| universe@390 | 1452 | |
| universe@390 | 1453 | </div> |
| universe@390 | 1454 | </div> |
| universe@390 | 1455 | <a id="ac04a08b604217070254d4c58f0e82498"></a> |
| universe@390 | 1456 | <h2 class="memtitle"><span class="permalink"><a href="#ac04a08b604217070254d4c58f0e82498">◆ </a></span>ucx_map_put()</h2> |
| universe@390 | 1457 | |
| universe@390 | 1458 | <div class="memitem"> |
| universe@390 | 1459 | <div class="memproto"> |
| universe@390 | 1460 | <table class="memname"> |
| universe@390 | 1461 | <tr> |
| universe@390 | 1462 | <td class="memname">int ucx_map_put </td> |
| universe@390 | 1463 | <td>(</td> |
| universe@390 | 1464 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1465 | <td class="paramname"><em>map</em>, </td> |
| universe@390 | 1466 | </tr> |
| universe@390 | 1467 | <tr> |
| universe@390 | 1468 | <td class="paramkey"></td> |
| universe@390 | 1469 | <td></td> |
| universe@390 | 1470 | <td class="paramtype"><a class="el" href="structUcxKey.html">UcxKey</a> </td> |
| universe@390 | 1471 | <td class="paramname"><em>key</em>, </td> |
| universe@390 | 1472 | </tr> |
| universe@390 | 1473 | <tr> |
| universe@390 | 1474 | <td class="paramkey"></td> |
| universe@390 | 1475 | <td></td> |
| universe@390 | 1476 | <td class="paramtype">void * </td> |
| universe@390 | 1477 | <td class="paramname"><em>value</em> </td> |
| universe@390 | 1478 | </tr> |
| universe@390 | 1479 | <tr> |
| universe@390 | 1480 | <td></td> |
| universe@390 | 1481 | <td>)</td> |
| universe@390 | 1482 | <td></td><td></td> |
| universe@390 | 1483 | </tr> |
| universe@390 | 1484 | </table> |
| universe@390 | 1485 | </div><div class="memdoc"> |
| universe@390 | 1486 | |
| universe@390 | 1487 | <p>Puts a key/value-pair into the map. </p> |
| universe@390 | 1488 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1489 | <table class="params"> |
| universe@390 | 1490 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 1491 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 1492 | <tr><td class="paramname">value</td><td>the value </td></tr> |
| universe@390 | 1493 | </table> |
| universe@390 | 1494 | </dd> |
| universe@390 | 1495 | </dl> |
| universe@390 | 1496 | <dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero value on failure </dd></dl> |
| universe@390 | 1497 | |
| universe@390 | 1498 | </div> |
| universe@390 | 1499 | </div> |
| universe@390 | 1500 | <a id="a174bce9fad554dd92b8da354e0d32512"></a> |
| universe@390 | 1501 | <h2 class="memtitle"><span class="permalink"><a href="#a174bce9fad554dd92b8da354e0d32512">◆ </a></span>ucx_map_rehash()</h2> |
| universe@390 | 1502 | |
| universe@390 | 1503 | <div class="memitem"> |
| universe@390 | 1504 | <div class="memproto"> |
| universe@390 | 1505 | <table class="memname"> |
| universe@390 | 1506 | <tr> |
| universe@390 | 1507 | <td class="memname">int ucx_map_rehash </td> |
| universe@390 | 1508 | <td>(</td> |
| universe@390 | 1509 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1510 | <td class="paramname"><em>map</em></td><td>)</td> |
| universe@390 | 1511 | <td></td> |
| universe@390 | 1512 | </tr> |
| universe@390 | 1513 | </table> |
| universe@390 | 1514 | </div><div class="memdoc"> |
| universe@390 | 1515 | |
| universe@390 | 1516 | <p>Increases size of the hash map, if necessary. </p> |
| universe@390 | 1517 | <p>The load value is 0.75*UcxMap.size. If the element count exceeds the load value, the map needs to be rehashed. Otherwise no action is performed and this function simply returns 0.</p> |
| universe@390 | 1518 | <p>The rehashing process ensures, that the <a class="el" href="structUcxMap.html#afe120846b26d99580a7ff1276464e838" title="The size of the map is the length of the element list array. ">UcxMap.size</a> is at least 2.5*UcxMap.count. So there is enough room for additional elements without the need of another soon rehashing.</p> |
| universe@390 | 1519 | <p>You can use this function to dramatically increase access performance.</p> |
| universe@390 | 1520 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1521 | <table class="params"> |
| universe@390 | 1522 | <tr><td class="paramname">map</td><td>the map to rehash </td></tr> |
| universe@390 | 1523 | </table> |
| universe@390 | 1524 | </dd> |
| universe@390 | 1525 | </dl> |
| universe@390 | 1526 | <dl class="section return"><dt>Returns</dt><dd>1, if a memory allocation error occurred, 0 otherwise </dd></dl> |
| universe@390 | 1527 | |
| universe@390 | 1528 | </div> |
| universe@390 | 1529 | </div> |
| universe@390 | 1530 | <a id="a17248a4888eb8f9ae18be522d64632aa"></a> |
| universe@390 | 1531 | <h2 class="memtitle"><span class="permalink"><a href="#a17248a4888eb8f9ae18be522d64632aa">◆ </a></span>ucx_map_remove()</h2> |
| universe@390 | 1532 | |
| universe@390 | 1533 | <div class="memitem"> |
| universe@390 | 1534 | <div class="memproto"> |
| universe@390 | 1535 | <table class="memname"> |
| universe@390 | 1536 | <tr> |
| universe@390 | 1537 | <td class="memname">void* ucx_map_remove </td> |
| universe@390 | 1538 | <td>(</td> |
| universe@390 | 1539 | <td class="paramtype"><a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1540 | <td class="paramname"><em>map</em>, </td> |
| universe@390 | 1541 | </tr> |
| universe@390 | 1542 | <tr> |
| universe@390 | 1543 | <td class="paramkey"></td> |
| universe@390 | 1544 | <td></td> |
| universe@390 | 1545 | <td class="paramtype"><a class="el" href="structUcxKey.html">UcxKey</a> </td> |
| universe@390 | 1546 | <td class="paramname"><em>key</em> </td> |
| universe@390 | 1547 | </tr> |
| universe@390 | 1548 | <tr> |
| universe@390 | 1549 | <td></td> |
| universe@390 | 1550 | <td>)</td> |
| universe@390 | 1551 | <td></td><td></td> |
| universe@390 | 1552 | </tr> |
| universe@390 | 1553 | </table> |
| universe@390 | 1554 | </div><div class="memdoc"> |
| universe@390 | 1555 | |
| universe@390 | 1556 | <p>Removes a key/value-pair from the map by using the key. </p> |
| universe@390 | 1557 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1558 | <table class="params"> |
| universe@390 | 1559 | <tr><td class="paramname">map</td><td>the map </td></tr> |
| universe@390 | 1560 | <tr><td class="paramname">key</td><td>the key </td></tr> |
| universe@390 | 1561 | </table> |
| universe@390 | 1562 | </dd> |
| universe@390 | 1563 | </dl> |
| universe@390 | 1564 | <dl class="section return"><dt>Returns</dt><dd>the removed value </dd></dl> |
| universe@390 | 1565 | |
| universe@390 | 1566 | </div> |
| universe@390 | 1567 | </div> |
| universe@390 | 1568 | <a id="a3f65978c481af7f637cad021d93522d5"></a> |
| universe@390 | 1569 | <h2 class="memtitle"><span class="permalink"><a href="#a3f65978c481af7f637cad021d93522d5">◆ </a></span>ucx_map_union()</h2> |
| universe@390 | 1570 | |
| universe@390 | 1571 | <div class="memitem"> |
| universe@390 | 1572 | <div class="memproto"> |
| universe@390 | 1573 | <table class="memname"> |
| universe@390 | 1574 | <tr> |
| universe@390 | 1575 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_union </td> |
| universe@390 | 1576 | <td>(</td> |
| universe@390 | 1577 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1578 | <td class="paramname"><em>first</em>, </td> |
| universe@390 | 1579 | </tr> |
| universe@390 | 1580 | <tr> |
| universe@390 | 1581 | <td class="paramkey"></td> |
| universe@390 | 1582 | <td></td> |
| universe@390 | 1583 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1584 | <td class="paramname"><em>second</em>, </td> |
| universe@390 | 1585 | </tr> |
| universe@390 | 1586 | <tr> |
| universe@390 | 1587 | <td class="paramkey"></td> |
| universe@390 | 1588 | <td></td> |
| universe@390 | 1589 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 1590 | <td class="paramname"><em>cpfnc</em>, </td> |
| universe@390 | 1591 | </tr> |
| universe@390 | 1592 | <tr> |
| universe@390 | 1593 | <td class="paramkey"></td> |
| universe@390 | 1594 | <td></td> |
| universe@390 | 1595 | <td class="paramtype">void * </td> |
| universe@390 | 1596 | <td class="paramname"><em>cpdata</em> </td> |
| universe@390 | 1597 | </tr> |
| universe@390 | 1598 | <tr> |
| universe@390 | 1599 | <td></td> |
| universe@390 | 1600 | <td>)</td> |
| universe@390 | 1601 | <td></td><td></td> |
| universe@390 | 1602 | </tr> |
| universe@390 | 1603 | </table> |
| universe@390 | 1604 | </div><div class="memdoc"> |
| universe@390 | 1605 | |
| universe@390 | 1606 | <p>Returns the union of two maps. </p> |
| universe@390 | 1607 | <p>The union is a fresh map which is filled by two successive calls of <a class="el" href="map_8h.html#adfeb2d61003fd2896bcfdc9a57f36425" title="Copies contents from a map to another map using a copy function. ">ucx_map_copy()</a> on the two input maps.</p> |
| universe@390 | 1608 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1609 | <table class="params"> |
| universe@390 | 1610 | <tr><td class="paramname">first</td><td>the first source map </td></tr> |
| universe@390 | 1611 | <tr><td class="paramname">second</td><td>the second source map </td></tr> |
| universe@390 | 1612 | <tr><td class="paramname">cpfnc</td><td>a function to copy the elements </td></tr> |
| universe@390 | 1613 | <tr><td class="paramname">cpdata</td><td>additional data for the copy function </td></tr> |
| universe@390 | 1614 | </table> |
| universe@390 | 1615 | </dd> |
| universe@390 | 1616 | </dl> |
| universe@390 | 1617 | <dl class="section return"><dt>Returns</dt><dd>a new map containing the union </dd></dl> |
| universe@390 | 1618 | |
| universe@390 | 1619 | </div> |
| universe@390 | 1620 | </div> |
| universe@390 | 1621 | <a id="ab6370c3fa8113fdad593ce4b0460c9c6"></a> |
| universe@390 | 1622 | <h2 class="memtitle"><span class="permalink"><a href="#ab6370c3fa8113fdad593ce4b0460c9c6">◆ </a></span>ucx_map_union_a()</h2> |
| universe@390 | 1623 | |
| universe@390 | 1624 | <div class="memitem"> |
| universe@390 | 1625 | <div class="memproto"> |
| universe@390 | 1626 | <table class="memname"> |
| universe@390 | 1627 | <tr> |
| universe@390 | 1628 | <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* ucx_map_union_a </td> |
| universe@390 | 1629 | <td>(</td> |
| universe@390 | 1630 | <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td> |
| universe@390 | 1631 | <td class="paramname"><em>allocator</em>, </td> |
| universe@390 | 1632 | </tr> |
| universe@390 | 1633 | <tr> |
| universe@390 | 1634 | <td class="paramkey"></td> |
| universe@390 | 1635 | <td></td> |
| universe@390 | 1636 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1637 | <td class="paramname"><em>first</em>, </td> |
| universe@390 | 1638 | </tr> |
| universe@390 | 1639 | <tr> |
| universe@390 | 1640 | <td class="paramkey"></td> |
| universe@390 | 1641 | <td></td> |
| universe@390 | 1642 | <td class="paramtype">const <a class="el" href="structUcxMap.html">UcxMap</a> * </td> |
| universe@390 | 1643 | <td class="paramname"><em>second</em>, </td> |
| universe@390 | 1644 | </tr> |
| universe@390 | 1645 | <tr> |
| universe@390 | 1646 | <td class="paramkey"></td> |
| universe@390 | 1647 | <td></td> |
| universe@390 | 1648 | <td class="paramtype"><a class="el" href="ucx_8h.html#aab917a5fe0965673c73e8ebd0a1fc967">copy_func</a> </td> |
| universe@390 | 1649 | <td class="paramname"><em>cpfnc</em>, </td> |
| universe@390 | 1650 | </tr> |
| universe@390 | 1651 | <tr> |
| universe@390 | 1652 | <td class="paramkey"></td> |
| universe@390 | 1653 | <td></td> |
| universe@390 | 1654 | <td class="paramtype">void * </td> |
| universe@390 | 1655 | <td class="paramname"><em>cpdata</em> </td> |
| universe@390 | 1656 | </tr> |
| universe@390 | 1657 | <tr> |
| universe@390 | 1658 | <td></td> |
| universe@390 | 1659 | <td>)</td> |
| universe@390 | 1660 | <td></td><td></td> |
| universe@390 | 1661 | </tr> |
| universe@390 | 1662 | </table> |
| universe@390 | 1663 | </div><div class="memdoc"> |
| universe@390 | 1664 | |
| universe@390 | 1665 | <p>Returns the union of two maps. </p> |
| universe@390 | 1666 | <p>The union is a fresh map which is filled by two successive calls of <a class="el" href="map_8h.html#adfeb2d61003fd2896bcfdc9a57f36425" title="Copies contents from a map to another map using a copy function. ">ucx_map_copy()</a> on the two input maps.</p> |
| universe@390 | 1667 | <dl class="params"><dt>Parameters</dt><dd> |
| universe@390 | 1668 | <table class="params"> |
| universe@390 | 1669 | <tr><td class="paramname">allocator</td><td>the allocator that shall be used by the new map </td></tr> |
| universe@390 | 1670 | <tr><td class="paramname">first</td><td>the first source map </td></tr> |
| universe@390 | 1671 | <tr><td class="paramname">second</td><td>the second source map </td></tr> |
| universe@390 | 1672 | <tr><td class="paramname">cpfnc</td><td>a function to copy the elements </td></tr> |
| universe@390 | 1673 | <tr><td class="paramname">cpdata</td><td>additional data for the copy function </td></tr> |
| universe@390 | 1674 | </table> |
| universe@390 | 1675 | </dd> |
| universe@390 | 1676 | </dl> |
| universe@390 | 1677 | <dl class="section return"><dt>Returns</dt><dd>a new map containing the union </dd></dl> |
| universe@390 | 1678 | |
| universe@390 | 1679 | </div> |
| universe@390 | 1680 | </div> |
| universe@390 | 1681 | </div><!-- contents --> |
| universe@390 | 1682 | <!-- start footer part --> |
| universe@390 | 1683 | <hr class="footer"/><address class="footer"><small> |
| universe@390 | 1684 | Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html"> |
| universe@390 | 1685 | <img class="footer" src="doxygen.png" alt="doxygen"/> |
| universe@390 | 1686 | </a> 1.8.13 |
| universe@390 | 1687 | </small></address> |
| universe@390 | 1688 | </body> |
| universe@390 | 1689 | </html> |
