1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/api-2.1/array_8h.html Sat Feb 06 19:11:44 2021 +0100
1.3 @@ -0,0 +1,1376 @@
1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
1.6 +<head>
1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
1.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/array.h File Reference</title>
1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
1.13 +<script type="text/javascript" src="jquery.js"></script>
1.14 +<script type="text/javascript" src="dynsections.js"></script>
1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
1.17 +<script type="text/javascript" src="search/search.js"></script>
1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
1.19 +</head>
1.20 +<body>
1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
1.22 +<div id="titlearea">
1.23 +<table cellspacing="0" cellpadding="0">
1.24 + <tbody>
1.25 + <tr style="height: 56px;">
1.26 + <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
1.27 + <td id="projectalign" style="padding-left: 0.5em;">
1.28 + <div id="projectname">ucx
1.29 + </div>
1.30 + <div id="projectbrief">UAP Common Extensions</div>
1.31 + </td>
1.32 + </tr>
1.33 + </tbody>
1.34 +</table>
1.35 +</div>
1.36 +<!-- end header part -->
1.37 +<!-- Generated by Doxygen 1.8.13 -->
1.38 +<script type="text/javascript">
1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
1.40 +</script>
1.41 +<script type="text/javascript" src="menudata.js"></script>
1.42 +<script type="text/javascript" src="menu.js"></script>
1.43 +<script type="text/javascript">
1.44 +$(function() {
1.45 + initMenu('',true,false,'search.php','Search');
1.46 + $(document).ready(function() { init_search(); });
1.47 +});
1.48 +</script>
1.49 +<div id="main-nav"></div>
1.50 +<!-- window showing the filter options -->
1.51 +<div id="MSearchSelectWindow"
1.52 + onmouseover="return searchBox.OnSearchSelectShow()"
1.53 + onmouseout="return searchBox.OnSearchSelectHide()"
1.54 + onkeydown="return searchBox.OnSearchSelectKey(event)">
1.55 +</div>
1.56 +
1.57 +<!-- iframe showing the search results (closed by default) -->
1.58 +<div id="MSearchResultsWindow">
1.59 +<iframe src="javascript:void(0)" frameborder="0"
1.60 + name="MSearchResults" id="MSearchResults">
1.61 +</iframe>
1.62 +</div>
1.63 +
1.64 +<div id="nav-path" class="navpath">
1.65 + <ul>
1.66 +<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>
1.67 +</div>
1.68 +</div><!-- top -->
1.69 +<div class="header">
1.70 + <div class="summary">
1.71 +<a href="#nested-classes">Data Structures</a> |
1.72 +<a href="#define-members">Macros</a> |
1.73 +<a href="#func-members">Functions</a> </div>
1.74 + <div class="headertitle">
1.75 +<div class="title">array.h File Reference</div> </div>
1.76 +</div><!--header-->
1.77 +<div class="contents">
1.78 +
1.79 +<p>Dynamically allocated array implementation.
1.80 +<a href="#details">More...</a></p>
1.81 +<div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br />
1.82 +<code>#include "<a class="el" href="allocator_8h_source.html">allocator.h</a>"</code><br />
1.83 +</div>
1.84 +<p><a href="array_8h_source.html">Go to the source code of this file.</a></p>
1.85 +<table class="memberdecls">
1.86 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
1.87 +Data Structures</h2></td></tr>
1.88 +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxArray.html">UcxArray</a></td></tr>
1.89 +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UCX array type. <a href="structUcxArray.html#details">More...</a><br /></td></tr>
1.90 +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
1.91 +</table><table class="memberdecls">
1.92 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
1.93 +Macros</h2></td></tr>
1.94 +<tr class="memitem:a1d959c29af3125bdd37cde3a554e729c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a1d959c29af3125bdd37cde3a554e729c">ucx_array_util_set</a>(array, capacity, elmsize, idx, data)</td></tr>
1.95 +<tr class="memdesc:a1d959c29af3125bdd37cde3a554e729c"><td class="mdescLeft"> </td><td class="mdescRight">Sets an element in an arbitrary user defined array. <a href="#a1d959c29af3125bdd37cde3a554e729c">More...</a><br /></td></tr>
1.96 +<tr class="separator:a1d959c29af3125bdd37cde3a554e729c"><td class="memSeparator" colspan="2"> </td></tr>
1.97 +<tr class="memitem:a59a5b342965e790945f9c7a3f86b99f9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a59a5b342965e790945f9c7a3f86b99f9">ucx_array_util_setptr</a>(array, capacity, idx, ptr)</td></tr>
1.98 +<tr class="memdesc:a59a5b342965e790945f9c7a3f86b99f9"><td class="mdescLeft"> </td><td class="mdescRight">Stores a pointer in an arbitrary user defined array. <a href="#a59a5b342965e790945f9c7a3f86b99f9">More...</a><br /></td></tr>
1.99 +<tr class="separator:a59a5b342965e790945f9c7a3f86b99f9"><td class="memSeparator" colspan="2"> </td></tr>
1.100 +</table><table class="memberdecls">
1.101 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
1.102 +Functions</h2></td></tr>
1.103 +<tr class="memitem:ad0a8d76980cf1c1910e64a245803fb9a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#ad0a8d76980cf1c1910e64a245803fb9a">ucx_array_util_set_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *alloc, void **array, size_t *capacity, size_t elmsize, size_t idx, void *data)</td></tr>
1.104 +<tr class="memdesc:ad0a8d76980cf1c1910e64a245803fb9a"><td class="mdescLeft"> </td><td class="mdescRight">Sets an element in an arbitrary user defined array. <a href="#ad0a8d76980cf1c1910e64a245803fb9a">More...</a><br /></td></tr>
1.105 +<tr class="separator:ad0a8d76980cf1c1910e64a245803fb9a"><td class="memSeparator" colspan="2"> </td></tr>
1.106 +<tr class="memitem:ad708b333c0c1b02c998309a58ea65e31"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#ad708b333c0c1b02c998309a58ea65e31">ucx_array_util_setptr_a</a> (<a class="el" href="structUcxAllocator.html">UcxAllocator</a> *alloc, void **array, size_t *capacity, size_t idx, void *ptr)</td></tr>
1.107 +<tr class="memdesc:ad708b333c0c1b02c998309a58ea65e31"><td class="mdescLeft"> </td><td class="mdescRight">Stores a pointer in an arbitrary user defined array. <a href="#ad708b333c0c1b02c998309a58ea65e31">More...</a><br /></td></tr>
1.108 +<tr class="separator:ad708b333c0c1b02c998309a58ea65e31"><td class="memSeparator" colspan="2"> </td></tr>
1.109 +<tr class="memitem:a994a2fbf1c33a3833e2a70cd9a4352b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxArray.html">UcxArray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a994a2fbf1c33a3833e2a70cd9a4352b7">ucx_array_new</a> (size_t capacity, size_t elemsize)</td></tr>
1.110 +<tr class="memdesc:a994a2fbf1c33a3833e2a70cd9a4352b7"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new UCX array with the given capacity and element size. <a href="#a994a2fbf1c33a3833e2a70cd9a4352b7">More...</a><br /></td></tr>
1.111 +<tr class="separator:a994a2fbf1c33a3833e2a70cd9a4352b7"><td class="memSeparator" colspan="2"> </td></tr>
1.112 +<tr class="memitem:a177170258c215eb2e4f5a32e59f0cb1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxArray.html">UcxArray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a177170258c215eb2e4f5a32e59f0cb1b">ucx_array_new_a</a> (size_t capacity, size_t elemsize, <a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator)</td></tr>
1.113 +<tr class="memdesc:a177170258c215eb2e4f5a32e59f0cb1b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new UCX array using the specified allocator. <a href="#a177170258c215eb2e4f5a32e59f0cb1b">More...</a><br /></td></tr>
1.114 +<tr class="separator:a177170258c215eb2e4f5a32e59f0cb1b"><td class="memSeparator" colspan="2"> </td></tr>
1.115 +<tr class="memitem:ad921e85c28ffae32230777a53c5037e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#ad921e85c28ffae32230777a53c5037e5">ucx_array_init</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t capacity, size_t elemsize)</td></tr>
1.116 +<tr class="memdesc:ad921e85c28ffae32230777a53c5037e5"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a UCX array structure with the given capacity and element size. <a href="#ad921e85c28ffae32230777a53c5037e5">More...</a><br /></td></tr>
1.117 +<tr class="separator:ad921e85c28ffae32230777a53c5037e5"><td class="memSeparator" colspan="2"> </td></tr>
1.118 +<tr class="memitem:a2451e61ebb15a7ba1c1319267ba75b8c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a2451e61ebb15a7ba1c1319267ba75b8c">ucx_array_init_a</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t capacity, size_t elemsize, <a class="el" href="structUcxAllocator.html">UcxAllocator</a> *allocator)</td></tr>
1.119 +<tr class="memdesc:a2451e61ebb15a7ba1c1319267ba75b8c"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a UCX array structure using the specified allocator. <a href="#a2451e61ebb15a7ba1c1319267ba75b8c">More...</a><br /></td></tr>
1.120 +<tr class="separator:a2451e61ebb15a7ba1c1319267ba75b8c"><td class="memSeparator" colspan="2"> </td></tr>
1.121 +<tr class="memitem:a4a8c273370e4a3a3e2624e364f5ab410"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a4a8c273370e4a3a3e2624e364f5ab410">ucx_array_clone</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *dest, <a class="el" href="structUcxArray.html">UcxArray</a> const *src)</td></tr>
1.122 +<tr class="memdesc:a4a8c273370e4a3a3e2624e364f5ab410"><td class="mdescLeft"> </td><td class="mdescRight">Creates an shallow copy of an array. <a href="#a4a8c273370e4a3a3e2624e364f5ab410">More...</a><br /></td></tr>
1.123 +<tr class="separator:a4a8c273370e4a3a3e2624e364f5ab410"><td class="memSeparator" colspan="2"> </td></tr>
1.124 +<tr class="memitem:a43292b448adb1741677aa8c578bcc201"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a43292b448adb1741677aa8c578bcc201">ucx_array_equals</a> (<a class="el" href="structUcxArray.html">UcxArray</a> const *array1, <a class="el" href="structUcxArray.html">UcxArray</a> const *array2, <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> cmpfnc, void *data)</td></tr>
1.125 +<tr class="memdesc:a43292b448adb1741677aa8c578bcc201"><td class="mdescLeft"> </td><td class="mdescRight">Compares two UCX arrays element-wise by using a compare function. <a href="#a43292b448adb1741677aa8c578bcc201">More...</a><br /></td></tr>
1.126 +<tr class="separator:a43292b448adb1741677aa8c578bcc201"><td class="memSeparator" colspan="2"> </td></tr>
1.127 +<tr class="memitem:a8e83681d8d5d8cddbf10f63ce5be4c10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a8e83681d8d5d8cddbf10f63ce5be4c10">ucx_array_destroy</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array)</td></tr>
1.128 +<tr class="memdesc:a8e83681d8d5d8cddbf10f63ce5be4c10"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the array. <a href="#a8e83681d8d5d8cddbf10f63ce5be4c10">More...</a><br /></td></tr>
1.129 +<tr class="separator:a8e83681d8d5d8cddbf10f63ce5be4c10"><td class="memSeparator" colspan="2"> </td></tr>
1.130 +<tr class="memitem:ac01ee914468a16f470bf3071fffbe438"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#ac01ee914468a16f470bf3071fffbe438">ucx_array_free</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array)</td></tr>
1.131 +<tr class="memdesc:ac01ee914468a16f470bf3071fffbe438"><td class="mdescLeft"> </td><td class="mdescRight">Destroys and frees the array. <a href="#ac01ee914468a16f470bf3071fffbe438">More...</a><br /></td></tr>
1.132 +<tr class="separator:ac01ee914468a16f470bf3071fffbe438"><td class="memSeparator" colspan="2"> </td></tr>
1.133 +<tr class="memitem:aea01731ad94ea73c0c8fb1d1b7a35fcf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#aea01731ad94ea73c0c8fb1d1b7a35fcf">ucx_array_append_from</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, void *data, size_t count)</td></tr>
1.134 +<tr class="memdesc:aea01731ad94ea73c0c8fb1d1b7a35fcf"><td class="mdescLeft"> </td><td class="mdescRight">Inserts elements at the end of the array. <a href="#aea01731ad94ea73c0c8fb1d1b7a35fcf">More...</a><br /></td></tr>
1.135 +<tr class="separator:aea01731ad94ea73c0c8fb1d1b7a35fcf"><td class="memSeparator" colspan="2"> </td></tr>
1.136 +<tr class="memitem:a95b52acc2193b5c33cf0eaa4f2082477"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a95b52acc2193b5c33cf0eaa4f2082477">ucx_array_prepend_from</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, void *data, size_t count)</td></tr>
1.137 +<tr class="memdesc:a95b52acc2193b5c33cf0eaa4f2082477"><td class="mdescLeft"> </td><td class="mdescRight">Inserts elements at the beginning of the array. <a href="#a95b52acc2193b5c33cf0eaa4f2082477">More...</a><br /></td></tr>
1.138 +<tr class="separator:a95b52acc2193b5c33cf0eaa4f2082477"><td class="memSeparator" colspan="2"> </td></tr>
1.139 +<tr class="memitem:a1bb545d065358d265d80d815ba382a28"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a1bb545d065358d265d80d815ba382a28">ucx_array_set_from</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t index, void *data, size_t count)</td></tr>
1.140 +<tr class="memdesc:a1bb545d065358d265d80d815ba382a28"><td class="mdescLeft"> </td><td class="mdescRight">Sets elements starting at the specified index. <a href="#a1bb545d065358d265d80d815ba382a28">More...</a><br /></td></tr>
1.141 +<tr class="separator:a1bb545d065358d265d80d815ba382a28"><td class="memSeparator" colspan="2"> </td></tr>
1.142 +<tr class="memitem:aa5a0bf3d3f0df6406beb0e569021cc28"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#aa5a0bf3d3f0df6406beb0e569021cc28">ucx_array_concat</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array1, const <a class="el" href="structUcxArray.html">UcxArray</a> *array2)</td></tr>
1.143 +<tr class="memdesc:aa5a0bf3d3f0df6406beb0e569021cc28"><td class="mdescLeft"> </td><td class="mdescRight">Concatenates two arrays. <a href="#aa5a0bf3d3f0df6406beb0e569021cc28">More...</a><br /></td></tr>
1.144 +<tr class="separator:aa5a0bf3d3f0df6406beb0e569021cc28"><td class="memSeparator" colspan="2"> </td></tr>
1.145 +<tr class="memitem:aa698085fd1a8b70d6b709999c51b49e8"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#aa698085fd1a8b70d6b709999c51b49e8">ucx_array_at</a> (<a class="el" href="structUcxArray.html">UcxArray</a> const *array, size_t index)</td></tr>
1.146 +<tr class="memdesc:aa698085fd1a8b70d6b709999c51b49e8"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the array element at the specified index. <a href="#aa698085fd1a8b70d6b709999c51b49e8">More...</a><br /></td></tr>
1.147 +<tr class="separator:aa698085fd1a8b70d6b709999c51b49e8"><td class="memSeparator" colspan="2"> </td></tr>
1.148 +<tr class="memitem:ae7bdbed94afee9b20b38b95e3ab470f0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#ae7bdbed94afee9b20b38b95e3ab470f0">ucx_array_find</a> (<a class="el" href="structUcxArray.html">UcxArray</a> const *array, void *elem, <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> cmpfnc, void *data)</td></tr>
1.149 +<tr class="memdesc:ae7bdbed94afee9b20b38b95e3ab470f0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of an element containing the specified data. <a href="#ae7bdbed94afee9b20b38b95e3ab470f0">More...</a><br /></td></tr>
1.150 +<tr class="separator:ae7bdbed94afee9b20b38b95e3ab470f0"><td class="memSeparator" colspan="2"> </td></tr>
1.151 +<tr class="memitem:a5241058cd2329147bc5b1593ae7e51dc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a5241058cd2329147bc5b1593ae7e51dc">ucx_array_contains</a> (<a class="el" href="structUcxArray.html">UcxArray</a> const *array, void *elem, <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> cmpfnc, void *data)</td></tr>
1.152 +<tr class="memdesc:a5241058cd2329147bc5b1593ae7e51dc"><td class="mdescLeft"> </td><td class="mdescRight">Checks, if an array contains a specific element. <a href="#a5241058cd2329147bc5b1593ae7e51dc">More...</a><br /></td></tr>
1.153 +<tr class="separator:a5241058cd2329147bc5b1593ae7e51dc"><td class="memSeparator" colspan="2"> </td></tr>
1.154 +<tr class="memitem:add773514569b872a6624381b4b6af52c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#add773514569b872a6624381b4b6af52c">ucx_array_sort</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> cmpfnc, void *data)</td></tr>
1.155 +<tr class="memdesc:add773514569b872a6624381b4b6af52c"><td class="mdescLeft"> </td><td class="mdescRight">Sorts a <a class="el" href="structUcxArray.html" title="UCX array type. ">UcxArray</a> with the best available sort algorithm. <a href="#add773514569b872a6624381b4b6af52c">More...</a><br /></td></tr>
1.156 +<tr class="separator:add773514569b872a6624381b4b6af52c"><td class="memSeparator" colspan="2"> </td></tr>
1.157 +<tr class="memitem:aa45eac6b697f83adac81c0860cf306b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#aa45eac6b697f83adac81c0860cf306b8">ucx_array_remove</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t index)</td></tr>
1.158 +<tr class="memdesc:aa45eac6b697f83adac81c0860cf306b8"><td class="mdescLeft"> </td><td class="mdescRight">Removes an element from the array. <a href="#aa45eac6b697f83adac81c0860cf306b8">More...</a><br /></td></tr>
1.159 +<tr class="separator:aa45eac6b697f83adac81c0860cf306b8"><td class="memSeparator" colspan="2"> </td></tr>
1.160 +<tr class="memitem:a548d81b07612bae3ba8c4c4b49104b8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a548d81b07612bae3ba8c4c4b49104b8e">ucx_array_remove_fast</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t index)</td></tr>
1.161 +<tr class="memdesc:a548d81b07612bae3ba8c4c4b49104b8e"><td class="mdescLeft"> </td><td class="mdescRight">Removes an element from the array. <a href="#a548d81b07612bae3ba8c4c4b49104b8e">More...</a><br /></td></tr>
1.162 +<tr class="separator:a548d81b07612bae3ba8c4c4b49104b8e"><td class="memSeparator" colspan="2"> </td></tr>
1.163 +<tr class="memitem:a2daf50e80aee9bccebee876a7efd2dfc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a2daf50e80aee9bccebee876a7efd2dfc">ucx_array_shrink</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array)</td></tr>
1.164 +<tr class="memdesc:a2daf50e80aee9bccebee876a7efd2dfc"><td class="mdescLeft"> </td><td class="mdescRight">Shrinks the memory to exactly fit the contents. <a href="#a2daf50e80aee9bccebee876a7efd2dfc">More...</a><br /></td></tr>
1.165 +<tr class="separator:a2daf50e80aee9bccebee876a7efd2dfc"><td class="memSeparator" colspan="2"> </td></tr>
1.166 +<tr class="memitem:a27762e7c06a6c781015e3c8ceeee0ce3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a27762e7c06a6c781015e3c8ceeee0ce3">ucx_array_resize</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t capacity)</td></tr>
1.167 +<tr class="memdesc:a27762e7c06a6c781015e3c8ceeee0ce3"><td class="mdescLeft"> </td><td class="mdescRight">Sets the capacity of the array. <a href="#a27762e7c06a6c781015e3c8ceeee0ce3">More...</a><br /></td></tr>
1.168 +<tr class="separator:a27762e7c06a6c781015e3c8ceeee0ce3"><td class="memSeparator" colspan="2"> </td></tr>
1.169 +<tr class="memitem:a1c3bf8433c1de3c933f3854ab297fe1d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#a1c3bf8433c1de3c933f3854ab297fe1d">ucx_array_reserve</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t capacity)</td></tr>
1.170 +<tr class="memdesc:a1c3bf8433c1de3c933f3854ab297fe1d"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the array only, if the capacity is insufficient. <a href="#a1c3bf8433c1de3c933f3854ab297fe1d">More...</a><br /></td></tr>
1.171 +<tr class="separator:a1c3bf8433c1de3c933f3854ab297fe1d"><td class="memSeparator" colspan="2"> </td></tr>
1.172 +<tr class="memitem:ab0cbf243824aaebee48277315e03afce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="array_8h.html#ab0cbf243824aaebee48277315e03afce">ucx_array_grow</a> (<a class="el" href="structUcxArray.html">UcxArray</a> *array, size_t count)</td></tr>
1.173 +<tr class="memdesc:ab0cbf243824aaebee48277315e03afce"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the capacity, if the specified number of elements would not fit. <a href="#ab0cbf243824aaebee48277315e03afce">More...</a><br /></td></tr>
1.174 +<tr class="separator:ab0cbf243824aaebee48277315e03afce"><td class="memSeparator" colspan="2"> </td></tr>
1.175 +</table>
1.176 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1.177 +<div class="textblock"><p>Dynamically allocated array implementation. </p>
1.178 +<dl class="section author"><dt>Author</dt><dd>Mike Becker </dd>
1.179 +<dd>
1.180 +Olaf Wintermann </dd></dl>
1.181 +</div><h2 class="groupheader">Macro Definition Documentation</h2>
1.182 +<a id="a1d959c29af3125bdd37cde3a554e729c"></a>
1.183 +<h2 class="memtitle"><span class="permalink"><a href="#a1d959c29af3125bdd37cde3a554e729c">◆ </a></span>ucx_array_util_set</h2>
1.184 +
1.185 +<div class="memitem">
1.186 +<div class="memproto">
1.187 + <table class="memname">
1.188 + <tr>
1.189 + <td class="memname">#define ucx_array_util_set</td>
1.190 + <td>(</td>
1.191 + <td class="paramtype"> </td>
1.192 + <td class="paramname">array, </td>
1.193 + </tr>
1.194 + <tr>
1.195 + <td class="paramkey"></td>
1.196 + <td></td>
1.197 + <td class="paramtype"> </td>
1.198 + <td class="paramname">capacity, </td>
1.199 + </tr>
1.200 + <tr>
1.201 + <td class="paramkey"></td>
1.202 + <td></td>
1.203 + <td class="paramtype"> </td>
1.204 + <td class="paramname">elmsize, </td>
1.205 + </tr>
1.206 + <tr>
1.207 + <td class="paramkey"></td>
1.208 + <td></td>
1.209 + <td class="paramtype"> </td>
1.210 + <td class="paramname">idx, </td>
1.211 + </tr>
1.212 + <tr>
1.213 + <td class="paramkey"></td>
1.214 + <td></td>
1.215 + <td class="paramtype"> </td>
1.216 + <td class="paramname">data </td>
1.217 + </tr>
1.218 + <tr>
1.219 + <td></td>
1.220 + <td>)</td>
1.221 + <td></td><td></td>
1.222 + </tr>
1.223 + </table>
1.224 +</div><div class="memdoc">
1.225 +<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="array_8h.html#ad0a8d76980cf1c1910e64a245803fb9a">ucx_array_util_set_a</a>(<a class="code" href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a>(), (<span class="keywordtype">void</span>**)(array), capacity, \</div><div class="line"> elmsize, idx, data)</div><div class="ttc" id="array_8h_html_ad0a8d76980cf1c1910e64a245803fb9a"><div class="ttname"><a href="array_8h.html#ad0a8d76980cf1c1910e64a245803fb9a">ucx_array_util_set_a</a></div><div class="ttdeci">int ucx_array_util_set_a(UcxAllocator *alloc, void **array, size_t *capacity, size_t elmsize, size_t idx, void *data)</div><div class="ttdoc">Sets an element in an arbitrary user defined array. </div><div class="ttdef"><b>Definition:</b> array.c:72</div></div>
1.226 +<div class="ttc" id="allocator_8h_html_a98d2f1b341118b7a0e341fda5d8b2ebf"><div class="ttname"><a href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a></div><div class="ttdeci">UcxAllocator * ucx_default_allocator()</div><div class="ttdoc">Returns a pointer to the default allocator. </div><div class="ttdef"><b>Definition:</b> allocator.c:41</div></div>
1.227 +</div><!-- fragment -->
1.228 +<p>Sets an element in an arbitrary user defined array. </p>
1.229 +<p>The data is copied from the specified data location.</p>
1.230 +<p>If the capacity is insufficient, the array is automatically reallocated and the possibly new pointer is stored in the <code>array</code> argument.</p>
1.231 +<p>On reallocation the capacity of the array is doubled until it is sufficient. The new capacity is stored back to <code>capacity</code>.</p>
1.232 +<dl class="params"><dt>Parameters</dt><dd>
1.233 + <table class="params">
1.234 + <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
1.235 + <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
1.236 + <tr><td class="paramname">elmsize</td><td>the size of each element </td></tr>
1.237 + <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
1.238 + <tr><td class="paramname">data</td><td>a pointer to the element data </td></tr>
1.239 + </table>
1.240 + </dd>
1.241 +</dl>
1.242 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
1.243 +
1.244 +</div>
1.245 +</div>
1.246 +<a id="a59a5b342965e790945f9c7a3f86b99f9"></a>
1.247 +<h2 class="memtitle"><span class="permalink"><a href="#a59a5b342965e790945f9c7a3f86b99f9">◆ </a></span>ucx_array_util_setptr</h2>
1.248 +
1.249 +<div class="memitem">
1.250 +<div class="memproto">
1.251 + <table class="memname">
1.252 + <tr>
1.253 + <td class="memname">#define ucx_array_util_setptr</td>
1.254 + <td>(</td>
1.255 + <td class="paramtype"> </td>
1.256 + <td class="paramname">array, </td>
1.257 + </tr>
1.258 + <tr>
1.259 + <td class="paramkey"></td>
1.260 + <td></td>
1.261 + <td class="paramtype"> </td>
1.262 + <td class="paramname">capacity, </td>
1.263 + </tr>
1.264 + <tr>
1.265 + <td class="paramkey"></td>
1.266 + <td></td>
1.267 + <td class="paramtype"> </td>
1.268 + <td class="paramname">idx, </td>
1.269 + </tr>
1.270 + <tr>
1.271 + <td class="paramkey"></td>
1.272 + <td></td>
1.273 + <td class="paramtype"> </td>
1.274 + <td class="paramname">ptr </td>
1.275 + </tr>
1.276 + <tr>
1.277 + <td></td>
1.278 + <td>)</td>
1.279 + <td></td><td></td>
1.280 + </tr>
1.281 + </table>
1.282 +</div><div class="memdoc">
1.283 +<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="array_8h.html#ad708b333c0c1b02c998309a58ea65e31">ucx_array_util_setptr_a</a>(<a class="code" href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a>(), (<span class="keywordtype">void</span>**)(array), \</div><div class="line"> capacity, idx, ptr)</div><div class="ttc" id="allocator_8h_html_a98d2f1b341118b7a0e341fda5d8b2ebf"><div class="ttname"><a href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a></div><div class="ttdeci">UcxAllocator * ucx_default_allocator()</div><div class="ttdoc">Returns a pointer to the default allocator. </div><div class="ttdef"><b>Definition:</b> allocator.c:41</div></div>
1.284 +<div class="ttc" id="array_8h_html_ad708b333c0c1b02c998309a58ea65e31"><div class="ttname"><a href="array_8h.html#ad708b333c0c1b02c998309a58ea65e31">ucx_array_util_setptr_a</a></div><div class="ttdeci">int ucx_array_util_setptr_a(UcxAllocator *alloc, void **array, size_t *capacity, size_t idx, void *ptr)</div><div class="ttdoc">Stores a pointer in an arbitrary user defined array. </div><div class="ttdef"><b>Definition:</b> array.c:112</div></div>
1.285 +</div><!-- fragment -->
1.286 +<p>Stores a pointer in an arbitrary user defined array. </p>
1.287 +<p>The element size of the array must be sizeof(void*).</p>
1.288 +<p>If the capacity is insufficient, the array is automatically reallocated and the possibly new pointer is stored in the <code>array</code> argument.</p>
1.289 +<p>On reallocation the capacity of the array is doubled until it is sufficient. The new capacity is stored back to <code>capacity</code>.</p>
1.290 +<dl class="params"><dt>Parameters</dt><dd>
1.291 + <table class="params">
1.292 + <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
1.293 + <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
1.294 + <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
1.295 + <tr><td class="paramname">ptr</td><td>the pointer to store </td></tr>
1.296 + </table>
1.297 + </dd>
1.298 +</dl>
1.299 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
1.300 +
1.301 +</div>
1.302 +</div>
1.303 +<h2 class="groupheader">Function Documentation</h2>
1.304 +<a id="aea01731ad94ea73c0c8fb1d1b7a35fcf"></a>
1.305 +<h2 class="memtitle"><span class="permalink"><a href="#aea01731ad94ea73c0c8fb1d1b7a35fcf">◆ </a></span>ucx_array_append_from()</h2>
1.306 +
1.307 +<div class="memitem">
1.308 +<div class="memproto">
1.309 + <table class="memname">
1.310 + <tr>
1.311 + <td class="memname">int ucx_array_append_from </td>
1.312 + <td>(</td>
1.313 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.314 + <td class="paramname"><em>array</em>, </td>
1.315 + </tr>
1.316 + <tr>
1.317 + <td class="paramkey"></td>
1.318 + <td></td>
1.319 + <td class="paramtype">void * </td>
1.320 + <td class="paramname"><em>data</em>, </td>
1.321 + </tr>
1.322 + <tr>
1.323 + <td class="paramkey"></td>
1.324 + <td></td>
1.325 + <td class="paramtype">size_t </td>
1.326 + <td class="paramname"><em>count</em> </td>
1.327 + </tr>
1.328 + <tr>
1.329 + <td></td>
1.330 + <td>)</td>
1.331 + <td></td><td></td>
1.332 + </tr>
1.333 + </table>
1.334 +</div><div class="memdoc">
1.335 +
1.336 +<p>Inserts elements at the end of the array. </p>
1.337 +<p>This is an O(1) operation. The array will automatically grow, if the capacity is exceeded. If a pointer to data is provided, the data is copied into the array with memcpy(). Otherwise the new elements are completely zeroed.</p>
1.338 +<dl class="params"><dt>Parameters</dt><dd>
1.339 + <table class="params">
1.340 + <tr><td class="paramname">array</td><td>a pointer the array where to append the data </td></tr>
1.341 + <tr><td class="paramname">data</td><td>a pointer to the data to insert (may be <code>NULL</code>) </td></tr>
1.342 + <tr><td class="paramname">count</td><td>number of elements to copy from data (if data is <code>NULL</code>, zeroed elements are appended) </td></tr>
1.343 + </table>
1.344 + </dd>
1.345 +</dl>
1.346 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if a reallocation was necessary but failed </dd></dl>
1.347 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="array_8h.html#a1bb545d065358d265d80d815ba382a28" title="Sets elements starting at the specified index. ">ucx_array_set_from()</a> </dd>
1.348 +<dd>
1.349 +ucx_array_append() </dd></dl>
1.350 +
1.351 +</div>
1.352 +</div>
1.353 +<a id="aa698085fd1a8b70d6b709999c51b49e8"></a>
1.354 +<h2 class="memtitle"><span class="permalink"><a href="#aa698085fd1a8b70d6b709999c51b49e8">◆ </a></span>ucx_array_at()</h2>
1.355 +
1.356 +<div class="memitem">
1.357 +<div class="memproto">
1.358 + <table class="memname">
1.359 + <tr>
1.360 + <td class="memname">void* ucx_array_at </td>
1.361 + <td>(</td>
1.362 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const * </td>
1.363 + <td class="paramname"><em>array</em>, </td>
1.364 + </tr>
1.365 + <tr>
1.366 + <td class="paramkey"></td>
1.367 + <td></td>
1.368 + <td class="paramtype">size_t </td>
1.369 + <td class="paramname"><em>index</em> </td>
1.370 + </tr>
1.371 + <tr>
1.372 + <td></td>
1.373 + <td>)</td>
1.374 + <td></td><td></td>
1.375 + </tr>
1.376 + </table>
1.377 +</div><div class="memdoc">
1.378 +
1.379 +<p>Returns a pointer to the array element at the specified index. </p>
1.380 +<dl class="params"><dt>Parameters</dt><dd>
1.381 + <table class="params">
1.382 + <tr><td class="paramname">array</td><td>the array to retrieve the element from </td></tr>
1.383 + <tr><td class="paramname">index</td><td>index of the element to return </td></tr>
1.384 + </table>
1.385 + </dd>
1.386 +</dl>
1.387 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the element at the specified index or <code>NULL</code>, if the index is greater than the array size </dd></dl>
1.388 +
1.389 +</div>
1.390 +</div>
1.391 +<a id="a4a8c273370e4a3a3e2624e364f5ab410"></a>
1.392 +<h2 class="memtitle"><span class="permalink"><a href="#a4a8c273370e4a3a3e2624e364f5ab410">◆ </a></span>ucx_array_clone()</h2>
1.393 +
1.394 +<div class="memitem">
1.395 +<div class="memproto">
1.396 + <table class="memname">
1.397 + <tr>
1.398 + <td class="memname">int ucx_array_clone </td>
1.399 + <td>(</td>
1.400 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.401 + <td class="paramname"><em>dest</em>, </td>
1.402 + </tr>
1.403 + <tr>
1.404 + <td class="paramkey"></td>
1.405 + <td></td>
1.406 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const * </td>
1.407 + <td class="paramname"><em>src</em> </td>
1.408 + </tr>
1.409 + <tr>
1.410 + <td></td>
1.411 + <td>)</td>
1.412 + <td></td><td></td>
1.413 + </tr>
1.414 + </table>
1.415 +</div><div class="memdoc">
1.416 +
1.417 +<p>Creates an shallow copy of an array. </p>
1.418 +<p>This function clones the specified array by using memcpy(). If the destination capacity is insufficient, an automatic reallocation is attempted.</p>
1.419 +<p>Note: if the destination array is uninitialized, the behavior is undefined.</p>
1.420 +<dl class="params"><dt>Parameters</dt><dd>
1.421 + <table class="params">
1.422 + <tr><td class="paramname">dest</td><td>the array to copy to </td></tr>
1.423 + <tr><td class="paramname">src</td><td>the array to copy from </td></tr>
1.424 + </table>
1.425 + </dd>
1.426 +</dl>
1.427 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero on reallocation failure. </dd></dl>
1.428 +
1.429 +</div>
1.430 +</div>
1.431 +<a id="aa5a0bf3d3f0df6406beb0e569021cc28"></a>
1.432 +<h2 class="memtitle"><span class="permalink"><a href="#aa5a0bf3d3f0df6406beb0e569021cc28">◆ </a></span>ucx_array_concat()</h2>
1.433 +
1.434 +<div class="memitem">
1.435 +<div class="memproto">
1.436 + <table class="memname">
1.437 + <tr>
1.438 + <td class="memname">int ucx_array_concat </td>
1.439 + <td>(</td>
1.440 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.441 + <td class="paramname"><em>array1</em>, </td>
1.442 + </tr>
1.443 + <tr>
1.444 + <td class="paramkey"></td>
1.445 + <td></td>
1.446 + <td class="paramtype">const <a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.447 + <td class="paramname"><em>array2</em> </td>
1.448 + </tr>
1.449 + <tr>
1.450 + <td></td>
1.451 + <td>)</td>
1.452 + <td></td><td></td>
1.453 + </tr>
1.454 + </table>
1.455 +</div><div class="memdoc">
1.456 +
1.457 +<p>Concatenates two arrays. </p>
1.458 +<p>The contents of the second array are appended to the first array in one single operation. The second array is otherwise left untouched.</p>
1.459 +<p>The first array may grow automatically. If this fails, both arrays remain unmodified.</p>
1.460 +<dl class="params"><dt>Parameters</dt><dd>
1.461 + <table class="params">
1.462 + <tr><td class="paramname">array1</td><td>first array </td></tr>
1.463 + <tr><td class="paramname">array2</td><td>second array </td></tr>
1.464 + </table>
1.465 + </dd>
1.466 +</dl>
1.467 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation was necessary but failed or the element size does not match </dd></dl>
1.468 +
1.469 +</div>
1.470 +</div>
1.471 +<a id="a5241058cd2329147bc5b1593ae7e51dc"></a>
1.472 +<h2 class="memtitle"><span class="permalink"><a href="#a5241058cd2329147bc5b1593ae7e51dc">◆ </a></span>ucx_array_contains()</h2>
1.473 +
1.474 +<div class="memitem">
1.475 +<div class="memproto">
1.476 + <table class="memname">
1.477 + <tr>
1.478 + <td class="memname">int ucx_array_contains </td>
1.479 + <td>(</td>
1.480 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const * </td>
1.481 + <td class="paramname"><em>array</em>, </td>
1.482 + </tr>
1.483 + <tr>
1.484 + <td class="paramkey"></td>
1.485 + <td></td>
1.486 + <td class="paramtype">void * </td>
1.487 + <td class="paramname"><em>elem</em>, </td>
1.488 + </tr>
1.489 + <tr>
1.490 + <td class="paramkey"></td>
1.491 + <td></td>
1.492 + <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> </td>
1.493 + <td class="paramname"><em>cmpfnc</em>, </td>
1.494 + </tr>
1.495 + <tr>
1.496 + <td class="paramkey"></td>
1.497 + <td></td>
1.498 + <td class="paramtype">void * </td>
1.499 + <td class="paramname"><em>data</em> </td>
1.500 + </tr>
1.501 + <tr>
1.502 + <td></td>
1.503 + <td>)</td>
1.504 + <td></td><td></td>
1.505 + </tr>
1.506 + </table>
1.507 +</div><div class="memdoc">
1.508 +
1.509 +<p>Checks, if an array contains a specific element. </p>
1.510 +<p>An element is found, if <a class="el" href="array_8h.html#ae7bdbed94afee9b20b38b95e3ab470f0" title="Returns the index of an element containing the specified data. ">ucx_array_find()</a> returns a value less than the size.</p>
1.511 +<dl class="params"><dt>Parameters</dt><dd>
1.512 + <table class="params">
1.513 + <tr><td class="paramname">array</td><td>the array where to search for the data </td></tr>
1.514 + <tr><td class="paramname">elem</td><td>the element data </td></tr>
1.515 + <tr><td class="paramname">cmpfnc</td><td>the compare function </td></tr>
1.516 + <tr><td class="paramname">data</td><td>additional data for the compare function </td></tr>
1.517 + </table>
1.518 + </dd>
1.519 +</dl>
1.520 +<dl class="section return"><dt>Returns</dt><dd>1, if and only if the array contains the specified element data </dd></dl>
1.521 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="array_8h.html#ae7bdbed94afee9b20b38b95e3ab470f0" title="Returns the index of an element containing the specified data. ">ucx_array_find()</a> </dd></dl>
1.522 +
1.523 +</div>
1.524 +</div>
1.525 +<a id="a8e83681d8d5d8cddbf10f63ce5be4c10"></a>
1.526 +<h2 class="memtitle"><span class="permalink"><a href="#a8e83681d8d5d8cddbf10f63ce5be4c10">◆ </a></span>ucx_array_destroy()</h2>
1.527 +
1.528 +<div class="memitem">
1.529 +<div class="memproto">
1.530 + <table class="memname">
1.531 + <tr>
1.532 + <td class="memname">void ucx_array_destroy </td>
1.533 + <td>(</td>
1.534 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.535 + <td class="paramname"><em>array</em></td><td>)</td>
1.536 + <td></td>
1.537 + </tr>
1.538 + </table>
1.539 +</div><div class="memdoc">
1.540 +
1.541 +<p>Destroys the array. </p>
1.542 +<p>The data is freed and both capacity and count are reset to zero. If the array structure itself has been dynamically allocated, it has to be freed separately.</p>
1.543 +<dl class="params"><dt>Parameters</dt><dd>
1.544 + <table class="params">
1.545 + <tr><td class="paramname">array</td><td>the array to destroy </td></tr>
1.546 + </table>
1.547 + </dd>
1.548 +</dl>
1.549 +
1.550 +</div>
1.551 +</div>
1.552 +<a id="a43292b448adb1741677aa8c578bcc201"></a>
1.553 +<h2 class="memtitle"><span class="permalink"><a href="#a43292b448adb1741677aa8c578bcc201">◆ </a></span>ucx_array_equals()</h2>
1.554 +
1.555 +<div class="memitem">
1.556 +<div class="memproto">
1.557 + <table class="memname">
1.558 + <tr>
1.559 + <td class="memname">int ucx_array_equals </td>
1.560 + <td>(</td>
1.561 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const * </td>
1.562 + <td class="paramname"><em>array1</em>, </td>
1.563 + </tr>
1.564 + <tr>
1.565 + <td class="paramkey"></td>
1.566 + <td></td>
1.567 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const * </td>
1.568 + <td class="paramname"><em>array2</em>, </td>
1.569 + </tr>
1.570 + <tr>
1.571 + <td class="paramkey"></td>
1.572 + <td></td>
1.573 + <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> </td>
1.574 + <td class="paramname"><em>cmpfnc</em>, </td>
1.575 + </tr>
1.576 + <tr>
1.577 + <td class="paramkey"></td>
1.578 + <td></td>
1.579 + <td class="paramtype">void * </td>
1.580 + <td class="paramname"><em>data</em> </td>
1.581 + </tr>
1.582 + <tr>
1.583 + <td></td>
1.584 + <td>)</td>
1.585 + <td></td><td></td>
1.586 + </tr>
1.587 + </table>
1.588 +</div><div class="memdoc">
1.589 +
1.590 +<p>Compares two UCX arrays element-wise by using a compare function. </p>
1.591 +<p>Elements of the two specified arrays are compared by using the specified compare function and the additional data. The type and content of this additional data depends on the <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791" title="Function pointer to a compare function. ">cmp_func()</a> used.</p>
1.592 +<p>This function always returns zero, if the element sizes of the arrays do not match and performs no comparisons in this case.</p>
1.593 +<dl class="params"><dt>Parameters</dt><dd>
1.594 + <table class="params">
1.595 + <tr><td class="paramname">array1</td><td>the first array </td></tr>
1.596 + <tr><td class="paramname">array2</td><td>the second array </td></tr>
1.597 + <tr><td class="paramname">cmpfnc</td><td>the compare function </td></tr>
1.598 + <tr><td class="paramname">data</td><td>additional data for the compare function </td></tr>
1.599 + </table>
1.600 + </dd>
1.601 +</dl>
1.602 +<dl class="section return"><dt>Returns</dt><dd>1, if and only if the two arrays equal element-wise, 0 otherwise </dd></dl>
1.603 +
1.604 +</div>
1.605 +</div>
1.606 +<a id="ae7bdbed94afee9b20b38b95e3ab470f0"></a>
1.607 +<h2 class="memtitle"><span class="permalink"><a href="#ae7bdbed94afee9b20b38b95e3ab470f0">◆ </a></span>ucx_array_find()</h2>
1.608 +
1.609 +<div class="memitem">
1.610 +<div class="memproto">
1.611 + <table class="memname">
1.612 + <tr>
1.613 + <td class="memname">size_t ucx_array_find </td>
1.614 + <td>(</td>
1.615 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const * </td>
1.616 + <td class="paramname"><em>array</em>, </td>
1.617 + </tr>
1.618 + <tr>
1.619 + <td class="paramkey"></td>
1.620 + <td></td>
1.621 + <td class="paramtype">void * </td>
1.622 + <td class="paramname"><em>elem</em>, </td>
1.623 + </tr>
1.624 + <tr>
1.625 + <td class="paramkey"></td>
1.626 + <td></td>
1.627 + <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> </td>
1.628 + <td class="paramname"><em>cmpfnc</em>, </td>
1.629 + </tr>
1.630 + <tr>
1.631 + <td class="paramkey"></td>
1.632 + <td></td>
1.633 + <td class="paramtype">void * </td>
1.634 + <td class="paramname"><em>data</em> </td>
1.635 + </tr>
1.636 + <tr>
1.637 + <td></td>
1.638 + <td>)</td>
1.639 + <td></td><td></td>
1.640 + </tr>
1.641 + </table>
1.642 +</div><div class="memdoc">
1.643 +
1.644 +<p>Returns the index of an element containing the specified data. </p>
1.645 +<p>This function uses a <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791" title="Function pointer to a compare function. ">cmp_func()</a> to compare the data of each list element with the specified data. If no cmp_func is provided, memcmp() is used.</p>
1.646 +<p>If the array contains the data more than once, the index of the first occurrence is returned. If the array does not contain the data, the size of array is returned.</p>
1.647 +<dl class="params"><dt>Parameters</dt><dd>
1.648 + <table class="params">
1.649 + <tr><td class="paramname">array</td><td>the array where to search for the data </td></tr>
1.650 + <tr><td class="paramname">elem</td><td>the element data </td></tr>
1.651 + <tr><td class="paramname">cmpfnc</td><td>the compare function </td></tr>
1.652 + <tr><td class="paramname">data</td><td>additional data for the compare function </td></tr>
1.653 + </table>
1.654 + </dd>
1.655 +</dl>
1.656 +<dl class="section return"><dt>Returns</dt><dd>the index of the element containing the specified data or the size of the array, if the data is not found in this array </dd></dl>
1.657 +
1.658 +</div>
1.659 +</div>
1.660 +<a id="ac01ee914468a16f470bf3071fffbe438"></a>
1.661 +<h2 class="memtitle"><span class="permalink"><a href="#ac01ee914468a16f470bf3071fffbe438">◆ </a></span>ucx_array_free()</h2>
1.662 +
1.663 +<div class="memitem">
1.664 +<div class="memproto">
1.665 + <table class="memname">
1.666 + <tr>
1.667 + <td class="memname">void ucx_array_free </td>
1.668 + <td>(</td>
1.669 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.670 + <td class="paramname"><em>array</em></td><td>)</td>
1.671 + <td></td>
1.672 + </tr>
1.673 + </table>
1.674 +</div><div class="memdoc">
1.675 +
1.676 +<p>Destroys and frees the array. </p>
1.677 +<dl class="params"><dt>Parameters</dt><dd>
1.678 + <table class="params">
1.679 + <tr><td class="paramname">array</td><td>the array to free </td></tr>
1.680 + </table>
1.681 + </dd>
1.682 +</dl>
1.683 +
1.684 +</div>
1.685 +</div>
1.686 +<a id="ab0cbf243824aaebee48277315e03afce"></a>
1.687 +<h2 class="memtitle"><span class="permalink"><a href="#ab0cbf243824aaebee48277315e03afce">◆ </a></span>ucx_array_grow()</h2>
1.688 +
1.689 +<div class="memitem">
1.690 +<div class="memproto">
1.691 + <table class="memname">
1.692 + <tr>
1.693 + <td class="memname">int ucx_array_grow </td>
1.694 + <td>(</td>
1.695 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.696 + <td class="paramname"><em>array</em>, </td>
1.697 + </tr>
1.698 + <tr>
1.699 + <td class="paramkey"></td>
1.700 + <td></td>
1.701 + <td class="paramtype">size_t </td>
1.702 + <td class="paramname"><em>count</em> </td>
1.703 + </tr>
1.704 + <tr>
1.705 + <td></td>
1.706 + <td>)</td>
1.707 + <td></td><td></td>
1.708 + </tr>
1.709 + </table>
1.710 +</div><div class="memdoc">
1.711 +
1.712 +<p>Resizes the capacity, if the specified number of elements would not fit. </p>
1.713 +<p>A call to ucx_array_grow(array, count) is effectively the same as ucx_array_reserve(array, array->size+count).</p>
1.714 +<dl class="params"><dt>Parameters</dt><dd>
1.715 + <table class="params">
1.716 + <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
1.717 + <tr><td class="paramname">count</td><td>the number of elements that should additionally fit into the array </td></tr>
1.718 + </table>
1.719 + </dd>
1.720 +</dl>
1.721 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
1.722 +
1.723 +</div>
1.724 +</div>
1.725 +<a id="ad921e85c28ffae32230777a53c5037e5"></a>
1.726 +<h2 class="memtitle"><span class="permalink"><a href="#ad921e85c28ffae32230777a53c5037e5">◆ </a></span>ucx_array_init()</h2>
1.727 +
1.728 +<div class="memitem">
1.729 +<div class="memproto">
1.730 + <table class="memname">
1.731 + <tr>
1.732 + <td class="memname">void ucx_array_init </td>
1.733 + <td>(</td>
1.734 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.735 + <td class="paramname"><em>array</em>, </td>
1.736 + </tr>
1.737 + <tr>
1.738 + <td class="paramkey"></td>
1.739 + <td></td>
1.740 + <td class="paramtype">size_t </td>
1.741 + <td class="paramname"><em>capacity</em>, </td>
1.742 + </tr>
1.743 + <tr>
1.744 + <td class="paramkey"></td>
1.745 + <td></td>
1.746 + <td class="paramtype">size_t </td>
1.747 + <td class="paramname"><em>elemsize</em> </td>
1.748 + </tr>
1.749 + <tr>
1.750 + <td></td>
1.751 + <td>)</td>
1.752 + <td></td><td></td>
1.753 + </tr>
1.754 + </table>
1.755 +</div><div class="memdoc">
1.756 +
1.757 +<p>Initializes a UCX array structure with the given capacity and element size. </p>
1.758 +<p>The structure must be uninitialized as the data pointer will be overwritten.</p>
1.759 +<dl class="params"><dt>Parameters</dt><dd>
1.760 + <table class="params">
1.761 + <tr><td class="paramname">array</td><td>the structure to initialize </td></tr>
1.762 + <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
1.763 + <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
1.764 + </table>
1.765 + </dd>
1.766 +</dl>
1.767 +
1.768 +</div>
1.769 +</div>
1.770 +<a id="a2451e61ebb15a7ba1c1319267ba75b8c"></a>
1.771 +<h2 class="memtitle"><span class="permalink"><a href="#a2451e61ebb15a7ba1c1319267ba75b8c">◆ </a></span>ucx_array_init_a()</h2>
1.772 +
1.773 +<div class="memitem">
1.774 +<div class="memproto">
1.775 + <table class="memname">
1.776 + <tr>
1.777 + <td class="memname">void ucx_array_init_a </td>
1.778 + <td>(</td>
1.779 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.780 + <td class="paramname"><em>array</em>, </td>
1.781 + </tr>
1.782 + <tr>
1.783 + <td class="paramkey"></td>
1.784 + <td></td>
1.785 + <td class="paramtype">size_t </td>
1.786 + <td class="paramname"><em>capacity</em>, </td>
1.787 + </tr>
1.788 + <tr>
1.789 + <td class="paramkey"></td>
1.790 + <td></td>
1.791 + <td class="paramtype">size_t </td>
1.792 + <td class="paramname"><em>elemsize</em>, </td>
1.793 + </tr>
1.794 + <tr>
1.795 + <td class="paramkey"></td>
1.796 + <td></td>
1.797 + <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td>
1.798 + <td class="paramname"><em>allocator</em> </td>
1.799 + </tr>
1.800 + <tr>
1.801 + <td></td>
1.802 + <td>)</td>
1.803 + <td></td><td></td>
1.804 + </tr>
1.805 + </table>
1.806 +</div><div class="memdoc">
1.807 +
1.808 +<p>Initializes a UCX array structure using the specified allocator. </p>
1.809 +<p>The structure must be uninitialized as the data pointer will be overwritten.</p>
1.810 +<dl class="params"><dt>Parameters</dt><dd>
1.811 + <table class="params">
1.812 + <tr><td class="paramname">array</td><td>the structure to initialize </td></tr>
1.813 + <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
1.814 + <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
1.815 + <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
1.816 + </table>
1.817 + </dd>
1.818 +</dl>
1.819 +
1.820 +</div>
1.821 +</div>
1.822 +<a id="a994a2fbf1c33a3833e2a70cd9a4352b7"></a>
1.823 +<h2 class="memtitle"><span class="permalink"><a href="#a994a2fbf1c33a3833e2a70cd9a4352b7">◆ </a></span>ucx_array_new()</h2>
1.824 +
1.825 +<div class="memitem">
1.826 +<div class="memproto">
1.827 + <table class="memname">
1.828 + <tr>
1.829 + <td class="memname"><a class="el" href="structUcxArray.html">UcxArray</a>* ucx_array_new </td>
1.830 + <td>(</td>
1.831 + <td class="paramtype">size_t </td>
1.832 + <td class="paramname"><em>capacity</em>, </td>
1.833 + </tr>
1.834 + <tr>
1.835 + <td class="paramkey"></td>
1.836 + <td></td>
1.837 + <td class="paramtype">size_t </td>
1.838 + <td class="paramname"><em>elemsize</em> </td>
1.839 + </tr>
1.840 + <tr>
1.841 + <td></td>
1.842 + <td>)</td>
1.843 + <td></td><td></td>
1.844 + </tr>
1.845 + </table>
1.846 +</div><div class="memdoc">
1.847 +
1.848 +<p>Creates a new UCX array with the given capacity and element size. </p>
1.849 +<dl class="params"><dt>Parameters</dt><dd>
1.850 + <table class="params">
1.851 + <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
1.852 + <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
1.853 + </table>
1.854 + </dd>
1.855 +</dl>
1.856 +<dl class="section return"><dt>Returns</dt><dd>a pointer to a new UCX array structure </dd></dl>
1.857 +
1.858 +</div>
1.859 +</div>
1.860 +<a id="a177170258c215eb2e4f5a32e59f0cb1b"></a>
1.861 +<h2 class="memtitle"><span class="permalink"><a href="#a177170258c215eb2e4f5a32e59f0cb1b">◆ </a></span>ucx_array_new_a()</h2>
1.862 +
1.863 +<div class="memitem">
1.864 +<div class="memproto">
1.865 + <table class="memname">
1.866 + <tr>
1.867 + <td class="memname"><a class="el" href="structUcxArray.html">UcxArray</a>* ucx_array_new_a </td>
1.868 + <td>(</td>
1.869 + <td class="paramtype">size_t </td>
1.870 + <td class="paramname"><em>capacity</em>, </td>
1.871 + </tr>
1.872 + <tr>
1.873 + <td class="paramkey"></td>
1.874 + <td></td>
1.875 + <td class="paramtype">size_t </td>
1.876 + <td class="paramname"><em>elemsize</em>, </td>
1.877 + </tr>
1.878 + <tr>
1.879 + <td class="paramkey"></td>
1.880 + <td></td>
1.881 + <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td>
1.882 + <td class="paramname"><em>allocator</em> </td>
1.883 + </tr>
1.884 + <tr>
1.885 + <td></td>
1.886 + <td>)</td>
1.887 + <td></td><td></td>
1.888 + </tr>
1.889 + </table>
1.890 +</div><div class="memdoc">
1.891 +
1.892 +<p>Creates a new UCX array using the specified allocator. </p>
1.893 +<dl class="params"><dt>Parameters</dt><dd>
1.894 + <table class="params">
1.895 + <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
1.896 + <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
1.897 + <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
1.898 + </table>
1.899 + </dd>
1.900 +</dl>
1.901 +<dl class="section return"><dt>Returns</dt><dd>a pointer to new UCX array structure </dd></dl>
1.902 +
1.903 +</div>
1.904 +</div>
1.905 +<a id="a95b52acc2193b5c33cf0eaa4f2082477"></a>
1.906 +<h2 class="memtitle"><span class="permalink"><a href="#a95b52acc2193b5c33cf0eaa4f2082477">◆ </a></span>ucx_array_prepend_from()</h2>
1.907 +
1.908 +<div class="memitem">
1.909 +<div class="memproto">
1.910 + <table class="memname">
1.911 + <tr>
1.912 + <td class="memname">int ucx_array_prepend_from </td>
1.913 + <td>(</td>
1.914 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.915 + <td class="paramname"><em>array</em>, </td>
1.916 + </tr>
1.917 + <tr>
1.918 + <td class="paramkey"></td>
1.919 + <td></td>
1.920 + <td class="paramtype">void * </td>
1.921 + <td class="paramname"><em>data</em>, </td>
1.922 + </tr>
1.923 + <tr>
1.924 + <td class="paramkey"></td>
1.925 + <td></td>
1.926 + <td class="paramtype">size_t </td>
1.927 + <td class="paramname"><em>count</em> </td>
1.928 + </tr>
1.929 + <tr>
1.930 + <td></td>
1.931 + <td>)</td>
1.932 + <td></td><td></td>
1.933 + </tr>
1.934 + </table>
1.935 +</div><div class="memdoc">
1.936 +
1.937 +<p>Inserts elements at the beginning of the array. </p>
1.938 +<p>This is an expensive operation, because the contents must be moved. If there is no particular reason to prepend data, you should use <a class="el" href="array_8h.html#aea01731ad94ea73c0c8fb1d1b7a35fcf" title="Inserts elements at the end of the array. ">ucx_array_append_from()</a> instead.</p>
1.939 +<dl class="params"><dt>Parameters</dt><dd>
1.940 + <table class="params">
1.941 + <tr><td class="paramname">array</td><td>a pointer the array where to prepend the data </td></tr>
1.942 + <tr><td class="paramname">data</td><td>a pointer to the data to insert (may be <code>NULL</code>) </td></tr>
1.943 + <tr><td class="paramname">count</td><td>number of elements to copy from data (if data is <code>NULL</code>, zeroed elements are inserted) </td></tr>
1.944 + </table>
1.945 + </dd>
1.946 +</dl>
1.947 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if a reallocation was necessary but failed </dd></dl>
1.948 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="array_8h.html#aea01731ad94ea73c0c8fb1d1b7a35fcf" title="Inserts elements at the end of the array. ">ucx_array_append_from()</a> </dd>
1.949 +<dd>
1.950 +<a class="el" href="array_8h.html#a1bb545d065358d265d80d815ba382a28" title="Sets elements starting at the specified index. ">ucx_array_set_from()</a> </dd>
1.951 +<dd>
1.952 +ucx_array_prepend() </dd></dl>
1.953 +
1.954 +</div>
1.955 +</div>
1.956 +<a id="aa45eac6b697f83adac81c0860cf306b8"></a>
1.957 +<h2 class="memtitle"><span class="permalink"><a href="#aa45eac6b697f83adac81c0860cf306b8">◆ </a></span>ucx_array_remove()</h2>
1.958 +
1.959 +<div class="memitem">
1.960 +<div class="memproto">
1.961 + <table class="memname">
1.962 + <tr>
1.963 + <td class="memname">void ucx_array_remove </td>
1.964 + <td>(</td>
1.965 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.966 + <td class="paramname"><em>array</em>, </td>
1.967 + </tr>
1.968 + <tr>
1.969 + <td class="paramkey"></td>
1.970 + <td></td>
1.971 + <td class="paramtype">size_t </td>
1.972 + <td class="paramname"><em>index</em> </td>
1.973 + </tr>
1.974 + <tr>
1.975 + <td></td>
1.976 + <td>)</td>
1.977 + <td></td><td></td>
1.978 + </tr>
1.979 + </table>
1.980 +</div><div class="memdoc">
1.981 +
1.982 +<p>Removes an element from the array. </p>
1.983 +<p>This is in general an expensive operation, because several elements may be moved. If the order of the elements is not relevant, use <a class="el" href="array_8h.html#a548d81b07612bae3ba8c4c4b49104b8e" title="Removes an element from the array. ">ucx_array_remove_fast()</a> instead.</p>
1.984 +<dl class="params"><dt>Parameters</dt><dd>
1.985 + <table class="params">
1.986 + <tr><td class="paramname">array</td><td>pointer to the array from which the element shall be removed </td></tr>
1.987 + <tr><td class="paramname">index</td><td>the index of the element to remove </td></tr>
1.988 + </table>
1.989 + </dd>
1.990 +</dl>
1.991 +
1.992 +</div>
1.993 +</div>
1.994 +<a id="a548d81b07612bae3ba8c4c4b49104b8e"></a>
1.995 +<h2 class="memtitle"><span class="permalink"><a href="#a548d81b07612bae3ba8c4c4b49104b8e">◆ </a></span>ucx_array_remove_fast()</h2>
1.996 +
1.997 +<div class="memitem">
1.998 +<div class="memproto">
1.999 + <table class="memname">
1.1000 + <tr>
1.1001 + <td class="memname">void ucx_array_remove_fast </td>
1.1002 + <td>(</td>
1.1003 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.1004 + <td class="paramname"><em>array</em>, </td>
1.1005 + </tr>
1.1006 + <tr>
1.1007 + <td class="paramkey"></td>
1.1008 + <td></td>
1.1009 + <td class="paramtype">size_t </td>
1.1010 + <td class="paramname"><em>index</em> </td>
1.1011 + </tr>
1.1012 + <tr>
1.1013 + <td></td>
1.1014 + <td>)</td>
1.1015 + <td></td><td></td>
1.1016 + </tr>
1.1017 + </table>
1.1018 +</div><div class="memdoc">
1.1019 +
1.1020 +<p>Removes an element from the array. </p>
1.1021 +<p>This is an O(1) operation, but does not maintain the order of the elements. The last element in the array is moved to the location of the removed element.</p>
1.1022 +<dl class="params"><dt>Parameters</dt><dd>
1.1023 + <table class="params">
1.1024 + <tr><td class="paramname">array</td><td>pointer to the array from which the element shall be removed </td></tr>
1.1025 + <tr><td class="paramname">index</td><td>the index of the element to remove </td></tr>
1.1026 + </table>
1.1027 + </dd>
1.1028 +</dl>
1.1029 +
1.1030 +</div>
1.1031 +</div>
1.1032 +<a id="a1c3bf8433c1de3c933f3854ab297fe1d"></a>
1.1033 +<h2 class="memtitle"><span class="permalink"><a href="#a1c3bf8433c1de3c933f3854ab297fe1d">◆ </a></span>ucx_array_reserve()</h2>
1.1034 +
1.1035 +<div class="memitem">
1.1036 +<div class="memproto">
1.1037 + <table class="memname">
1.1038 + <tr>
1.1039 + <td class="memname">int ucx_array_reserve </td>
1.1040 + <td>(</td>
1.1041 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.1042 + <td class="paramname"><em>array</em>, </td>
1.1043 + </tr>
1.1044 + <tr>
1.1045 + <td class="paramkey"></td>
1.1046 + <td></td>
1.1047 + <td class="paramtype">size_t </td>
1.1048 + <td class="paramname"><em>capacity</em> </td>
1.1049 + </tr>
1.1050 + <tr>
1.1051 + <td></td>
1.1052 + <td>)</td>
1.1053 + <td></td><td></td>
1.1054 + </tr>
1.1055 + </table>
1.1056 +</div><div class="memdoc">
1.1057 +
1.1058 +<p>Resizes the array only, if the capacity is insufficient. </p>
1.1059 +<p>If the requested capacity is smaller than the current capacity, this function does nothing.</p>
1.1060 +<dl class="params"><dt>Parameters</dt><dd>
1.1061 + <table class="params">
1.1062 + <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
1.1063 + <tr><td class="paramname">capacity</td><td>the guaranteed capacity </td></tr>
1.1064 + </table>
1.1065 + </dd>
1.1066 +</dl>
1.1067 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
1.1068 +
1.1069 +</div>
1.1070 +</div>
1.1071 +<a id="a27762e7c06a6c781015e3c8ceeee0ce3"></a>
1.1072 +<h2 class="memtitle"><span class="permalink"><a href="#a27762e7c06a6c781015e3c8ceeee0ce3">◆ </a></span>ucx_array_resize()</h2>
1.1073 +
1.1074 +<div class="memitem">
1.1075 +<div class="memproto">
1.1076 + <table class="memname">
1.1077 + <tr>
1.1078 + <td class="memname">int ucx_array_resize </td>
1.1079 + <td>(</td>
1.1080 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.1081 + <td class="paramname"><em>array</em>, </td>
1.1082 + </tr>
1.1083 + <tr>
1.1084 + <td class="paramkey"></td>
1.1085 + <td></td>
1.1086 + <td class="paramtype">size_t </td>
1.1087 + <td class="paramname"><em>capacity</em> </td>
1.1088 + </tr>
1.1089 + <tr>
1.1090 + <td></td>
1.1091 + <td>)</td>
1.1092 + <td></td><td></td>
1.1093 + </tr>
1.1094 + </table>
1.1095 +</div><div class="memdoc">
1.1096 +
1.1097 +<p>Sets the capacity of the array. </p>
1.1098 +<p>If the new capacity is smaller than the size of the array, the elements are removed and the size is adjusted accordingly.</p>
1.1099 +<dl class="params"><dt>Parameters</dt><dd>
1.1100 + <table class="params">
1.1101 + <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
1.1102 + <tr><td class="paramname">capacity</td><td>the new capacity </td></tr>
1.1103 + </table>
1.1104 + </dd>
1.1105 +</dl>
1.1106 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
1.1107 +
1.1108 +</div>
1.1109 +</div>
1.1110 +<a id="a1bb545d065358d265d80d815ba382a28"></a>
1.1111 +<h2 class="memtitle"><span class="permalink"><a href="#a1bb545d065358d265d80d815ba382a28">◆ </a></span>ucx_array_set_from()</h2>
1.1112 +
1.1113 +<div class="memitem">
1.1114 +<div class="memproto">
1.1115 + <table class="memname">
1.1116 + <tr>
1.1117 + <td class="memname">int ucx_array_set_from </td>
1.1118 + <td>(</td>
1.1119 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.1120 + <td class="paramname"><em>array</em>, </td>
1.1121 + </tr>
1.1122 + <tr>
1.1123 + <td class="paramkey"></td>
1.1124 + <td></td>
1.1125 + <td class="paramtype">size_t </td>
1.1126 + <td class="paramname"><em>index</em>, </td>
1.1127 + </tr>
1.1128 + <tr>
1.1129 + <td class="paramkey"></td>
1.1130 + <td></td>
1.1131 + <td class="paramtype">void * </td>
1.1132 + <td class="paramname"><em>data</em>, </td>
1.1133 + </tr>
1.1134 + <tr>
1.1135 + <td class="paramkey"></td>
1.1136 + <td></td>
1.1137 + <td class="paramtype">size_t </td>
1.1138 + <td class="paramname"><em>count</em> </td>
1.1139 + </tr>
1.1140 + <tr>
1.1141 + <td></td>
1.1142 + <td>)</td>
1.1143 + <td></td><td></td>
1.1144 + </tr>
1.1145 + </table>
1.1146 +</div><div class="memdoc">
1.1147 +
1.1148 +<p>Sets elements starting at the specified index. </p>
1.1149 +<p>If the any index is out of bounds, the array automatically grows. The pointer to the data may be NULL, in which case the elements are zeroed.</p>
1.1150 +<dl class="params"><dt>Parameters</dt><dd>
1.1151 + <table class="params">
1.1152 + <tr><td class="paramname">array</td><td>a pointer the array where to set the data </td></tr>
1.1153 + <tr><td class="paramname">index</td><td>the index of the element to set </td></tr>
1.1154 + <tr><td class="paramname">data</td><td>a pointer to the data to insert (may be <code>NULL</code>) </td></tr>
1.1155 + <tr><td class="paramname">count</td><td>number of elements to copy from data (if data is <code>NULL</code>, the memory in the array is zeroed) </td></tr>
1.1156 + </table>
1.1157 + </dd>
1.1158 +</dl>
1.1159 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if a reallocation was necessary but failed </dd></dl>
1.1160 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="array_8h.html#aea01731ad94ea73c0c8fb1d1b7a35fcf" title="Inserts elements at the end of the array. ">ucx_array_append_from()</a> </dd>
1.1161 +<dd>
1.1162 +ucx_array_set() </dd></dl>
1.1163 +
1.1164 +</div>
1.1165 +</div>
1.1166 +<a id="a2daf50e80aee9bccebee876a7efd2dfc"></a>
1.1167 +<h2 class="memtitle"><span class="permalink"><a href="#a2daf50e80aee9bccebee876a7efd2dfc">◆ </a></span>ucx_array_shrink()</h2>
1.1168 +
1.1169 +<div class="memitem">
1.1170 +<div class="memproto">
1.1171 + <table class="memname">
1.1172 + <tr>
1.1173 + <td class="memname">int ucx_array_shrink </td>
1.1174 + <td>(</td>
1.1175 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.1176 + <td class="paramname"><em>array</em></td><td>)</td>
1.1177 + <td></td>
1.1178 + </tr>
1.1179 + </table>
1.1180 +</div><div class="memdoc">
1.1181 +
1.1182 +<p>Shrinks the memory to exactly fit the contents. </p>
1.1183 +<p>After this operation, the capacity equals the size.</p>
1.1184 +<dl class="params"><dt>Parameters</dt><dd>
1.1185 + <table class="params">
1.1186 + <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
1.1187 + </table>
1.1188 + </dd>
1.1189 +</dl>
1.1190 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
1.1191 +
1.1192 +</div>
1.1193 +</div>
1.1194 +<a id="add773514569b872a6624381b4b6af52c"></a>
1.1195 +<h2 class="memtitle"><span class="permalink"><a href="#add773514569b872a6624381b4b6af52c">◆ </a></span>ucx_array_sort()</h2>
1.1196 +
1.1197 +<div class="memitem">
1.1198 +<div class="memproto">
1.1199 + <table class="memname">
1.1200 + <tr>
1.1201 + <td class="memname">void ucx_array_sort </td>
1.1202 + <td>(</td>
1.1203 + <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> * </td>
1.1204 + <td class="paramname"><em>array</em>, </td>
1.1205 + </tr>
1.1206 + <tr>
1.1207 + <td class="paramkey"></td>
1.1208 + <td></td>
1.1209 + <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a> </td>
1.1210 + <td class="paramname"><em>cmpfnc</em>, </td>
1.1211 + </tr>
1.1212 + <tr>
1.1213 + <td class="paramkey"></td>
1.1214 + <td></td>
1.1215 + <td class="paramtype">void * </td>
1.1216 + <td class="paramname"><em>data</em> </td>
1.1217 + </tr>
1.1218 + <tr>
1.1219 + <td></td>
1.1220 + <td>)</td>
1.1221 + <td></td><td></td>
1.1222 + </tr>
1.1223 + </table>
1.1224 +</div><div class="memdoc">
1.1225 +
1.1226 +<p>Sorts a <a class="el" href="structUcxArray.html" title="UCX array type. ">UcxArray</a> with the best available sort algorithm. </p>
1.1227 +<p>The qsort_r() function is used, if available (glibc, FreeBSD or MacOS). The order of arguments is automatically adjusted for the FreeBSD and MacOS version of qsort_r().</p>
1.1228 +<p>If qsort_r() is not available, a merge sort algorithm is used, which is guaranteed to use no more additional memory than for exactly one element.</p>
1.1229 +<dl class="params"><dt>Parameters</dt><dd>
1.1230 + <table class="params">
1.1231 + <tr><td class="paramname">array</td><td>the array to sort </td></tr>
1.1232 + <tr><td class="paramname">cmpfnc</td><td>the function that shall be used to compare the element data </td></tr>
1.1233 + <tr><td class="paramname">data</td><td>additional data for the <a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791" title="Function pointer to a compare function. ">cmp_func()</a> or <code>NULL</code> </td></tr>
1.1234 + </table>
1.1235 + </dd>
1.1236 +</dl>
1.1237 +
1.1238 +</div>
1.1239 +</div>
1.1240 +<a id="ad0a8d76980cf1c1910e64a245803fb9a"></a>
1.1241 +<h2 class="memtitle"><span class="permalink"><a href="#ad0a8d76980cf1c1910e64a245803fb9a">◆ </a></span>ucx_array_util_set_a()</h2>
1.1242 +
1.1243 +<div class="memitem">
1.1244 +<div class="memproto">
1.1245 + <table class="memname">
1.1246 + <tr>
1.1247 + <td class="memname">int ucx_array_util_set_a </td>
1.1248 + <td>(</td>
1.1249 + <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td>
1.1250 + <td class="paramname"><em>alloc</em>, </td>
1.1251 + </tr>
1.1252 + <tr>
1.1253 + <td class="paramkey"></td>
1.1254 + <td></td>
1.1255 + <td class="paramtype">void ** </td>
1.1256 + <td class="paramname"><em>array</em>, </td>
1.1257 + </tr>
1.1258 + <tr>
1.1259 + <td class="paramkey"></td>
1.1260 + <td></td>
1.1261 + <td class="paramtype">size_t * </td>
1.1262 + <td class="paramname"><em>capacity</em>, </td>
1.1263 + </tr>
1.1264 + <tr>
1.1265 + <td class="paramkey"></td>
1.1266 + <td></td>
1.1267 + <td class="paramtype">size_t </td>
1.1268 + <td class="paramname"><em>elmsize</em>, </td>
1.1269 + </tr>
1.1270 + <tr>
1.1271 + <td class="paramkey"></td>
1.1272 + <td></td>
1.1273 + <td class="paramtype">size_t </td>
1.1274 + <td class="paramname"><em>idx</em>, </td>
1.1275 + </tr>
1.1276 + <tr>
1.1277 + <td class="paramkey"></td>
1.1278 + <td></td>
1.1279 + <td class="paramtype">void * </td>
1.1280 + <td class="paramname"><em>data</em> </td>
1.1281 + </tr>
1.1282 + <tr>
1.1283 + <td></td>
1.1284 + <td>)</td>
1.1285 + <td></td><td></td>
1.1286 + </tr>
1.1287 + </table>
1.1288 +</div><div class="memdoc">
1.1289 +
1.1290 +<p>Sets an element in an arbitrary user defined array. </p>
1.1291 +<p>The data is copied from the specified data location.</p>
1.1292 +<p>If the capacity is insufficient, the array is automatically reallocated using the specified allocator and the possibly new pointer is stored in the <code>array</code> argument.</p>
1.1293 +<p>On reallocation the capacity of the array is doubled until it is sufficient. The new capacity is stored back to <code>capacity</code>.</p>
1.1294 +<dl class="params"><dt>Parameters</dt><dd>
1.1295 + <table class="params">
1.1296 + <tr><td class="paramname">alloc</td><td>the allocator that shall be used to reallocate the array </td></tr>
1.1297 + <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
1.1298 + <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
1.1299 + <tr><td class="paramname">elmsize</td><td>the size of each element </td></tr>
1.1300 + <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
1.1301 + <tr><td class="paramname">data</td><td>a pointer to the element data </td></tr>
1.1302 + </table>
1.1303 + </dd>
1.1304 +</dl>
1.1305 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
1.1306 +
1.1307 +</div>
1.1308 +</div>
1.1309 +<a id="ad708b333c0c1b02c998309a58ea65e31"></a>
1.1310 +<h2 class="memtitle"><span class="permalink"><a href="#ad708b333c0c1b02c998309a58ea65e31">◆ </a></span>ucx_array_util_setptr_a()</h2>
1.1311 +
1.1312 +<div class="memitem">
1.1313 +<div class="memproto">
1.1314 + <table class="memname">
1.1315 + <tr>
1.1316 + <td class="memname">int ucx_array_util_setptr_a </td>
1.1317 + <td>(</td>
1.1318 + <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td>
1.1319 + <td class="paramname"><em>alloc</em>, </td>
1.1320 + </tr>
1.1321 + <tr>
1.1322 + <td class="paramkey"></td>
1.1323 + <td></td>
1.1324 + <td class="paramtype">void ** </td>
1.1325 + <td class="paramname"><em>array</em>, </td>
1.1326 + </tr>
1.1327 + <tr>
1.1328 + <td class="paramkey"></td>
1.1329 + <td></td>
1.1330 + <td class="paramtype">size_t * </td>
1.1331 + <td class="paramname"><em>capacity</em>, </td>
1.1332 + </tr>
1.1333 + <tr>
1.1334 + <td class="paramkey"></td>
1.1335 + <td></td>
1.1336 + <td class="paramtype">size_t </td>
1.1337 + <td class="paramname"><em>idx</em>, </td>
1.1338 + </tr>
1.1339 + <tr>
1.1340 + <td class="paramkey"></td>
1.1341 + <td></td>
1.1342 + <td class="paramtype">void * </td>
1.1343 + <td class="paramname"><em>ptr</em> </td>
1.1344 + </tr>
1.1345 + <tr>
1.1346 + <td></td>
1.1347 + <td>)</td>
1.1348 + <td></td><td></td>
1.1349 + </tr>
1.1350 + </table>
1.1351 +</div><div class="memdoc">
1.1352 +
1.1353 +<p>Stores a pointer in an arbitrary user defined array. </p>
1.1354 +<p>The element size of the array must be sizeof(void*).</p>
1.1355 +<p>If the capacity is insufficient, the array is automatically reallocated using the specified allocator and the possibly new pointer is stored in the <code>array</code> argument.</p>
1.1356 +<p>On reallocation the capacity of the array is doubled until it is sufficient. The new capacity is stored back to <code>capacity</code>.</p>
1.1357 +<dl class="params"><dt>Parameters</dt><dd>
1.1358 + <table class="params">
1.1359 + <tr><td class="paramname">alloc</td><td>the allocator that shall be used to reallocate the array </td></tr>
1.1360 + <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
1.1361 + <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
1.1362 + <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
1.1363 + <tr><td class="paramname">ptr</td><td>the pointer to store </td></tr>
1.1364 + </table>
1.1365 + </dd>
1.1366 +</dl>
1.1367 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
1.1368 +
1.1369 +</div>
1.1370 +</div>
1.1371 +</div><!-- contents -->
1.1372 +<!-- start footer part -->
1.1373 +<hr class="footer"/><address class="footer"><small>
1.1374 +Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html">
1.1375 +<img class="footer" src="doxygen.png" alt="doxygen"/>
1.1376 +</a> 1.8.13
1.1377 +</small></address>
1.1378 +</body>
1.1379 +</html>
