Mercurial > hg > ucx / changeset

     1.1 --- a/.hgignore	Mon Dec 30 09:54:10 2019 +0100
     1.2 +++ b/.hgignore	Sat Feb 06 19:11:44 2021 +0100
     1.3 @@ -26,7 +26,7 @@
     1.4  /\.deps/
     1.5  /\.libs/
     1.6  ^stamp-h
     1.7 -^test/ucxtest
     1.8 +test/test_list.c
     1.9  /test-suite.log$
    1.10  ^ucx-.*\.tar.gz$
    1.11  ^.idea/

     2.1 --- a/CHANGELOG	Mon Dec 30 09:54:10 2019 +0100
     2.2 +++ b/CHANGELOG	Sat Feb 06 19:11:44 2021 +0100
     2.3 @@ -1,3 +1,8 @@
     2.4 +Version 3.0 M1
     2.5 +--------------
     2.6 +work in progress
     2.7 +
     2.8 +
     2.9  Version 2.1 - 2019-12-30
    2.10  ------------------------
    2.11  

     3.1 --- a/CMakeLists.txt	Mon Dec 30 09:54:10 2019 +0100
     3.2 +++ b/CMakeLists.txt	Sat Feb 06 19:11:44 2021 +0100
     3.3 @@ -1,5 +1,5 @@
     3.4 -cmake_minimum_required(VERSION 3.10)
     3.5 -project(ucx VERSION 2.1 DESCRIPTION "UAP Common Extensions")
     3.6 +cmake_minimum_required(VERSION 3.14)
     3.7 +project(ucx VERSION 3.0 DESCRIPTION "UAP Common Extensions")
     3.8  
     3.9  # Configuration
    3.10  set(CMAKE_C_STANDARD 11)
    3.11 @@ -11,7 +11,6 @@
    3.12  # Tests
    3.13  enable_testing()
    3.14  add_subdirectory(test)
    3.15 -add_test(NAME test COMMAND ucxtest WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/test")
    3.16  
    3.17  # Web Documentation
    3.18  add_subdirectory(docs/src)
    3.19 @@ -31,10 +30,18 @@
    3.20  
    3.21      configure_file(${CMAKE_SOURCE_DIR}/cmake_infile.doxygen ${CMAKE_BINARY_DIR}/Doxyfile)
    3.22  
    3.23 +    add_custom_target(docs-api-21
    3.24 +            COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/docs/api-2.1 ${CMAKE_BINARY_DIR}/docs/web/api-2.1
    3.25 +            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
    3.26 +            COMMENT "Copying UCX 2.1 API documentation.")
    3.27 +
    3.28      add_custom_target(docs-api
    3.29              COMMAND ${DOXYGEN_EXECUTABLE}
    3.30              WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
    3.31 -            COMMENT "Generating API documentation with Doxygen")
    3.32 +            COMMENT "Generating API documentation with Doxygen.")
    3.33 +
    3.34 +    add_custom_target(docs-all DEPENDS docs-html docs-api docs-api-21)
    3.35 +else()
    3.36 +    add_custom_target(docs-all DEPENDS docs-html)
    3.37  endif()
    3.38  
    3.39 -add_custom_target(docs-all DEPENDS docs-html docs-api)

     4.1 --- a/COPYING	Mon Dec 30 09:54:10 2019 +0100
     4.2 +++ b/COPYING	Sat Feb 06 19:11:44 2021 +0100
     4.3 @@ -1,4 +1,4 @@
     4.4 -Copyright 2017 Mike Becker, Olaf Wintermann. All rights reserved.
     4.5 +Copyright 2021 Mike Becker, Olaf Wintermann. All rights reserved.
     4.6  
     4.7  Redistribution and use in source and binary forms, with or without
     4.8  modification, are permitted provided that the following conditions are met:

     5.1 --- a/Makefile.am	Mon Dec 30 09:54:10 2019 +0100
     5.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     5.3 @@ -1,30 +0,0 @@
     5.4 -#
     5.5 -# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     5.6 -#
     5.7 -# Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
     5.8 -#
     5.9 -# Redistribution and use in source and binary forms, with or without
    5.10 -# modification, are permitted provided that the following conditions are met:
    5.11 -#
    5.12 -#   1. Redistributions of source code must retain the above copyright
    5.13 -#      notice, this list of conditions and the following disclaimer.
    5.14 -#
    5.15 -#   2. Redistributions in binary form must reproduce the above copyright
    5.16 -#      notice, this list of conditions and the following disclaimer in the
    5.17 -#      documentation and/or other materials provided with the distribution.
    5.18 -#
    5.19 -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    5.20 -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    5.21 -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    5.22 -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    5.23 -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    5.24 -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    5.25 -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    5.26 -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    5.27 -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    5.28 -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    5.29 -# POSSIBILITY OF SUCH DAMAGE.
    5.30 -#
    5.31 -
    5.32 -SUBDIRS = src test
    5.33 -ACLOCAL_AMFLAGS = -I m4

     6.1 --- a/README	Mon Dec 30 09:54:10 2019 +0100
     6.2 +++ b/README	Sat Feb 06 19:11:44 2021 +0100
     6.3 @@ -5,11 +5,10 @@
     6.4  0. Table of Contents:
     6.5  
     6.6    1. Introduction  ........................................................ 15
     6.7 -  2. Build  ............................................................... 26
     6.8 -  3. Install  ............................................................. 37
     6.9 -  4. Documentation  ....................................................... 50
    6.10 -  5. Contact  ............................................................. 63
    6.11 -  6. License  ............................................................. 69
    6.12 +  2. Build  ............................................................... 25
    6.13 +  3. Documentation  ....................................................... 44
    6.14 +  4. Contact  ............................................................. 57
    6.15 +  5. License  ............................................................. 64
    6.16  
    6.17  
    6.18  1. Introduction
    6.19 @@ -26,28 +25,23 @@
    6.20  2. Build
    6.21  --------
    6.22  
    6.23 -Untar the source archive and simply run
    6.24 +Untar the source archive and run
    6.25  
    6.26 -  ./configure && make
    6.27 +  mkdir build
    6.28 +  cd build
    6.29 +  cmake ..
    6.30 +  make
    6.31  
    6.32 -If you want to verify your build, you may then run
    6.33 +Optionally install UCX by running the following command as privileged user
    6.34 +
    6.35 +  make install
    6.36 +
    6.37 +If you want to verify your build, you can run
    6.38  
    6.39    make check
    6.40  
    6.41 -3. Install
    6.42 -----------
    6.43  
    6.44 -Build the binaries as described above. Then install UCX, by running
    6.45 -
    6.46 -  make install
    6.47 -
    6.48 -or
    6.49 -
    6.50 -  make install PREFIX=<install_dir>
    6.51 -
    6.52 -The default prefix is /usr/local and will require privileged access.
    6.53 -
    6.54 -4. Documentation
    6.55 +3. Documentation
    6.56  ----------------
    6.57  
    6.58  Documentation is available at:
    6.59 @@ -60,16 +54,17 @@
    6.60    https://develop.uap-core.de/ucx/api/index.html
    6.61  
    6.62  
    6.63 -5. Contact
    6.64 +4. Contact
    6.65  ----------
    6.66  
    6.67    Olaf Wintermann    (olaf.wintermann@gmail.com)
    6.68    Mike Becker        (universe@uap-core.de)
    6.69  
    6.70 -6. License
    6.71 +
    6.72 +5. License
    6.73  ----------
    6.74  
    6.75 -Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
    6.76 +Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
    6.77  
    6.78  Redistribution and use in source and binary forms, with or without
    6.79  modification, are permitted provided that the following conditions are met:

     7.1 --- a/autogen.sh	Mon Dec 30 09:54:10 2019 +0100
     7.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     7.3 @@ -1,3 +0,0 @@
     7.4 -#!/bin/sh
     7.5 -autoreconf --install
     7.6 -

     8.1 --- a/cmake_infile.doxygen	Mon Dec 30 09:54:10 2019 +0100
     8.2 +++ b/cmake_infile.doxygen	Sat Feb 06 19:11:44 2021 +0100
     8.3 @@ -230,12 +230,6 @@
     8.4  
     8.5  ALIASES                =
     8.6  
     8.7 -# This tag can be used to specify a number of word-keyword mappings (TCL only).
     8.8 -# A mapping has the form "name=value". For example adding "class=itcl::class"
     8.9 -# will allow you to use the command class in the itcl::class meaning.
    8.10 -
    8.11 -TCL_SUBST              =
    8.12 -
    8.13  # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    8.14  # only. Doxygen will then generate output that is more tailored for C. For
    8.15  # instance, some of the names that are used will be different. The list of all
    8.16 @@ -989,13 +983,6 @@
    8.17  
    8.18  ALPHABETICAL_INDEX     = YES
    8.19  
    8.20 -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
    8.21 -# which the alphabetical index list will be split.
    8.22 -# Minimum value: 1, maximum value: 20, default value: 5.
    8.23 -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    8.24 -
    8.25 -COLS_IN_ALPHA_INDEX    = 5
    8.26 -
    8.27  # In case all classes in a project start with a common prefix, all classes will
    8.28  # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
    8.29  # can be used to specify a prefix (or a list of prefixes) that should be ignored
    8.30 @@ -2008,12 +1995,6 @@
    8.31  
    8.32  EXTERNAL_PAGES         = YES
    8.33  
    8.34 -# The PERL_PATH should be the absolute path and name of the perl script
    8.35 -# interpreter (i.e. the result of 'which perl').
    8.36 -# The default file (with absolute path) is: /usr/bin/perl.
    8.37 -
    8.38 -PERL_PATH              = /usr/bin/perl
    8.39 -
    8.40  #---------------------------------------------------------------------------
    8.41  # Configuration options related to the dot tool
    8.42  #---------------------------------------------------------------------------
    8.43 @@ -2027,15 +2008,6 @@
    8.44  
    8.45  CLASS_DIAGRAMS         = YES
    8.46  
    8.47 -# You can define message sequence charts within doxygen comments using the \msc
    8.48 -# command. Doxygen will then run the mscgen tool (see:
    8.49 -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
    8.50 -# documentation. The MSCGEN_PATH tag allows you to specify the directory where
    8.51 -# the mscgen tool resides. If left empty the tool is assumed to be found in the
    8.52 -# default search path.
    8.53 -
    8.54 -MSCGEN_PATH            =
    8.55 -
    8.56  # You can include diagrams made with dia in doxygen documentation. Doxygen will
    8.57  # then run dia to produce the diagram and insert it in the documentation. The
    8.58  # DIA_PATH tag allows you to specify the directory where the dia binary resides.

     9.1 --- a/configure.ac	Mon Dec 30 09:54:10 2019 +0100
     9.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     9.3 @@ -1,64 +0,0 @@
     9.4 -#
     9.5 -# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     9.6 -#
     9.7 -# Copyright 2019 Mike Becker, Olaf Wintermann All rights reserved.
     9.8 -#
     9.9 -# Redistribution and use in source and binary forms, with or without
    9.10 -# modification, are permitted provided that the following conditions are met:
    9.11 -#
    9.12 -#   1. Redistributions of source code must retain the above copyright
    9.13 -#      notice, this list of conditions and the following disclaimer.
    9.14 -#
    9.15 -#   2. Redistributions in binary form must reproduce the above copyright
    9.16 -#      notice, this list of conditions and the following disclaimer in the
    9.17 -#      documentation and/or other materials provided with the distribution.
    9.18 -#
    9.19 -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    9.20 -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    9.21 -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    9.22 -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    9.23 -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    9.24 -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    9.25 -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    9.26 -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    9.27 -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    9.28 -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    9.29 -# POSSIBILITY OF SUCH DAMAGE.
    9.30 -#
    9.31 -
    9.32 -# the package version must match the macros in ucx.h
    9.33 -# the lib version must follow the libtool versioning convention
    9.34 -AC_PREREQ([2.60])
    9.35 -AC_INIT([ucx], [2.1.0], [olaf.wintermann@gmail.com])
    9.36 -AC_SUBST([UCX_LIB_VERSION], [4:0:1])
    9.37 -
    9.38 -# don't place everything in the project root
    9.39 -AC_CONFIG_AUX_DIR([build-aux])
    9.40 -AC_CONFIG_MACRO_DIR([m4])
    9.41 -
    9.42 -# we use our own directory structure
    9.43 -AM_INIT_AUTOMAKE([foreign -Wall -Werror])
    9.44 -
    9.45 -# if there is an archiver, use it
    9.46 -m4_ifdef([AM_PROG_AR], [AM_PROG_AR])
    9.47 -
    9.48 -# we are compiling a library
    9.49 -LT_INIT
    9.50 -
    9.51 -# we want c11, and may fall back to c99
    9.52 -AC_PROG_CC_C99
    9.53 -
    9.54 -# we want to support automake < 1.14, so we need this deprecated macro
    9.55 -# it tests, whether the compiler allows -c and -o simultaneously
    9.56 -# in modern versions of autoconf, this is done by AC_PROG_CC
    9.57 -AM_PROG_CC_C_O
    9.58 -
    9.59 -# where to place config macros
    9.60 -AC_CONFIG_HEADERS([config.h])
    9.61 -
    9.62 -# our Makefiles
    9.63 -AC_CONFIG_FILES([Makefile src/Makefile test/Makefile])
    9.64 -
    9.65 -# GO
    9.66 -AC_OUTPUT
    9.67 -

    10.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
    10.2 +++ b/docs/api-2.1/allocator_8h.html	Sat Feb 06 19:11:44 2021 +0100
    10.3 @@ -0,0 +1,600 @@
    10.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    10.5 +<html xmlns="http://www.w3.org/1999/xhtml">
    10.6 +<head>
    10.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    10.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
    10.9 +<meta name="generator" content="Doxygen 1.8.13"/>
   10.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
   10.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/allocator.h File Reference</title>
   10.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
   10.13 +<script type="text/javascript" src="jquery.js"></script>
   10.14 +<script type="text/javascript" src="dynsections.js"></script>
   10.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
   10.16 +<script type="text/javascript" src="search/searchdata.js"></script>
   10.17 +<script type="text/javascript" src="search/search.js"></script>
   10.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
   10.19 +</head>
   10.20 +<body>
   10.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
   10.22 +<div id="titlearea">
   10.23 +<table cellspacing="0" cellpadding="0">
   10.24 + <tbody>
   10.25 + <tr style="height: 56px;">
   10.26 +  <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
   10.27 +  <td id="projectalign" style="padding-left: 0.5em;">
   10.28 +   <div id="projectname">ucx
   10.29 +   </div>
   10.30 +   <div id="projectbrief">UAP Common Extensions</div>
   10.31 +  </td>
   10.32 + </tr>
   10.33 + </tbody>
   10.34 +</table>
   10.35 +</div>
   10.36 +<!-- end header part -->
   10.37 +<!-- Generated by Doxygen 1.8.13 -->
   10.38 +<script type="text/javascript">
   10.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
   10.40 +</script>
   10.41 +<script type="text/javascript" src="menudata.js"></script>
   10.42 +<script type="text/javascript" src="menu.js"></script>
   10.43 +<script type="text/javascript">
   10.44 +$(function() {
   10.45 +  initMenu('',true,false,'search.php','Search');
   10.46 +  $(document).ready(function() { init_search(); });
   10.47 +});
   10.48 +</script>
   10.49 +<div id="main-nav"></div>
   10.50 +<!-- window showing the filter options -->
   10.51 +<div id="MSearchSelectWindow"
   10.52 +     onmouseover="return searchBox.OnSearchSelectShow()"
   10.53 +     onmouseout="return searchBox.OnSearchSelectHide()"
   10.54 +     onkeydown="return searchBox.OnSearchSelectKey(event)">
   10.55 +</div>
   10.56 +
   10.57 +<!-- iframe showing the search results (closed by default) -->
   10.58 +<div id="MSearchResultsWindow">
   10.59 +<iframe src="javascript:void(0)" frameborder="0" 
   10.60 +        name="MSearchResults" id="MSearchResults">
   10.61 +</iframe>
   10.62 +</div>
   10.63 +
   10.64 +<div id="nav-path" class="navpath">
   10.65 +  <ul>
   10.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>
   10.67 +</div>
   10.68 +</div><!-- top -->
   10.69 +<div class="header">
   10.70 +  <div class="summary">
   10.71 +<a href="#nested-classes">Data Structures</a> &#124;
   10.72 +<a href="#define-members">Macros</a> &#124;
   10.73 +<a href="#typedef-members">Typedefs</a> &#124;
   10.74 +<a href="#func-members">Functions</a>  </div>
   10.75 +  <div class="headertitle">
   10.76 +<div class="title">allocator.h File Reference</div>  </div>
   10.77 +</div><!--header-->
   10.78 +<div class="contents">
   10.79 +
   10.80 +<p>Allocator for custom memory management.  
   10.81 +<a href="#details">More...</a></p>
   10.82 +<div class="textblock"><code>#include &quot;<a class="el" href="ucx_8h_source.html">ucx.h</a>&quot;</code><br />
   10.83 +</div>
   10.84 +<p><a href="allocator_8h_source.html">Go to the source code of this file.</a></p>
   10.85 +<table class="memberdecls">
   10.86 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
   10.87 +Data Structures</h2></td></tr>
   10.88 +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxAllocator.html">UcxAllocator</a></td></tr>
   10.89 +<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">UCX allocator data structure containing memory management functions.  <a href="structUcxAllocator.html#details">More...</a><br /></td></tr>
   10.90 +<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
   10.91 +</table><table class="memberdecls">
   10.92 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
   10.93 +Macros</h2></td></tr>
   10.94 +<tr class="memitem:ae1bc218fea8a35f4a3706f0beefcfb19"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#ae1bc218fea8a35f4a3706f0beefcfb19">almalloc</a>(allocator,  n)&#160;&#160;&#160;((allocator)-&gt;malloc((allocator)-&gt;pool, n))</td></tr>
   10.95 +<tr class="memdesc:ae1bc218fea8a35f4a3706f0beefcfb19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shorthand for calling an allocators malloc function.  <a href="#ae1bc218fea8a35f4a3706f0beefcfb19">More...</a><br /></td></tr>
   10.96 +<tr class="separator:ae1bc218fea8a35f4a3706f0beefcfb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
   10.97 +<tr class="memitem:a8d71470816f88f78cb9a9686c57e1b10"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a8d71470816f88f78cb9a9686c57e1b10">alcalloc</a>(allocator,  n,  size)&#160;&#160;&#160;((allocator)-&gt;calloc((allocator)-&gt;pool, n, size))</td></tr>
   10.98 +<tr class="memdesc:a8d71470816f88f78cb9a9686c57e1b10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shorthand for calling an allocators calloc function.  <a href="#a8d71470816f88f78cb9a9686c57e1b10">More...</a><br /></td></tr>
   10.99 +<tr class="separator:a8d71470816f88f78cb9a9686c57e1b10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.100 +<tr class="memitem:a029ee5c9bcbb3f873571553f788c5820"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a029ee5c9bcbb3f873571553f788c5820">alrealloc</a>(allocator,  ptr,  n)&#160;&#160;&#160;((allocator)-&gt;realloc((allocator)-&gt;pool, ptr, n))</td></tr>
  10.101 +<tr class="memdesc:a029ee5c9bcbb3f873571553f788c5820"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shorthand for calling an allocators realloc function.  <a href="#a029ee5c9bcbb3f873571553f788c5820">More...</a><br /></td></tr>
  10.102 +<tr class="separator:a029ee5c9bcbb3f873571553f788c5820"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.103 +<tr class="memitem:acd775785b54e97dc2b33a432c12c8fb2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#acd775785b54e97dc2b33a432c12c8fb2">alfree</a>(allocator,  ptr)&#160;&#160;&#160;((allocator)-&gt;free((allocator)-&gt;pool, ptr))</td></tr>
  10.104 +<tr class="memdesc:acd775785b54e97dc2b33a432c12c8fb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shorthand for calling an allocators free function.  <a href="#acd775785b54e97dc2b33a432c12c8fb2">More...</a><br /></td></tr>
  10.105 +<tr class="separator:acd775785b54e97dc2b33a432c12c8fb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.106 +<tr class="memitem:a1283a8f875f90a7af3aba5e031fc2e3f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f">UCX_ALLOCATOR_DEFAULT</a></td></tr>
  10.107 +<tr class="memdesc:a1283a8f875f90a7af3aba5e031fc2e3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenient macro for a default allocator <code>struct</code> definition.  <a href="#a1283a8f875f90a7af3aba5e031fc2e3f">More...</a><br /></td></tr>
  10.108 +<tr class="separator:a1283a8f875f90a7af3aba5e031fc2e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.109 +</table><table class="memberdecls">
  10.110 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  10.111 +Typedefs</h2></td></tr>
  10.112 +<tr class="memitem:a29f0f6a23a70db3b60635cd6dc384473"><td class="memItemLeft" align="right" valign="top">typedef void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a29f0f6a23a70db3b60635cd6dc384473">ucx_allocator_malloc</a>) (void *pool, size_t n)</td></tr>
  10.113 +<tr class="memdesc:a29f0f6a23a70db3b60635cd6dc384473"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to the allocators <code>malloc()</code> function.  <a href="#a29f0f6a23a70db3b60635cd6dc384473">More...</a><br /></td></tr>
  10.114 +<tr class="separator:a29f0f6a23a70db3b60635cd6dc384473"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.115 +<tr class="memitem:a2c0aba4221c1ac6801f03ed799f15b12"><td class="memItemLeft" align="right" valign="top">typedef void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a2c0aba4221c1ac6801f03ed799f15b12">ucx_allocator_calloc</a>) (void *pool, size_t n, size_t size)</td></tr>
  10.116 +<tr class="memdesc:a2c0aba4221c1ac6801f03ed799f15b12"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to the allocators <code>calloc()</code> function.  <a href="#a2c0aba4221c1ac6801f03ed799f15b12">More...</a><br /></td></tr>
  10.117 +<tr class="separator:a2c0aba4221c1ac6801f03ed799f15b12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.118 +<tr class="memitem:a6d7cf038a806e327c5da37321d04e426"><td class="memItemLeft" align="right" valign="top">typedef void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a6d7cf038a806e327c5da37321d04e426">ucx_allocator_realloc</a>) (void *pool, void *data, size_t n)</td></tr>
  10.119 +<tr class="memdesc:a6d7cf038a806e327c5da37321d04e426"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to the allocators <code>realloc()</code> function.  <a href="#a6d7cf038a806e327c5da37321d04e426">More...</a><br /></td></tr>
  10.120 +<tr class="separator:a6d7cf038a806e327c5da37321d04e426"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.121 +<tr class="memitem:aaf2387ddaddd8ab4b267e6b00e5d6f7e"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#aaf2387ddaddd8ab4b267e6b00e5d6f7e">ucx_allocator_free</a>) (void *pool, void *data)</td></tr>
  10.122 +<tr class="memdesc:aaf2387ddaddd8ab4b267e6b00e5d6f7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to the allocators <code>free()</code> function.  <a href="#aaf2387ddaddd8ab4b267e6b00e5d6f7e">More...</a><br /></td></tr>
  10.123 +<tr class="separator:aaf2387ddaddd8ab4b267e6b00e5d6f7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.124 +</table><table class="memberdecls">
  10.125 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  10.126 +Functions</h2></td></tr>
  10.127 +<tr class="memitem:a98d2f1b341118b7a0e341fda5d8b2ebf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a> ()</td></tr>
  10.128 +<tr class="memdesc:a98d2f1b341118b7a0e341fda5d8b2ebf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the default allocator.  <a href="#a98d2f1b341118b7a0e341fda5d8b2ebf">More...</a><br /></td></tr>
  10.129 +<tr class="separator:a98d2f1b341118b7a0e341fda5d8b2ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.130 +<tr class="memitem:a96403ebf3d2312d95f2fe7627a1cdbc0"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a96403ebf3d2312d95f2fe7627a1cdbc0">ucx_default_malloc</a> (void *ignore, size_t n)</td></tr>
  10.131 +<tr class="memdesc:a96403ebf3d2312d95f2fe7627a1cdbc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper for the standard libc <code>malloc()</code> function.  <a href="#a96403ebf3d2312d95f2fe7627a1cdbc0">More...</a><br /></td></tr>
  10.132 +<tr class="separator:a96403ebf3d2312d95f2fe7627a1cdbc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.133 +<tr class="memitem:a3a0bfdd13d887012309c459b339f338f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a> (void *ignore, size_t n, size_t size)</td></tr>
  10.134 +<tr class="memdesc:a3a0bfdd13d887012309c459b339f338f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper for the standard libc <code>calloc()</code> function.  <a href="#a3a0bfdd13d887012309c459b339f338f">More...</a><br /></td></tr>
  10.135 +<tr class="separator:a3a0bfdd13d887012309c459b339f338f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.136 +<tr class="memitem:a47cfc8af626a86fcb93a2b14b90498ed"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a> (void *ignore, void *data, size_t n)</td></tr>
  10.137 +<tr class="memdesc:a47cfc8af626a86fcb93a2b14b90498ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper for the standard libc <code>realloc()</code> function.  <a href="#a47cfc8af626a86fcb93a2b14b90498ed">More...</a><br /></td></tr>
  10.138 +<tr class="separator:a47cfc8af626a86fcb93a2b14b90498ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.139 +<tr class="memitem:a646d83aaaadfe33ae414c0fad8bfc52a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a646d83aaaadfe33ae414c0fad8bfc52a">ucx_default_free</a> (void *ignore, void *data)</td></tr>
  10.140 +<tr class="memdesc:a646d83aaaadfe33ae414c0fad8bfc52a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper for the standard libc <code>free()</code> function.  <a href="#a646d83aaaadfe33ae414c0fad8bfc52a">More...</a><br /></td></tr>
  10.141 +<tr class="separator:a646d83aaaadfe33ae414c0fad8bfc52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  10.142 +</table>
  10.143 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  10.144 +<div class="textblock"><p>Allocator for custom memory management. </p>
  10.145 +<p>A UCX allocator consists of a pointer to the memory area / pool and four function pointers to memory management functions operating on this memory area / pool. These functions shall behave equivalent to the standard libc functions <code>malloc(), calloc(), realloc()</code> and <code>free()</code>.</p>
  10.146 +<p>The signature of the memory management functions is based on the signature of the respective libc function but each of them takes the pointer to the memory area / pool as first argument.</p>
  10.147 +<p>As the pointer to the memory area / pool can be arbitrarily chosen, any data can be provided to the memory management functions. A <a class="el" href="structUcxMempool.html" title="UCX mempool structure. ">UcxMempool</a> is just one example.</p>
  10.148 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="mempool_8h.html" title="Memory pool implementation. ">mempool.h</a> </dd>
  10.149 +<dd>
  10.150 +<a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a></dd></dl>
  10.151 +<dl class="section author"><dt>Author</dt><dd>Mike Becker </dd>
  10.152 +<dd>
  10.153 +Olaf Wintermann </dd></dl>
  10.154 +</div><h2 class="groupheader">Macro Definition Documentation</h2>
  10.155 +<a id="a8d71470816f88f78cb9a9686c57e1b10"></a>
  10.156 +<h2 class="memtitle"><span class="permalink"><a href="#a8d71470816f88f78cb9a9686c57e1b10">&#9670;&nbsp;</a></span>alcalloc</h2>
  10.157 +
  10.158 +<div class="memitem">
  10.159 +<div class="memproto">
  10.160 +      <table class="memname">
  10.161 +        <tr>
  10.162 +          <td class="memname">#define alcalloc</td>
  10.163 +          <td>(</td>
  10.164 +          <td class="paramtype">&#160;</td>
  10.165 +          <td class="paramname">allocator, </td>
  10.166 +        </tr>
  10.167 +        <tr>
  10.168 +          <td class="paramkey"></td>
  10.169 +          <td></td>
  10.170 +          <td class="paramtype">&#160;</td>
  10.171 +          <td class="paramname">n, </td>
  10.172 +        </tr>
  10.173 +        <tr>
  10.174 +          <td class="paramkey"></td>
  10.175 +          <td></td>
  10.176 +          <td class="paramtype">&#160;</td>
  10.177 +          <td class="paramname">size&#160;</td>
  10.178 +        </tr>
  10.179 +        <tr>
  10.180 +          <td></td>
  10.181 +          <td>)</td>
  10.182 +          <td></td><td>&#160;&#160;&#160;((allocator)-&gt;calloc((allocator)-&gt;pool, n, size))</td>
  10.183 +        </tr>
  10.184 +      </table>
  10.185 +</div><div class="memdoc">
  10.186 +
  10.187 +<p>Shorthand for calling an allocators calloc function. </p>
  10.188 +<dl class="params"><dt>Parameters</dt><dd>
  10.189 +  <table class="params">
  10.190 +    <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
  10.191 +    <tr><td class="paramname">n</td><td>the count of elements the space should be allocated for </td></tr>
  10.192 +    <tr><td class="paramname">size</td><td>the size of each element </td></tr>
  10.193 +  </table>
  10.194 +  </dd>
  10.195 +</dl>
  10.196 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory area </dd></dl>
  10.197 +
  10.198 +</div>
  10.199 +</div>
  10.200 +<a id="acd775785b54e97dc2b33a432c12c8fb2"></a>
  10.201 +<h2 class="memtitle"><span class="permalink"><a href="#acd775785b54e97dc2b33a432c12c8fb2">&#9670;&nbsp;</a></span>alfree</h2>
  10.202 +
  10.203 +<div class="memitem">
  10.204 +<div class="memproto">
  10.205 +      <table class="memname">
  10.206 +        <tr>
  10.207 +          <td class="memname">#define alfree</td>
  10.208 +          <td>(</td>
  10.209 +          <td class="paramtype">&#160;</td>
  10.210 +          <td class="paramname">allocator, </td>
  10.211 +        </tr>
  10.212 +        <tr>
  10.213 +          <td class="paramkey"></td>
  10.214 +          <td></td>
  10.215 +          <td class="paramtype">&#160;</td>
  10.216 +          <td class="paramname">ptr&#160;</td>
  10.217 +        </tr>
  10.218 +        <tr>
  10.219 +          <td></td>
  10.220 +          <td>)</td>
  10.221 +          <td></td><td>&#160;&#160;&#160;((allocator)-&gt;free((allocator)-&gt;pool, ptr))</td>
  10.222 +        </tr>
  10.223 +      </table>
  10.224 +</div><div class="memdoc">
  10.225 +
  10.226 +<p>Shorthand for calling an allocators free function. </p>
  10.227 +<dl class="params"><dt>Parameters</dt><dd>
  10.228 +  <table class="params">
  10.229 +    <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
  10.230 +    <tr><td class="paramname">ptr</td><td>the pointer to the memory area that shall be freed </td></tr>
  10.231 +  </table>
  10.232 +  </dd>
  10.233 +</dl>
  10.234 +
  10.235 +</div>
  10.236 +</div>
  10.237 +<a id="ae1bc218fea8a35f4a3706f0beefcfb19"></a>
  10.238 +<h2 class="memtitle"><span class="permalink"><a href="#ae1bc218fea8a35f4a3706f0beefcfb19">&#9670;&nbsp;</a></span>almalloc</h2>
  10.239 +
  10.240 +<div class="memitem">
  10.241 +<div class="memproto">
  10.242 +      <table class="memname">
  10.243 +        <tr>
  10.244 +          <td class="memname">#define almalloc</td>
  10.245 +          <td>(</td>
  10.246 +          <td class="paramtype">&#160;</td>
  10.247 +          <td class="paramname">allocator, </td>
  10.248 +        </tr>
  10.249 +        <tr>
  10.250 +          <td class="paramkey"></td>
  10.251 +          <td></td>
  10.252 +          <td class="paramtype">&#160;</td>
  10.253 +          <td class="paramname">n&#160;</td>
  10.254 +        </tr>
  10.255 +        <tr>
  10.256 +          <td></td>
  10.257 +          <td>)</td>
  10.258 +          <td></td><td>&#160;&#160;&#160;((allocator)-&gt;malloc((allocator)-&gt;pool, n))</td>
  10.259 +        </tr>
  10.260 +      </table>
  10.261 +</div><div class="memdoc">
  10.262 +
  10.263 +<p>Shorthand for calling an allocators malloc function. </p>
  10.264 +<dl class="params"><dt>Parameters</dt><dd>
  10.265 +  <table class="params">
  10.266 +    <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
  10.267 +    <tr><td class="paramname">n</td><td>size of space to allocate </td></tr>
  10.268 +  </table>
  10.269 +  </dd>
  10.270 +</dl>
  10.271 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory area </dd></dl>
  10.272 +
  10.273 +</div>
  10.274 +</div>
  10.275 +<a id="a029ee5c9bcbb3f873571553f788c5820"></a>
  10.276 +<h2 class="memtitle"><span class="permalink"><a href="#a029ee5c9bcbb3f873571553f788c5820">&#9670;&nbsp;</a></span>alrealloc</h2>
  10.277 +
  10.278 +<div class="memitem">
  10.279 +<div class="memproto">
  10.280 +      <table class="memname">
  10.281 +        <tr>
  10.282 +          <td class="memname">#define alrealloc</td>
  10.283 +          <td>(</td>
  10.284 +          <td class="paramtype">&#160;</td>
  10.285 +          <td class="paramname">allocator, </td>
  10.286 +        </tr>
  10.287 +        <tr>
  10.288 +          <td class="paramkey"></td>
  10.289 +          <td></td>
  10.290 +          <td class="paramtype">&#160;</td>
  10.291 +          <td class="paramname">ptr, </td>
  10.292 +        </tr>
  10.293 +        <tr>
  10.294 +          <td class="paramkey"></td>
  10.295 +          <td></td>
  10.296 +          <td class="paramtype">&#160;</td>
  10.297 +          <td class="paramname">n&#160;</td>
  10.298 +        </tr>
  10.299 +        <tr>
  10.300 +          <td></td>
  10.301 +          <td>)</td>
  10.302 +          <td></td><td>&#160;&#160;&#160;((allocator)-&gt;realloc((allocator)-&gt;pool, ptr, n))</td>
  10.303 +        </tr>
  10.304 +      </table>
  10.305 +</div><div class="memdoc">
  10.306 +
  10.307 +<p>Shorthand for calling an allocators realloc function. </p>
  10.308 +<dl class="params"><dt>Parameters</dt><dd>
  10.309 +  <table class="params">
  10.310 +    <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
  10.311 +    <tr><td class="paramname">ptr</td><td>the pointer to the memory area that shall be reallocated </td></tr>
  10.312 +    <tr><td class="paramname">n</td><td>the new size of the allocated memory area </td></tr>
  10.313 +  </table>
  10.314 +  </dd>
  10.315 +</dl>
  10.316 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the reallocated memory area </dd></dl>
  10.317 +
  10.318 +</div>
  10.319 +</div>
  10.320 +<a id="a1283a8f875f90a7af3aba5e031fc2e3f"></a>
  10.321 +<h2 class="memtitle"><span class="permalink"><a href="#a1283a8f875f90a7af3aba5e031fc2e3f">&#9670;&nbsp;</a></span>UCX_ALLOCATOR_DEFAULT</h2>
  10.322 +
  10.323 +<div class="memitem">
  10.324 +<div class="memproto">
  10.325 +      <table class="memname">
  10.326 +        <tr>
  10.327 +          <td class="memname">#define UCX_ALLOCATOR_DEFAULT</td>
  10.328 +        </tr>
  10.329 +      </table>
  10.330 +</div><div class="memdoc">
  10.331 +<b>Value:</b><div class="fragment"><div class="line">{NULL, \</div><div class="line">        ucx_default_malloc, <a class="code" href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a>, <a class="code" href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a>, \</div><div class="line">        ucx_default_free }</div><div class="ttc" id="allocator_8h_html_a3a0bfdd13d887012309c459b339f338f"><div class="ttname"><a href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a></div><div class="ttdeci">void * ucx_default_calloc(void *ignore, size_t n, size_t size)</div><div class="ttdoc">A wrapper for the standard libc calloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:50</div></div>
  10.332 +<div class="ttc" id="allocator_8h_html_a47cfc8af626a86fcb93a2b14b90498ed"><div class="ttname"><a href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a></div><div class="ttdeci">void * ucx_default_realloc(void *ignore, void *data, size_t n)</div><div class="ttdoc">A wrapper for the standard libc realloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:54</div></div>
  10.333 +</div><!-- fragment -->
  10.334 +<p>Convenient macro for a default allocator <code>struct</code> definition. </p>
  10.335 +
  10.336 +</div>
  10.337 +</div>
  10.338 +<h2 class="groupheader">Typedef Documentation</h2>
  10.339 +<a id="a2c0aba4221c1ac6801f03ed799f15b12"></a>
  10.340 +<h2 class="memtitle"><span class="permalink"><a href="#a2c0aba4221c1ac6801f03ed799f15b12">&#9670;&nbsp;</a></span>ucx_allocator_calloc</h2>
  10.341 +
  10.342 +<div class="memitem">
  10.343 +<div class="memproto">
  10.344 +      <table class="memname">
  10.345 +        <tr>
  10.346 +          <td class="memname">typedef void*(* ucx_allocator_calloc) (void *pool, size_t n, size_t size)</td>
  10.347 +        </tr>
  10.348 +      </table>
  10.349 +</div><div class="memdoc">
  10.350 +
  10.351 +<p>A function pointer to the allocators <code>calloc()</code> function. </p>
  10.352 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
  10.353 +
  10.354 +</div>
  10.355 +</div>
  10.356 +<a id="aaf2387ddaddd8ab4b267e6b00e5d6f7e"></a>
  10.357 +<h2 class="memtitle"><span class="permalink"><a href="#aaf2387ddaddd8ab4b267e6b00e5d6f7e">&#9670;&nbsp;</a></span>ucx_allocator_free</h2>
  10.358 +
  10.359 +<div class="memitem">
  10.360 +<div class="memproto">
  10.361 +      <table class="memname">
  10.362 +        <tr>
  10.363 +          <td class="memname">typedef void(* ucx_allocator_free) (void *pool, void *data)</td>
  10.364 +        </tr>
  10.365 +      </table>
  10.366 +</div><div class="memdoc">
  10.367 +
  10.368 +<p>A function pointer to the allocators <code>free()</code> function. </p>
  10.369 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
  10.370 +
  10.371 +</div>
  10.372 +</div>
  10.373 +<a id="a29f0f6a23a70db3b60635cd6dc384473"></a>
  10.374 +<h2 class="memtitle"><span class="permalink"><a href="#a29f0f6a23a70db3b60635cd6dc384473">&#9670;&nbsp;</a></span>ucx_allocator_malloc</h2>
  10.375 +
  10.376 +<div class="memitem">
  10.377 +<div class="memproto">
  10.378 +      <table class="memname">
  10.379 +        <tr>
  10.380 +          <td class="memname">typedef void*(* ucx_allocator_malloc) (void *pool, size_t n)</td>
  10.381 +        </tr>
  10.382 +      </table>
  10.383 +</div><div class="memdoc">
  10.384 +
  10.385 +<p>A function pointer to the allocators <code>malloc()</code> function. </p>
  10.386 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
  10.387 +
  10.388 +</div>
  10.389 +</div>
  10.390 +<a id="a6d7cf038a806e327c5da37321d04e426"></a>
  10.391 +<h2 class="memtitle"><span class="permalink"><a href="#a6d7cf038a806e327c5da37321d04e426">&#9670;&nbsp;</a></span>ucx_allocator_realloc</h2>
  10.392 +
  10.393 +<div class="memitem">
  10.394 +<div class="memproto">
  10.395 +      <table class="memname">
  10.396 +        <tr>
  10.397 +          <td class="memname">typedef void*(* ucx_allocator_realloc) (void *pool, void *data, size_t n)</td>
  10.398 +        </tr>
  10.399 +      </table>
  10.400 +</div><div class="memdoc">
  10.401 +
  10.402 +<p>A function pointer to the allocators <code>realloc()</code> function. </p>
  10.403 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
  10.404 +
  10.405 +</div>
  10.406 +</div>
  10.407 +<h2 class="groupheader">Function Documentation</h2>
  10.408 +<a id="a98d2f1b341118b7a0e341fda5d8b2ebf"></a>
  10.409 +<h2 class="memtitle"><span class="permalink"><a href="#a98d2f1b341118b7a0e341fda5d8b2ebf">&#9670;&nbsp;</a></span>ucx_default_allocator()</h2>
  10.410 +
  10.411 +<div class="memitem">
  10.412 +<div class="memproto">
  10.413 +      <table class="memname">
  10.414 +        <tr>
  10.415 +          <td class="memname"><a class="el" href="structUcxAllocator.html">UcxAllocator</a>* ucx_default_allocator </td>
  10.416 +          <td>(</td>
  10.417 +          <td class="paramname"></td><td>)</td>
  10.418 +          <td></td>
  10.419 +        </tr>
  10.420 +      </table>
  10.421 +</div><div class="memdoc">
  10.422 +
  10.423 +<p>Returns a pointer to the default allocator. </p>
  10.424 +<p>The default allocator contains wrappers to the standard libc memory management functions. Use this function to get a pointer to a globally available allocator. You may also define an own <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> by assigning <a class="el" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f" title="Convenient macro for a default allocator struct definition. ">UCX_ALLOCATOR_DEFAULT</a> to a variable and pass the address of this variable to any function that takes a <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> as argument. Note that using this function is the recommended way of passing a default allocator, thus it never runs out of scope.</p>
  10.425 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the default allocator</dd></dl>
  10.426 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f" title="Convenient macro for a default allocator struct definition. ">UCX_ALLOCATOR_DEFAULT</a> </dd></dl>
  10.427 +
  10.428 +</div>
  10.429 +</div>
  10.430 +<a id="a3a0bfdd13d887012309c459b339f338f"></a>
  10.431 +<h2 class="memtitle"><span class="permalink"><a href="#a3a0bfdd13d887012309c459b339f338f">&#9670;&nbsp;</a></span>ucx_default_calloc()</h2>
  10.432 +
  10.433 +<div class="memitem">
  10.434 +<div class="memproto">
  10.435 +      <table class="memname">
  10.436 +        <tr>
  10.437 +          <td class="memname">void* ucx_default_calloc </td>
  10.438 +          <td>(</td>
  10.439 +          <td class="paramtype">void *&#160;</td>
  10.440 +          <td class="paramname"><em>ignore</em>, </td>
  10.441 +        </tr>
  10.442 +        <tr>
  10.443 +          <td class="paramkey"></td>
  10.444 +          <td></td>
  10.445 +          <td class="paramtype">size_t&#160;</td>
  10.446 +          <td class="paramname"><em>n</em>, </td>
  10.447 +        </tr>
  10.448 +        <tr>
  10.449 +          <td class="paramkey"></td>
  10.450 +          <td></td>
  10.451 +          <td class="paramtype">size_t&#160;</td>
  10.452 +          <td class="paramname"><em>size</em>&#160;</td>
  10.453 +        </tr>
  10.454 +        <tr>
  10.455 +          <td></td>
  10.456 +          <td>)</td>
  10.457 +          <td></td><td></td>
  10.458 +        </tr>
  10.459 +      </table>
  10.460 +</div><div class="memdoc">
  10.461 +
  10.462 +<p>A wrapper for the standard libc <code>calloc()</code> function. </p>
  10.463 +<dl class="params"><dt>Parameters</dt><dd>
  10.464 +  <table class="params">
  10.465 +    <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
  10.466 +    <tr><td class="paramname">n</td><td>argument passed to <code>calloc()</code> </td></tr>
  10.467 +    <tr><td class="paramname">size</td><td>argument passed to <code>calloc()</code> </td></tr>
  10.468 +  </table>
  10.469 +  </dd>
  10.470 +</dl>
  10.471 +<dl class="section return"><dt>Returns</dt><dd>return value of <code>calloc()</code> </dd></dl>
  10.472 +
  10.473 +</div>
  10.474 +</div>
  10.475 +<a id="a646d83aaaadfe33ae414c0fad8bfc52a"></a>
  10.476 +<h2 class="memtitle"><span class="permalink"><a href="#a646d83aaaadfe33ae414c0fad8bfc52a">&#9670;&nbsp;</a></span>ucx_default_free()</h2>
  10.477 +
  10.478 +<div class="memitem">
  10.479 +<div class="memproto">
  10.480 +      <table class="memname">
  10.481 +        <tr>
  10.482 +          <td class="memname">void ucx_default_free </td>
  10.483 +          <td>(</td>
  10.484 +          <td class="paramtype">void *&#160;</td>
  10.485 +          <td class="paramname"><em>ignore</em>, </td>
  10.486 +        </tr>
  10.487 +        <tr>
  10.488 +          <td class="paramkey"></td>
  10.489 +          <td></td>
  10.490 +          <td class="paramtype">void *&#160;</td>
  10.491 +          <td class="paramname"><em>data</em>&#160;</td>
  10.492 +        </tr>
  10.493 +        <tr>
  10.494 +          <td></td>
  10.495 +          <td>)</td>
  10.496 +          <td></td><td></td>
  10.497 +        </tr>
  10.498 +      </table>
  10.499 +</div><div class="memdoc">
  10.500 +
  10.501 +<p>A wrapper for the standard libc <code>free()</code> function. </p>
  10.502 +<dl class="params"><dt>Parameters</dt><dd>
  10.503 +  <table class="params">
  10.504 +    <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
  10.505 +    <tr><td class="paramname">data</td><td>argument passed to <code>free()</code> </td></tr>
  10.506 +  </table>
  10.507 +  </dd>
  10.508 +</dl>
  10.509 +
  10.510 +</div>
  10.511 +</div>
  10.512 +<a id="a96403ebf3d2312d95f2fe7627a1cdbc0"></a>
  10.513 +<h2 class="memtitle"><span class="permalink"><a href="#a96403ebf3d2312d95f2fe7627a1cdbc0">&#9670;&nbsp;</a></span>ucx_default_malloc()</h2>
  10.514 +
  10.515 +<div class="memitem">
  10.516 +<div class="memproto">
  10.517 +      <table class="memname">
  10.518 +        <tr>
  10.519 +          <td class="memname">void* ucx_default_malloc </td>
  10.520 +          <td>(</td>
  10.521 +          <td class="paramtype">void *&#160;</td>
  10.522 +          <td class="paramname"><em>ignore</em>, </td>
  10.523 +        </tr>
  10.524 +        <tr>
  10.525 +          <td class="paramkey"></td>
  10.526 +          <td></td>
  10.527 +          <td class="paramtype">size_t&#160;</td>
  10.528 +          <td class="paramname"><em>n</em>&#160;</td>
  10.529 +        </tr>
  10.530 +        <tr>
  10.531 +          <td></td>
  10.532 +          <td>)</td>
  10.533 +          <td></td><td></td>
  10.534 +        </tr>
  10.535 +      </table>
  10.536 +</div><div class="memdoc">
  10.537 +
  10.538 +<p>A wrapper for the standard libc <code>malloc()</code> function. </p>
  10.539 +<dl class="params"><dt>Parameters</dt><dd>
  10.540 +  <table class="params">
  10.541 +    <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
  10.542 +    <tr><td class="paramname">n</td><td>argument passed to <code>malloc()</code> </td></tr>
  10.543 +  </table>
  10.544 +  </dd>
  10.545 +</dl>
  10.546 +<dl class="section return"><dt>Returns</dt><dd>return value of <code>malloc()</code> </dd></dl>
  10.547 +
  10.548 +</div>
  10.549 +</div>
  10.550 +<a id="a47cfc8af626a86fcb93a2b14b90498ed"></a>
  10.551 +<h2 class="memtitle"><span class="permalink"><a href="#a47cfc8af626a86fcb93a2b14b90498ed">&#9670;&nbsp;</a></span>ucx_default_realloc()</h2>
  10.552 +
  10.553 +<div class="memitem">
  10.554 +<div class="memproto">
  10.555 +      <table class="memname">
  10.556 +        <tr>
  10.557 +          <td class="memname">void* ucx_default_realloc </td>
  10.558 +          <td>(</td>
  10.559 +          <td class="paramtype">void *&#160;</td>
  10.560 +          <td class="paramname"><em>ignore</em>, </td>
  10.561 +        </tr>
  10.562 +        <tr>
  10.563 +          <td class="paramkey"></td>
  10.564 +          <td></td>
  10.565 +          <td class="paramtype">void *&#160;</td>
  10.566 +          <td class="paramname"><em>data</em>, </td>
  10.567 +        </tr>
  10.568 +        <tr>
  10.569 +          <td class="paramkey"></td>
  10.570 +          <td></td>
  10.571 +          <td class="paramtype">size_t&#160;</td>
  10.572 +          <td class="paramname"><em>n</em>&#160;</td>
  10.573 +        </tr>
  10.574 +        <tr>
  10.575 +          <td></td>
  10.576 +          <td>)</td>
  10.577 +          <td></td><td></td>
  10.578 +        </tr>
  10.579 +      </table>
  10.580 +</div><div class="memdoc">
  10.581 +
  10.582 +<p>A wrapper for the standard libc <code>realloc()</code> function. </p>
  10.583 +<dl class="params"><dt>Parameters</dt><dd>
  10.584 +  <table class="params">
  10.585 +    <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
  10.586 +    <tr><td class="paramname">data</td><td>argumend passed to <code>realloc()</code> </td></tr>
  10.587 +    <tr><td class="paramname">n</td><td>argument passed to <code>realloc()</code> </td></tr>
  10.588 +  </table>
  10.589 +  </dd>
  10.590 +</dl>
  10.591 +<dl class="section return"><dt>Returns</dt><dd>return value of <code>realloc()</code> </dd></dl>
  10.592 +
  10.593 +</div>
  10.594 +</div>
  10.595 +</div><!-- contents -->
  10.596 +<!-- start footer part -->
  10.597 +<hr class="footer"/><address class="footer"><small>
  10.598 +Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
  10.599 +<img class="footer" src="doxygen.png" alt="doxygen"/>
  10.600 +</a> 1.8.13
  10.601 +</small></address>
  10.602 +</body>
  10.603 +</html>

    11.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
    11.2 +++ b/docs/api-2.1/allocator_8h_source.html	Sat Feb 06 19:11:44 2021 +0100
    11.3 @@ -0,0 +1,95 @@
    11.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    11.5 +<html xmlns="http://www.w3.org/1999/xhtml">
    11.6 +<head>
    11.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    11.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
    11.9 +<meta name="generator" content="Doxygen 1.8.13"/>
   11.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
   11.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/allocator.h Source File</title>
   11.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
   11.13 +<script type="text/javascript" src="jquery.js"></script>
   11.14 +<script type="text/javascript" src="dynsections.js"></script>
   11.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
   11.16 +<script type="text/javascript" src="search/searchdata.js"></script>
   11.17 +<script type="text/javascript" src="search/search.js"></script>
   11.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
   11.19 +</head>
   11.20 +<body>
   11.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
   11.22 +<div id="titlearea">
   11.23 +<table cellspacing="0" cellpadding="0">
   11.24 + <tbody>
   11.25 + <tr style="height: 56px;">
   11.26 +  <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
   11.27 +  <td id="projectalign" style="padding-left: 0.5em;">
   11.28 +   <div id="projectname">ucx
   11.29 +   </div>
   11.30 +   <div id="projectbrief">UAP Common Extensions</div>
   11.31 +  </td>
   11.32 + </tr>
   11.33 + </tbody>
   11.34 +</table>
   11.35 +</div>
   11.36 +<!-- end header part -->
   11.37 +<!-- Generated by Doxygen 1.8.13 -->
   11.38 +<script type="text/javascript">
   11.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
   11.40 +</script>
   11.41 +<script type="text/javascript" src="menudata.js"></script>
   11.42 +<script type="text/javascript" src="menu.js"></script>
   11.43 +<script type="text/javascript">
   11.44 +$(function() {
   11.45 +  initMenu('',true,false,'search.php','Search');
   11.46 +  $(document).ready(function() { init_search(); });
   11.47 +});
   11.48 +</script>
   11.49 +<div id="main-nav"></div>
   11.50 +<!-- window showing the filter options -->
   11.51 +<div id="MSearchSelectWindow"
   11.52 +     onmouseover="return searchBox.OnSearchSelectShow()"
   11.53 +     onmouseout="return searchBox.OnSearchSelectHide()"
   11.54 +     onkeydown="return searchBox.OnSearchSelectKey(event)">
   11.55 +</div>
   11.56 +
   11.57 +<!-- iframe showing the search results (closed by default) -->
   11.58 +<div id="MSearchResultsWindow">
   11.59 +<iframe src="javascript:void(0)" frameborder="0" 
   11.60 +        name="MSearchResults" id="MSearchResults">
   11.61 +</iframe>
   11.62 +</div>
   11.63 +
   11.64 +<div id="nav-path" class="navpath">
   11.65 +  <ul>
   11.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>
   11.67 +</div>
   11.68 +</div><!-- top -->
   11.69 +<div class="header">
   11.70 +  <div class="headertitle">
   11.71 +<div class="title">allocator.h</div>  </div>
   11.72 +</div><!--header-->
   11.73 +<div class="contents">
   11.74 +<a href="allocator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *   1. Redistributions of source code must retain the above copyright</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *      notice, this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *   2. Redistributions in binary form must reproduce the above copyright</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *      notice, this list of conditions and the following disclaimer in the</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *      documentation and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">#ifndef UCX_ALLOCATOR_H</span></div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#define UCX_ALLOCATOR_H</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ucx_8h.html">ucx.h</a>&quot;</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#ifdef  __cplusplus</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="allocator_8h.html#a29f0f6a23a70db3b60635cd6dc384473">   65</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>*(*ucx_allocator_malloc)(<span class="keywordtype">void</span> *pool, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="allocator_8h.html#a2c0aba4221c1ac6801f03ed799f15b12">   71</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>*(*ucx_allocator_calloc)(<span class="keywordtype">void</span> *pool, <span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="allocator_8h.html#a6d7cf038a806e327c5da37321d04e426">   77</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>*(*ucx_allocator_realloc)(<span class="keywordtype">void</span> *pool, <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="allocator_8h.html#aaf2387ddaddd8ab4b267e6b00e5d6f7e">   83</a></span>&#160;<span class="keyword">typedef</span> void(*<a class="code" href="allocator_8h.html#aaf2387ddaddd8ab4b267e6b00e5d6f7e">ucx_allocator_free</a>)(<span class="keywordtype">void</span> *pool, <span class="keywordtype">void</span> *data);</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structUcxAllocator.html">   88</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="structUcxAllocator.html#a1b78012998d1c28be86dc595f8f0aac9">   93</a></span>&#160;    <span class="keywordtype">void</span> *<a class="code" href="structUcxAllocator.html#a1b78012998d1c28be86dc595f8f0aac9">pool</a>;</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="structUcxAllocator.html#a013376172be39ed54f77c4be6898845a">   97</a></span>&#160;    <a class="code" href="allocator_8h.html#a29f0f6a23a70db3b60635cd6dc384473">ucx_allocator_malloc</a>  <a class="code" href="structUcxAllocator.html#a013376172be39ed54f77c4be6898845a">malloc</a>;</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="structUcxAllocator.html#ab94ec1cba45cc4e7d81e1588a11cbb62">  101</a></span>&#160;    <a class="code" href="allocator_8h.html#a2c0aba4221c1ac6801f03ed799f15b12">ucx_allocator_calloc</a>  <a class="code" href="structUcxAllocator.html#ab94ec1cba45cc4e7d81e1588a11cbb62">calloc</a>;</div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="structUcxAllocator.html#a3550e3847f31d9e9ce3ffcb0d3440c15">  105</a></span>&#160;    <a class="code" href="allocator_8h.html#a6d7cf038a806e327c5da37321d04e426">ucx_allocator_realloc</a> <a class="code" href="structUcxAllocator.html#a3550e3847f31d9e9ce3ffcb0d3440c15">realloc</a>;</div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="structUcxAllocator.html#aecce1840378ed53f1002190f4f87026f">  109</a></span>&#160;    <a class="code" href="allocator_8h.html#aaf2387ddaddd8ab4b267e6b00e5d6f7e">ucx_allocator_free</a>    <a class="code" href="structUcxAllocator.html#aecce1840378ed53f1002190f4f87026f">free</a>;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;} <a class="code" href="structUcxAllocator.html">UcxAllocator</a>;</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<a class="code" href="structUcxAllocator.html">UcxAllocator</a> *<a class="code" href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a>();</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="keywordtype">void</span> *<a class="code" href="allocator_8h.html#a96403ebf3d2312d95f2fe7627a1cdbc0">ucx_default_malloc</a>(<span class="keywordtype">void</span> *ignore, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="keywordtype">void</span> *<a class="code" href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a>(<span class="keywordtype">void</span> *ignore, <span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="keywordtype">void</span> *<a class="code" href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a>(<span class="keywordtype">void</span> *ignore, <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="keywordtype">void</span> <a class="code" href="allocator_8h.html#a646d83aaaadfe33ae414c0fad8bfc52a">ucx_default_free</a>(<span class="keywordtype">void</span> *ignore, <span class="keywordtype">void</span> *data);</div><div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;</div><div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="allocator_8h.html#ae1bc218fea8a35f4a3706f0beefcfb19">  165</a></span>&#160;<span class="preprocessor">#define almalloc(allocator, n) ((allocator)-&gt;malloc((allocator)-&gt;pool, n))</span></div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;</div><div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="allocator_8h.html#a8d71470816f88f78cb9a9686c57e1b10">  174</a></span>&#160;<span class="preprocessor">#define alcalloc(allocator, n, size) \</span></div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="preprocessor">        ((allocator)-&gt;calloc((allocator)-&gt;pool, n, size))</span></div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;</div><div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="allocator_8h.html#a029ee5c9bcbb3f873571553f788c5820">  184</a></span>&#160;<span class="preprocessor">#define alrealloc(allocator, ptr, n) \</span></div><div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="preprocessor">        ((allocator)-&gt;realloc((allocator)-&gt;pool, ptr, n))</span></div><div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;</div><div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="allocator_8h.html#acd775785b54e97dc2b33a432c12c8fb2">  192</a></span>&#160;<span class="preprocessor">#define alfree(allocator, ptr) ((allocator)-&gt;free((allocator)-&gt;pool, ptr))</span></div><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;</div><div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f">  197</a></span>&#160;<span class="preprocessor">#define UCX_ALLOCATOR_DEFAULT {NULL, \</span></div><div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="preprocessor">        ucx_default_malloc, ucx_default_calloc, ucx_default_realloc, \</span></div><div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="preprocessor">        ucx_default_free }</span></div><div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;</div><div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="preprocessor">#ifdef  __cplusplus</span></div><div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;}</div><div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;</div><div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="preprocessor">#endif  </span><span class="comment">/* UCX_ALLOCATOR_H */</span><span class="preprocessor"></span></div><div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;</div><div class="ttc" id="ucx_8h_html"><div class="ttname"><a href="ucx_8h.html">ucx.h</a></div><div class="ttdoc">Main UCX Header providing most common definitions. </div></div>
   11.75 +<div class="ttc" id="allocator_8h_html_a96403ebf3d2312d95f2fe7627a1cdbc0"><div class="ttname"><a href="allocator_8h.html#a96403ebf3d2312d95f2fe7627a1cdbc0">ucx_default_malloc</a></div><div class="ttdeci">void * ucx_default_malloc(void *ignore, size_t n)</div><div class="ttdoc">A wrapper for the standard libc malloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:46</div></div>
   11.76 +<div class="ttc" id="structUcxAllocator_html"><div class="ttname"><a href="structUcxAllocator.html">UcxAllocator</a></div><div class="ttdoc">UCX allocator data structure containing memory management functions. </div><div class="ttdef"><b>Definition:</b> allocator.h:88</div></div>
   11.77 +<div class="ttc" id="structUcxAllocator_html_a013376172be39ed54f77c4be6898845a"><div class="ttname"><a href="structUcxAllocator.html#a013376172be39ed54f77c4be6898845a">UcxAllocator::malloc</a></div><div class="ttdeci">ucx_allocator_malloc malloc</div><div class="ttdoc">The malloc() function for this allocator. </div><div class="ttdef"><b>Definition:</b> allocator.h:97</div></div>
   11.78 +<div class="ttc" id="allocator_8h_html_a2c0aba4221c1ac6801f03ed799f15b12"><div class="ttname"><a href="allocator_8h.html#a2c0aba4221c1ac6801f03ed799f15b12">ucx_allocator_calloc</a></div><div class="ttdeci">void *(* ucx_allocator_calloc)(void *pool, size_t n, size_t size)</div><div class="ttdoc">A function pointer to the allocators calloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.h:71</div></div>
   11.79 +<div class="ttc" id="structUcxAllocator_html_aecce1840378ed53f1002190f4f87026f"><div class="ttname"><a href="structUcxAllocator.html#aecce1840378ed53f1002190f4f87026f">UcxAllocator::free</a></div><div class="ttdeci">ucx_allocator_free free</div><div class="ttdoc">The free() function for this allocator. </div><div class="ttdef"><b>Definition:</b> allocator.h:109</div></div>
   11.80 +<div class="ttc" id="allocator_8h_html_a29f0f6a23a70db3b60635cd6dc384473"><div class="ttname"><a href="allocator_8h.html#a29f0f6a23a70db3b60635cd6dc384473">ucx_allocator_malloc</a></div><div class="ttdeci">void *(* ucx_allocator_malloc)(void *pool, size_t n)</div><div class="ttdoc">A function pointer to the allocators malloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.h:65</div></div>
   11.81 +<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>
   11.82 +<div class="ttc" id="allocator_8h_html_a3a0bfdd13d887012309c459b339f338f"><div class="ttname"><a href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a></div><div class="ttdeci">void * ucx_default_calloc(void *ignore, size_t n, size_t size)</div><div class="ttdoc">A wrapper for the standard libc calloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:50</div></div>
   11.83 +<div class="ttc" id="allocator_8h_html_a6d7cf038a806e327c5da37321d04e426"><div class="ttname"><a href="allocator_8h.html#a6d7cf038a806e327c5da37321d04e426">ucx_allocator_realloc</a></div><div class="ttdeci">void *(* ucx_allocator_realloc)(void *pool, void *data, size_t n)</div><div class="ttdoc">A function pointer to the allocators realloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.h:77</div></div>
   11.84 +<div class="ttc" id="allocator_8h_html_a47cfc8af626a86fcb93a2b14b90498ed"><div class="ttname"><a href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a></div><div class="ttdeci">void * ucx_default_realloc(void *ignore, void *data, size_t n)</div><div class="ttdoc">A wrapper for the standard libc realloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:54</div></div>
   11.85 +<div class="ttc" id="allocator_8h_html_aaf2387ddaddd8ab4b267e6b00e5d6f7e"><div class="ttname"><a href="allocator_8h.html#aaf2387ddaddd8ab4b267e6b00e5d6f7e">ucx_allocator_free</a></div><div class="ttdeci">void(* ucx_allocator_free)(void *pool, void *data)</div><div class="ttdoc">A function pointer to the allocators free() function. </div><div class="ttdef"><b>Definition:</b> allocator.h:83</div></div>
   11.86 +<div class="ttc" id="structUcxAllocator_html_ab94ec1cba45cc4e7d81e1588a11cbb62"><div class="ttname"><a href="structUcxAllocator.html#ab94ec1cba45cc4e7d81e1588a11cbb62">UcxAllocator::calloc</a></div><div class="ttdeci">ucx_allocator_calloc calloc</div><div class="ttdoc">The calloc() function for this allocator. </div><div class="ttdef"><b>Definition:</b> allocator.h:101</div></div>
   11.87 +<div class="ttc" id="allocator_8h_html_a646d83aaaadfe33ae414c0fad8bfc52a"><div class="ttname"><a href="allocator_8h.html#a646d83aaaadfe33ae414c0fad8bfc52a">ucx_default_free</a></div><div class="ttdeci">void ucx_default_free(void *ignore, void *data)</div><div class="ttdoc">A wrapper for the standard libc free() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:58</div></div>
   11.88 +<div class="ttc" id="structUcxAllocator_html_a3550e3847f31d9e9ce3ffcb0d3440c15"><div class="ttname"><a href="structUcxAllocator.html#a3550e3847f31d9e9ce3ffcb0d3440c15">UcxAllocator::realloc</a></div><div class="ttdeci">ucx_allocator_realloc realloc</div><div class="ttdoc">The realloc() function for this allocator. </div><div class="ttdef"><b>Definition:</b> allocator.h:105</div></div>
   11.89 +<div class="ttc" id="structUcxAllocator_html_a1b78012998d1c28be86dc595f8f0aac9"><div class="ttname"><a href="structUcxAllocator.html#a1b78012998d1c28be86dc595f8f0aac9">UcxAllocator::pool</a></div><div class="ttdeci">void * pool</div><div class="ttdoc">Pointer to an area of memory or a complex memory pool. </div><div class="ttdef"><b>Definition:</b> allocator.h:93</div></div>
   11.90 +</div><!-- fragment --></div><!-- contents -->
   11.91 +<!-- start footer part -->
   11.92 +<hr class="footer"/><address class="footer"><small>
   11.93 +Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
   11.94 +<img class="footer" src="doxygen.png" alt="doxygen"/>
   11.95 +</a> 1.8.13
   11.96 +</small></address>
   11.97 +</body>
   11.98 +</html>

    12.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
    12.2 +++ b/docs/api-2.1/annotated.html	Sat Feb 06 19:11:44 2021 +0100
    12.3 @@ -0,0 +1,101 @@
    12.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    12.5 +<html xmlns="http://www.w3.org/1999/xhtml">
    12.6 +<head>
    12.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    12.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
    12.9 +<meta name="generator" content="Doxygen 1.8.13"/>
   12.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
   12.11 +<title>ucx: Data Structures</title>
   12.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
   12.13 +<script type="text/javascript" src="jquery.js"></script>
   12.14 +<script type="text/javascript" src="dynsections.js"></script>
   12.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
   12.16 +<script type="text/javascript" src="search/searchdata.js"></script>
   12.17 +<script type="text/javascript" src="search/search.js"></script>
   12.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
   12.19 +</head>
   12.20 +<body>
   12.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
   12.22 +<div id="titlearea">
   12.23 +<table cellspacing="0" cellpadding="0">
   12.24 + <tbody>
   12.25 + <tr style="height: 56px;">
   12.26 +  <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
   12.27 +  <td id="projectalign" style="padding-left: 0.5em;">
   12.28 +   <div id="projectname">ucx
   12.29 +   </div>
   12.30 +   <div id="projectbrief">UAP Common Extensions</div>
   12.31 +  </td>
   12.32 + </tr>
   12.33 + </tbody>
   12.34 +</table>
   12.35 +</div>
   12.36 +<!-- end header part -->
   12.37 +<!-- Generated by Doxygen 1.8.13 -->
   12.38 +<script type="text/javascript">
   12.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
   12.40 +</script>
   12.41 +<script type="text/javascript" src="menudata.js"></script>
   12.42 +<script type="text/javascript" src="menu.js"></script>
   12.43 +<script type="text/javascript">
   12.44 +$(function() {
   12.45 +  initMenu('',true,false,'search.php','Search');
   12.46 +  $(document).ready(function() { init_search(); });
   12.47 +});
   12.48 +</script>
   12.49 +<div id="main-nav"></div>
   12.50 +</div><!-- top -->
   12.51 +<!-- window showing the filter options -->
   12.52 +<div id="MSearchSelectWindow"
   12.53 +     onmouseover="return searchBox.OnSearchSelectShow()"
   12.54 +     onmouseout="return searchBox.OnSearchSelectHide()"
   12.55 +     onkeydown="return searchBox.OnSearchSelectKey(event)">
   12.56 +</div>
   12.57 +
   12.58 +<!-- iframe showing the search results (closed by default) -->
   12.59 +<div id="MSearchResultsWindow">
   12.60 +<iframe src="javascript:void(0)" frameborder="0" 
   12.61 +        name="MSearchResults" id="MSearchResults">
   12.62 +</iframe>
   12.63 +</div>
   12.64 +
   12.65 +<div class="header">
   12.66 +  <div class="headertitle">
   12.67 +<div class="title">Data Structures</div>  </div>
   12.68 +</div><!--header-->
   12.69 +<div class="contents">
   12.70 +<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
   12.71 +<table class="directory">
   12.72 +<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscstr__t.html" target="_self">scstr_t</a></td><td class="desc">The UCX string structure for immutable (constant) strings </td></tr>
   12.73 +<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsstr__t.html" target="_self">sstr_t</a></td><td class="desc">The UCX string structure </td></tr>
   12.74 +<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structucx__memchunk.html" target="_self">ucx_memchunk</a></td><td class="desc">Capsule for destructible memory chunks </td></tr>
   12.75 +<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structucx__regdestr.html" target="_self">ucx_regdestr</a></td><td class="desc">Capsule for data and its destructor </td></tr>
   12.76 +<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structucx__stack__metadata.html" target="_self">ucx_stack_metadata</a></td><td class="desc">Metadata for each UCX stack element </td></tr>
   12.77 +<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxAllocator.html" target="_self">UcxAllocator</a></td><td class="desc">UCX allocator data structure containing memory management functions </td></tr>
   12.78 +<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxArray.html" target="_self">UcxArray</a></td><td class="desc">UCX array type </td></tr>
   12.79 +<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxAVLNode.html" target="_self">UcxAVLNode</a></td><td class="desc">UCX AVL Node </td></tr>
   12.80 +<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxAVLTree.html" target="_self">UcxAVLTree</a></td><td class="desc">UCX AVL Tree </td></tr>
   12.81 +<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxBuffer.html" target="_self">UcxBuffer</a></td><td class="desc">UCX Buffer </td></tr>
   12.82 +<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxKey.html" target="_self">UcxKey</a></td><td class="desc">Structure to publicly denote a key of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a> </td></tr>
   12.83 +<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxList.html" target="_self">UcxList</a></td><td class="desc">UCX list structure </td></tr>
   12.84 +<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxLogger.html" target="_self">UcxLogger</a></td><td class="desc">The UCX Logger object </td></tr>
   12.85 +<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxMap.html" target="_self">UcxMap</a></td><td class="desc">Structure for the UCX map </td></tr>
   12.86 +<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxMapElement.html" target="_self">UcxMapElement</a></td><td class="desc">Structure for an element of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a> </td></tr>
   12.87 +<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxMapIterator.html" target="_self">UcxMapIterator</a></td><td class="desc">Structure for an iterator over a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a> </td></tr>
   12.88 +<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxMapKey.html" target="_self">UcxMapKey</a></td><td class="desc">Internal structure for a key of a <a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a> </td></tr>
   12.89 +<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxMempool.html" target="_self">UcxMempool</a></td><td class="desc">UCX mempool structure </td></tr>
   12.90 +<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxProperties.html" target="_self">UcxProperties</a></td><td class="desc"><a class="el" href="structUcxProperties.html" title="UcxProperties object for parsing properties data. ">UcxProperties</a> object for parsing properties data </td></tr>
   12.91 +<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxStack.html" target="_self">UcxStack</a></td><td class="desc">UCX stack structure </td></tr>
   12.92 +<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxTestList.html" target="_self">UcxTestList</a></td><td class="desc">Structure for the internal list of test cases </td></tr>
   12.93 +<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structUcxTestSuite.html" target="_self">UcxTestSuite</a></td><td class="desc">A test suite containing multiple test cases </td></tr>
   12.94 +</table>
   12.95 +</div><!-- directory -->
   12.96 +</div><!-- contents -->
   12.97 +<!-- start footer part -->
   12.98 +<hr class="footer"/><address class="footer"><small>
   12.99 +Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
  12.100 +<img class="footer" src="doxygen.png" alt="doxygen"/>
  12.101 +</a> 1.8.13
  12.102 +</small></address>
  12.103 +</body>
  12.104 +</html>

    13.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
    13.2 +++ b/docs/api-2.1/array_8h.html	Sat Feb 06 19:11:44 2021 +0100
    13.3 @@ -0,0 +1,1376 @@
    13.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    13.5 +<html xmlns="http://www.w3.org/1999/xhtml">
    13.6 +<head>
    13.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    13.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
    13.9 +<meta name="generator" content="Doxygen 1.8.13"/>
   13.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
   13.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/array.h File Reference</title>
   13.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
   13.13 +<script type="text/javascript" src="jquery.js"></script>
   13.14 +<script type="text/javascript" src="dynsections.js"></script>
   13.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
   13.16 +<script type="text/javascript" src="search/searchdata.js"></script>
   13.17 +<script type="text/javascript" src="search/search.js"></script>
   13.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
   13.19 +</head>
   13.20 +<body>
   13.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
   13.22 +<div id="titlearea">
   13.23 +<table cellspacing="0" cellpadding="0">
   13.24 + <tbody>
   13.25 + <tr style="height: 56px;">
   13.26 +  <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
   13.27 +  <td id="projectalign" style="padding-left: 0.5em;">
   13.28 +   <div id="projectname">ucx
   13.29 +   </div>
   13.30 +   <div id="projectbrief">UAP Common Extensions</div>
   13.31 +  </td>
   13.32 + </tr>
   13.33 + </tbody>
   13.34 +</table>
   13.35 +</div>
   13.36 +<!-- end header part -->
   13.37 +<!-- Generated by Doxygen 1.8.13 -->
   13.38 +<script type="text/javascript">
   13.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
   13.40 +</script>
   13.41 +<script type="text/javascript" src="menudata.js"></script>
   13.42 +<script type="text/javascript" src="menu.js"></script>
   13.43 +<script type="text/javascript">
   13.44 +$(function() {
   13.45 +  initMenu('',true,false,'search.php','Search');
   13.46 +  $(document).ready(function() { init_search(); });
   13.47 +});
   13.48 +</script>
   13.49 +<div id="main-nav"></div>
   13.50 +<!-- window showing the filter options -->
   13.51 +<div id="MSearchSelectWindow"
   13.52 +     onmouseover="return searchBox.OnSearchSelectShow()"
   13.53 +     onmouseout="return searchBox.OnSearchSelectHide()"
   13.54 +     onkeydown="return searchBox.OnSearchSelectKey(event)">
   13.55 +</div>
   13.56 +
   13.57 +<!-- iframe showing the search results (closed by default) -->
   13.58 +<div id="MSearchResultsWindow">
   13.59 +<iframe src="javascript:void(0)" frameborder="0" 
   13.60 +        name="MSearchResults" id="MSearchResults">
   13.61 +</iframe>
   13.62 +</div>
   13.63 +
   13.64 +<div id="nav-path" class="navpath">
   13.65 +  <ul>
   13.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>
   13.67 +</div>
   13.68 +</div><!-- top -->
   13.69 +<div class="header">
   13.70 +  <div class="summary">
   13.71 +<a href="#nested-classes">Data Structures</a> &#124;
   13.72 +<a href="#define-members">Macros</a> &#124;
   13.73 +<a href="#func-members">Functions</a>  </div>
   13.74 +  <div class="headertitle">
   13.75 +<div class="title">array.h File Reference</div>  </div>
   13.76 +</div><!--header-->
   13.77 +<div class="contents">
   13.78 +
   13.79 +<p>Dynamically allocated array implementation.  
   13.80 +<a href="#details">More...</a></p>
   13.81 +<div class="textblock"><code>#include &quot;<a class="el" href="ucx_8h_source.html">ucx.h</a>&quot;</code><br />
   13.82 +<code>#include &quot;<a class="el" href="allocator_8h_source.html">allocator.h</a>&quot;</code><br />
   13.83 +</div>
   13.84 +<p><a href="array_8h_source.html">Go to the source code of this file.</a></p>
   13.85 +<table class="memberdecls">
   13.86 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
   13.87 +Data Structures</h2></td></tr>
   13.88 +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxArray.html">UcxArray</a></td></tr>
   13.89 +<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">UCX array type.  <a href="structUcxArray.html#details">More...</a><br /></td></tr>
   13.90 +<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
   13.91 +</table><table class="memberdecls">
   13.92 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
   13.93 +Macros</h2></td></tr>
   13.94 +<tr class="memitem:a1d959c29af3125bdd37cde3a554e729c"><td class="memItemLeft" align="right" valign="top">#define&#160;</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>
   13.95 +<tr class="memdesc:a1d959c29af3125bdd37cde3a554e729c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets an element in an arbitrary user defined array.  <a href="#a1d959c29af3125bdd37cde3a554e729c">More...</a><br /></td></tr>
   13.96 +<tr class="separator:a1d959c29af3125bdd37cde3a554e729c"><td class="memSeparator" colspan="2">&#160;</td></tr>
   13.97 +<tr class="memitem:a59a5b342965e790945f9c7a3f86b99f9"><td class="memItemLeft" align="right" valign="top">#define&#160;</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>
   13.98 +<tr class="memdesc:a59a5b342965e790945f9c7a3f86b99f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores a pointer in an arbitrary user defined array.  <a href="#a59a5b342965e790945f9c7a3f86b99f9">More...</a><br /></td></tr>
   13.99 +<tr class="separator:a59a5b342965e790945f9c7a3f86b99f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.100 +</table><table class="memberdecls">
  13.101 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  13.102 +Functions</h2></td></tr>
  13.103 +<tr class="memitem:ad0a8d76980cf1c1910e64a245803fb9a"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.104 +<tr class="memdesc:ad0a8d76980cf1c1910e64a245803fb9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets an element in an arbitrary user defined array.  <a href="#ad0a8d76980cf1c1910e64a245803fb9a">More...</a><br /></td></tr>
  13.105 +<tr class="separator:ad0a8d76980cf1c1910e64a245803fb9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.106 +<tr class="memitem:ad708b333c0c1b02c998309a58ea65e31"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.107 +<tr class="memdesc:ad708b333c0c1b02c998309a58ea65e31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores a pointer in an arbitrary user defined array.  <a href="#ad708b333c0c1b02c998309a58ea65e31">More...</a><br /></td></tr>
  13.108 +<tr class="separator:ad708b333c0c1b02c998309a58ea65e31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.109 +<tr class="memitem:a994a2fbf1c33a3833e2a70cd9a4352b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</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>
  13.110 +<tr class="memdesc:a994a2fbf1c33a3833e2a70cd9a4352b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new UCX array with the given capacity and element size.  <a href="#a994a2fbf1c33a3833e2a70cd9a4352b7">More...</a><br /></td></tr>
  13.111 +<tr class="separator:a994a2fbf1c33a3833e2a70cd9a4352b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.112 +<tr class="memitem:a177170258c215eb2e4f5a32e59f0cb1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</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>
  13.113 +<tr class="memdesc:a177170258c215eb2e4f5a32e59f0cb1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new UCX array using the specified allocator.  <a href="#a177170258c215eb2e4f5a32e59f0cb1b">More...</a><br /></td></tr>
  13.114 +<tr class="separator:a177170258c215eb2e4f5a32e59f0cb1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.115 +<tr class="memitem:ad921e85c28ffae32230777a53c5037e5"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.116 +<tr class="memdesc:ad921e85c28ffae32230777a53c5037e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a UCX array structure with the given capacity and element size.  <a href="#ad921e85c28ffae32230777a53c5037e5">More...</a><br /></td></tr>
  13.117 +<tr class="separator:ad921e85c28ffae32230777a53c5037e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.118 +<tr class="memitem:a2451e61ebb15a7ba1c1319267ba75b8c"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.119 +<tr class="memdesc:a2451e61ebb15a7ba1c1319267ba75b8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a UCX array structure using the specified allocator.  <a href="#a2451e61ebb15a7ba1c1319267ba75b8c">More...</a><br /></td></tr>
  13.120 +<tr class="separator:a2451e61ebb15a7ba1c1319267ba75b8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.121 +<tr class="memitem:a4a8c273370e4a3a3e2624e364f5ab410"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.122 +<tr class="memdesc:a4a8c273370e4a3a3e2624e364f5ab410"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an shallow copy of an array.  <a href="#a4a8c273370e4a3a3e2624e364f5ab410">More...</a><br /></td></tr>
  13.123 +<tr class="separator:a4a8c273370e4a3a3e2624e364f5ab410"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.124 +<tr class="memitem:a43292b448adb1741677aa8c578bcc201"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.125 +<tr class="memdesc:a43292b448adb1741677aa8c578bcc201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two UCX arrays element-wise by using a compare function.  <a href="#a43292b448adb1741677aa8c578bcc201">More...</a><br /></td></tr>
  13.126 +<tr class="separator:a43292b448adb1741677aa8c578bcc201"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.127 +<tr class="memitem:a8e83681d8d5d8cddbf10f63ce5be4c10"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.128 +<tr class="memdesc:a8e83681d8d5d8cddbf10f63ce5be4c10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the array.  <a href="#a8e83681d8d5d8cddbf10f63ce5be4c10">More...</a><br /></td></tr>
  13.129 +<tr class="separator:a8e83681d8d5d8cddbf10f63ce5be4c10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.130 +<tr class="memitem:ac01ee914468a16f470bf3071fffbe438"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.131 +<tr class="memdesc:ac01ee914468a16f470bf3071fffbe438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys and frees the array.  <a href="#ac01ee914468a16f470bf3071fffbe438">More...</a><br /></td></tr>
  13.132 +<tr class="separator:ac01ee914468a16f470bf3071fffbe438"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.133 +<tr class="memitem:aea01731ad94ea73c0c8fb1d1b7a35fcf"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.134 +<tr class="memdesc:aea01731ad94ea73c0c8fb1d1b7a35fcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts elements at the end of the array.  <a href="#aea01731ad94ea73c0c8fb1d1b7a35fcf">More...</a><br /></td></tr>
  13.135 +<tr class="separator:aea01731ad94ea73c0c8fb1d1b7a35fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.136 +<tr class="memitem:a95b52acc2193b5c33cf0eaa4f2082477"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.137 +<tr class="memdesc:a95b52acc2193b5c33cf0eaa4f2082477"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts elements at the beginning of the array.  <a href="#a95b52acc2193b5c33cf0eaa4f2082477">More...</a><br /></td></tr>
  13.138 +<tr class="separator:a95b52acc2193b5c33cf0eaa4f2082477"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.139 +<tr class="memitem:a1bb545d065358d265d80d815ba382a28"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.140 +<tr class="memdesc:a1bb545d065358d265d80d815ba382a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets elements starting at the specified index.  <a href="#a1bb545d065358d265d80d815ba382a28">More...</a><br /></td></tr>
  13.141 +<tr class="separator:a1bb545d065358d265d80d815ba382a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.142 +<tr class="memitem:aa5a0bf3d3f0df6406beb0e569021cc28"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.143 +<tr class="memdesc:aa5a0bf3d3f0df6406beb0e569021cc28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concatenates two arrays.  <a href="#aa5a0bf3d3f0df6406beb0e569021cc28">More...</a><br /></td></tr>
  13.144 +<tr class="separator:aa5a0bf3d3f0df6406beb0e569021cc28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.145 +<tr class="memitem:aa698085fd1a8b70d6b709999c51b49e8"><td class="memItemLeft" align="right" valign="top">void *&#160;</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>
  13.146 +<tr class="memdesc:aa698085fd1a8b70d6b709999c51b49e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the array element at the specified index.  <a href="#aa698085fd1a8b70d6b709999c51b49e8">More...</a><br /></td></tr>
  13.147 +<tr class="separator:aa698085fd1a8b70d6b709999c51b49e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.148 +<tr class="memitem:ae7bdbed94afee9b20b38b95e3ab470f0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</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>
  13.149 +<tr class="memdesc:ae7bdbed94afee9b20b38b95e3ab470f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the index of an element containing the specified data.  <a href="#ae7bdbed94afee9b20b38b95e3ab470f0">More...</a><br /></td></tr>
  13.150 +<tr class="separator:ae7bdbed94afee9b20b38b95e3ab470f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.151 +<tr class="memitem:a5241058cd2329147bc5b1593ae7e51dc"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.152 +<tr class="memdesc:a5241058cd2329147bc5b1593ae7e51dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks, if an array contains a specific element.  <a href="#a5241058cd2329147bc5b1593ae7e51dc">More...</a><br /></td></tr>
  13.153 +<tr class="separator:a5241058cd2329147bc5b1593ae7e51dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.154 +<tr class="memitem:add773514569b872a6624381b4b6af52c"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.155 +<tr class="memdesc:add773514569b872a6624381b4b6af52c"><td class="mdescLeft">&#160;</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>
  13.156 +<tr class="separator:add773514569b872a6624381b4b6af52c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.157 +<tr class="memitem:aa45eac6b697f83adac81c0860cf306b8"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.158 +<tr class="memdesc:aa45eac6b697f83adac81c0860cf306b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes an element from the array.  <a href="#aa45eac6b697f83adac81c0860cf306b8">More...</a><br /></td></tr>
  13.159 +<tr class="separator:aa45eac6b697f83adac81c0860cf306b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.160 +<tr class="memitem:a548d81b07612bae3ba8c4c4b49104b8e"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  13.161 +<tr class="memdesc:a548d81b07612bae3ba8c4c4b49104b8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes an element from the array.  <a href="#a548d81b07612bae3ba8c4c4b49104b8e">More...</a><br /></td></tr>
  13.162 +<tr class="separator:a548d81b07612bae3ba8c4c4b49104b8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.163 +<tr class="memitem:a2daf50e80aee9bccebee876a7efd2dfc"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.164 +<tr class="memdesc:a2daf50e80aee9bccebee876a7efd2dfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shrinks the memory to exactly fit the contents.  <a href="#a2daf50e80aee9bccebee876a7efd2dfc">More...</a><br /></td></tr>
  13.165 +<tr class="separator:a2daf50e80aee9bccebee876a7efd2dfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.166 +<tr class="memitem:a27762e7c06a6c781015e3c8ceeee0ce3"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.167 +<tr class="memdesc:a27762e7c06a6c781015e3c8ceeee0ce3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the capacity of the array.  <a href="#a27762e7c06a6c781015e3c8ceeee0ce3">More...</a><br /></td></tr>
  13.168 +<tr class="separator:a27762e7c06a6c781015e3c8ceeee0ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.169 +<tr class="memitem:a1c3bf8433c1de3c933f3854ab297fe1d"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.170 +<tr class="memdesc:a1c3bf8433c1de3c933f3854ab297fe1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resizes the array only, if the capacity is insufficient.  <a href="#a1c3bf8433c1de3c933f3854ab297fe1d">More...</a><br /></td></tr>
  13.171 +<tr class="separator:a1c3bf8433c1de3c933f3854ab297fe1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.172 +<tr class="memitem:ab0cbf243824aaebee48277315e03afce"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  13.173 +<tr class="memdesc:ab0cbf243824aaebee48277315e03afce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resizes the capacity, if the specified number of elements would not fit.  <a href="#ab0cbf243824aaebee48277315e03afce">More...</a><br /></td></tr>
  13.174 +<tr class="separator:ab0cbf243824aaebee48277315e03afce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  13.175 +</table>
  13.176 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  13.177 +<div class="textblock"><p>Dynamically allocated array implementation. </p>
  13.178 +<dl class="section author"><dt>Author</dt><dd>Mike Becker </dd>
  13.179 +<dd>
  13.180 +Olaf Wintermann </dd></dl>
  13.181 +</div><h2 class="groupheader">Macro Definition Documentation</h2>
  13.182 +<a id="a1d959c29af3125bdd37cde3a554e729c"></a>
  13.183 +<h2 class="memtitle"><span class="permalink"><a href="#a1d959c29af3125bdd37cde3a554e729c">&#9670;&nbsp;</a></span>ucx_array_util_set</h2>
  13.184 +
  13.185 +<div class="memitem">
  13.186 +<div class="memproto">
  13.187 +      <table class="memname">
  13.188 +        <tr>
  13.189 +          <td class="memname">#define ucx_array_util_set</td>
  13.190 +          <td>(</td>
  13.191 +          <td class="paramtype">&#160;</td>
  13.192 +          <td class="paramname">array, </td>
  13.193 +        </tr>
  13.194 +        <tr>
  13.195 +          <td class="paramkey"></td>
  13.196 +          <td></td>
  13.197 +          <td class="paramtype">&#160;</td>
  13.198 +          <td class="paramname">capacity, </td>
  13.199 +        </tr>
  13.200 +        <tr>
  13.201 +          <td class="paramkey"></td>
  13.202 +          <td></td>
  13.203 +          <td class="paramtype">&#160;</td>
  13.204 +          <td class="paramname">elmsize, </td>
  13.205 +        </tr>
  13.206 +        <tr>
  13.207 +          <td class="paramkey"></td>
  13.208 +          <td></td>
  13.209 +          <td class="paramtype">&#160;</td>
  13.210 +          <td class="paramname">idx, </td>
  13.211 +        </tr>
  13.212 +        <tr>
  13.213 +          <td class="paramkey"></td>
  13.214 +          <td></td>
  13.215 +          <td class="paramtype">&#160;</td>
  13.216 +          <td class="paramname">data&#160;</td>
  13.217 +        </tr>
  13.218 +        <tr>
  13.219 +          <td></td>
  13.220 +          <td>)</td>
  13.221 +          <td></td><td></td>
  13.222 +        </tr>
  13.223 +      </table>
  13.224 +</div><div class="memdoc">
  13.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>
  13.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>
  13.227 +</div><!-- fragment -->
  13.228 +<p>Sets an element in an arbitrary user defined array. </p>
  13.229 +<p>The data is copied from the specified data location.</p>
  13.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>
  13.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>
  13.232 +<dl class="params"><dt>Parameters</dt><dd>
  13.233 +  <table class="params">
  13.234 +    <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
  13.235 +    <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
  13.236 +    <tr><td class="paramname">elmsize</td><td>the size of each element </td></tr>
  13.237 +    <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
  13.238 +    <tr><td class="paramname">data</td><td>a pointer to the element data </td></tr>
  13.239 +  </table>
  13.240 +  </dd>
  13.241 +</dl>
  13.242 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
  13.243 +
  13.244 +</div>
  13.245 +</div>
  13.246 +<a id="a59a5b342965e790945f9c7a3f86b99f9"></a>
  13.247 +<h2 class="memtitle"><span class="permalink"><a href="#a59a5b342965e790945f9c7a3f86b99f9">&#9670;&nbsp;</a></span>ucx_array_util_setptr</h2>
  13.248 +
  13.249 +<div class="memitem">
  13.250 +<div class="memproto">
  13.251 +      <table class="memname">
  13.252 +        <tr>
  13.253 +          <td class="memname">#define ucx_array_util_setptr</td>
  13.254 +          <td>(</td>
  13.255 +          <td class="paramtype">&#160;</td>
  13.256 +          <td class="paramname">array, </td>
  13.257 +        </tr>
  13.258 +        <tr>
  13.259 +          <td class="paramkey"></td>
  13.260 +          <td></td>
  13.261 +          <td class="paramtype">&#160;</td>
  13.262 +          <td class="paramname">capacity, </td>
  13.263 +        </tr>
  13.264 +        <tr>
  13.265 +          <td class="paramkey"></td>
  13.266 +          <td></td>
  13.267 +          <td class="paramtype">&#160;</td>
  13.268 +          <td class="paramname">idx, </td>
  13.269 +        </tr>
  13.270 +        <tr>
  13.271 +          <td class="paramkey"></td>
  13.272 +          <td></td>
  13.273 +          <td class="paramtype">&#160;</td>
  13.274 +          <td class="paramname">ptr&#160;</td>
  13.275 +        </tr>
  13.276 +        <tr>
  13.277 +          <td></td>
  13.278 +          <td>)</td>
  13.279 +          <td></td><td></td>
  13.280 +        </tr>
  13.281 +      </table>
  13.282 +</div><div class="memdoc">
  13.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>
  13.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>
  13.285 +</div><!-- fragment -->
  13.286 +<p>Stores a pointer in an arbitrary user defined array. </p>
  13.287 +<p>The element size of the array must be sizeof(void*).</p>
  13.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>
  13.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>
  13.290 +<dl class="params"><dt>Parameters</dt><dd>
  13.291 +  <table class="params">
  13.292 +    <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
  13.293 +    <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
  13.294 +    <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
  13.295 +    <tr><td class="paramname">ptr</td><td>the pointer to store </td></tr>
  13.296 +  </table>
  13.297 +  </dd>
  13.298 +</dl>
  13.299 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
  13.300 +
  13.301 +</div>
  13.302 +</div>
  13.303 +<h2 class="groupheader">Function Documentation</h2>
  13.304 +<a id="aea01731ad94ea73c0c8fb1d1b7a35fcf"></a>
  13.305 +<h2 class="memtitle"><span class="permalink"><a href="#aea01731ad94ea73c0c8fb1d1b7a35fcf">&#9670;&nbsp;</a></span>ucx_array_append_from()</h2>
  13.306 +
  13.307 +<div class="memitem">
  13.308 +<div class="memproto">
  13.309 +      <table class="memname">
  13.310 +        <tr>
  13.311 +          <td class="memname">int ucx_array_append_from </td>
  13.312 +          <td>(</td>
  13.313 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.314 +          <td class="paramname"><em>array</em>, </td>
  13.315 +        </tr>
  13.316 +        <tr>
  13.317 +          <td class="paramkey"></td>
  13.318 +          <td></td>
  13.319 +          <td class="paramtype">void *&#160;</td>
  13.320 +          <td class="paramname"><em>data</em>, </td>
  13.321 +        </tr>
  13.322 +        <tr>
  13.323 +          <td class="paramkey"></td>
  13.324 +          <td></td>
  13.325 +          <td class="paramtype">size_t&#160;</td>
  13.326 +          <td class="paramname"><em>count</em>&#160;</td>
  13.327 +        </tr>
  13.328 +        <tr>
  13.329 +          <td></td>
  13.330 +          <td>)</td>
  13.331 +          <td></td><td></td>
  13.332 +        </tr>
  13.333 +      </table>
  13.334 +</div><div class="memdoc">
  13.335 +
  13.336 +<p>Inserts elements at the end of the array. </p>
  13.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>
  13.338 +<dl class="params"><dt>Parameters</dt><dd>
  13.339 +  <table class="params">
  13.340 +    <tr><td class="paramname">array</td><td>a pointer the array where to append the data </td></tr>
  13.341 +    <tr><td class="paramname">data</td><td>a pointer to the data to insert (may be <code>NULL</code>) </td></tr>
  13.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>
  13.343 +  </table>
  13.344 +  </dd>
  13.345 +</dl>
  13.346 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if a reallocation was necessary but failed </dd></dl>
  13.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>
  13.348 +<dd>
  13.349 +ucx_array_append() </dd></dl>
  13.350 +
  13.351 +</div>
  13.352 +</div>
  13.353 +<a id="aa698085fd1a8b70d6b709999c51b49e8"></a>
  13.354 +<h2 class="memtitle"><span class="permalink"><a href="#aa698085fd1a8b70d6b709999c51b49e8">&#9670;&nbsp;</a></span>ucx_array_at()</h2>
  13.355 +
  13.356 +<div class="memitem">
  13.357 +<div class="memproto">
  13.358 +      <table class="memname">
  13.359 +        <tr>
  13.360 +          <td class="memname">void* ucx_array_at </td>
  13.361 +          <td>(</td>
  13.362 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const *&#160;</td>
  13.363 +          <td class="paramname"><em>array</em>, </td>
  13.364 +        </tr>
  13.365 +        <tr>
  13.366 +          <td class="paramkey"></td>
  13.367 +          <td></td>
  13.368 +          <td class="paramtype">size_t&#160;</td>
  13.369 +          <td class="paramname"><em>index</em>&#160;</td>
  13.370 +        </tr>
  13.371 +        <tr>
  13.372 +          <td></td>
  13.373 +          <td>)</td>
  13.374 +          <td></td><td></td>
  13.375 +        </tr>
  13.376 +      </table>
  13.377 +</div><div class="memdoc">
  13.378 +
  13.379 +<p>Returns a pointer to the array element at the specified index. </p>
  13.380 +<dl class="params"><dt>Parameters</dt><dd>
  13.381 +  <table class="params">
  13.382 +    <tr><td class="paramname">array</td><td>the array to retrieve the element from </td></tr>
  13.383 +    <tr><td class="paramname">index</td><td>index of the element to return </td></tr>
  13.384 +  </table>
  13.385 +  </dd>
  13.386 +</dl>
  13.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>
  13.388 +
  13.389 +</div>
  13.390 +</div>
  13.391 +<a id="a4a8c273370e4a3a3e2624e364f5ab410"></a>
  13.392 +<h2 class="memtitle"><span class="permalink"><a href="#a4a8c273370e4a3a3e2624e364f5ab410">&#9670;&nbsp;</a></span>ucx_array_clone()</h2>
  13.393 +
  13.394 +<div class="memitem">
  13.395 +<div class="memproto">
  13.396 +      <table class="memname">
  13.397 +        <tr>
  13.398 +          <td class="memname">int ucx_array_clone </td>
  13.399 +          <td>(</td>
  13.400 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.401 +          <td class="paramname"><em>dest</em>, </td>
  13.402 +        </tr>
  13.403 +        <tr>
  13.404 +          <td class="paramkey"></td>
  13.405 +          <td></td>
  13.406 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const *&#160;</td>
  13.407 +          <td class="paramname"><em>src</em>&#160;</td>
  13.408 +        </tr>
  13.409 +        <tr>
  13.410 +          <td></td>
  13.411 +          <td>)</td>
  13.412 +          <td></td><td></td>
  13.413 +        </tr>
  13.414 +      </table>
  13.415 +</div><div class="memdoc">
  13.416 +
  13.417 +<p>Creates an shallow copy of an array. </p>
  13.418 +<p>This function clones the specified array by using memcpy(). If the destination capacity is insufficient, an automatic reallocation is attempted.</p>
  13.419 +<p>Note: if the destination array is uninitialized, the behavior is undefined.</p>
  13.420 +<dl class="params"><dt>Parameters</dt><dd>
  13.421 +  <table class="params">
  13.422 +    <tr><td class="paramname">dest</td><td>the array to copy to </td></tr>
  13.423 +    <tr><td class="paramname">src</td><td>the array to copy from </td></tr>
  13.424 +  </table>
  13.425 +  </dd>
  13.426 +</dl>
  13.427 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero on reallocation failure. </dd></dl>
  13.428 +
  13.429 +</div>
  13.430 +</div>
  13.431 +<a id="aa5a0bf3d3f0df6406beb0e569021cc28"></a>
  13.432 +<h2 class="memtitle"><span class="permalink"><a href="#aa5a0bf3d3f0df6406beb0e569021cc28">&#9670;&nbsp;</a></span>ucx_array_concat()</h2>
  13.433 +
  13.434 +<div class="memitem">
  13.435 +<div class="memproto">
  13.436 +      <table class="memname">
  13.437 +        <tr>
  13.438 +          <td class="memname">int ucx_array_concat </td>
  13.439 +          <td>(</td>
  13.440 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.441 +          <td class="paramname"><em>array1</em>, </td>
  13.442 +        </tr>
  13.443 +        <tr>
  13.444 +          <td class="paramkey"></td>
  13.445 +          <td></td>
  13.446 +          <td class="paramtype">const <a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.447 +          <td class="paramname"><em>array2</em>&#160;</td>
  13.448 +        </tr>
  13.449 +        <tr>
  13.450 +          <td></td>
  13.451 +          <td>)</td>
  13.452 +          <td></td><td></td>
  13.453 +        </tr>
  13.454 +      </table>
  13.455 +</div><div class="memdoc">
  13.456 +
  13.457 +<p>Concatenates two arrays. </p>
  13.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>
  13.459 +<p>The first array may grow automatically. If this fails, both arrays remain unmodified.</p>
  13.460 +<dl class="params"><dt>Parameters</dt><dd>
  13.461 +  <table class="params">
  13.462 +    <tr><td class="paramname">array1</td><td>first array </td></tr>
  13.463 +    <tr><td class="paramname">array2</td><td>second array </td></tr>
  13.464 +  </table>
  13.465 +  </dd>
  13.466 +</dl>
  13.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>
  13.468 +
  13.469 +</div>
  13.470 +</div>
  13.471 +<a id="a5241058cd2329147bc5b1593ae7e51dc"></a>
  13.472 +<h2 class="memtitle"><span class="permalink"><a href="#a5241058cd2329147bc5b1593ae7e51dc">&#9670;&nbsp;</a></span>ucx_array_contains()</h2>
  13.473 +
  13.474 +<div class="memitem">
  13.475 +<div class="memproto">
  13.476 +      <table class="memname">
  13.477 +        <tr>
  13.478 +          <td class="memname">int ucx_array_contains </td>
  13.479 +          <td>(</td>
  13.480 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const *&#160;</td>
  13.481 +          <td class="paramname"><em>array</em>, </td>
  13.482 +        </tr>
  13.483 +        <tr>
  13.484 +          <td class="paramkey"></td>
  13.485 +          <td></td>
  13.486 +          <td class="paramtype">void *&#160;</td>
  13.487 +          <td class="paramname"><em>elem</em>, </td>
  13.488 +        </tr>
  13.489 +        <tr>
  13.490 +          <td class="paramkey"></td>
  13.491 +          <td></td>
  13.492 +          <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a>&#160;</td>
  13.493 +          <td class="paramname"><em>cmpfnc</em>, </td>
  13.494 +        </tr>
  13.495 +        <tr>
  13.496 +          <td class="paramkey"></td>
  13.497 +          <td></td>
  13.498 +          <td class="paramtype">void *&#160;</td>
  13.499 +          <td class="paramname"><em>data</em>&#160;</td>
  13.500 +        </tr>
  13.501 +        <tr>
  13.502 +          <td></td>
  13.503 +          <td>)</td>
  13.504 +          <td></td><td></td>
  13.505 +        </tr>
  13.506 +      </table>
  13.507 +</div><div class="memdoc">
  13.508 +
  13.509 +<p>Checks, if an array contains a specific element. </p>
  13.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>
  13.511 +<dl class="params"><dt>Parameters</dt><dd>
  13.512 +  <table class="params">
  13.513 +    <tr><td class="paramname">array</td><td>the array where to search for the data </td></tr>
  13.514 +    <tr><td class="paramname">elem</td><td>the element data </td></tr>
  13.515 +    <tr><td class="paramname">cmpfnc</td><td>the compare function </td></tr>
  13.516 +    <tr><td class="paramname">data</td><td>additional data for the compare function </td></tr>
  13.517 +  </table>
  13.518 +  </dd>
  13.519 +</dl>
  13.520 +<dl class="section return"><dt>Returns</dt><dd>1, if and only if the array contains the specified element data </dd></dl>
  13.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>
  13.522 +
  13.523 +</div>
  13.524 +</div>
  13.525 +<a id="a8e83681d8d5d8cddbf10f63ce5be4c10"></a>
  13.526 +<h2 class="memtitle"><span class="permalink"><a href="#a8e83681d8d5d8cddbf10f63ce5be4c10">&#9670;&nbsp;</a></span>ucx_array_destroy()</h2>
  13.527 +
  13.528 +<div class="memitem">
  13.529 +<div class="memproto">
  13.530 +      <table class="memname">
  13.531 +        <tr>
  13.532 +          <td class="memname">void ucx_array_destroy </td>
  13.533 +          <td>(</td>
  13.534 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.535 +          <td class="paramname"><em>array</em></td><td>)</td>
  13.536 +          <td></td>
  13.537 +        </tr>
  13.538 +      </table>
  13.539 +</div><div class="memdoc">
  13.540 +
  13.541 +<p>Destroys the array. </p>
  13.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>
  13.543 +<dl class="params"><dt>Parameters</dt><dd>
  13.544 +  <table class="params">
  13.545 +    <tr><td class="paramname">array</td><td>the array to destroy </td></tr>
  13.546 +  </table>
  13.547 +  </dd>
  13.548 +</dl>
  13.549 +
  13.550 +</div>
  13.551 +</div>
  13.552 +<a id="a43292b448adb1741677aa8c578bcc201"></a>
  13.553 +<h2 class="memtitle"><span class="permalink"><a href="#a43292b448adb1741677aa8c578bcc201">&#9670;&nbsp;</a></span>ucx_array_equals()</h2>
  13.554 +
  13.555 +<div class="memitem">
  13.556 +<div class="memproto">
  13.557 +      <table class="memname">
  13.558 +        <tr>
  13.559 +          <td class="memname">int ucx_array_equals </td>
  13.560 +          <td>(</td>
  13.561 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const *&#160;</td>
  13.562 +          <td class="paramname"><em>array1</em>, </td>
  13.563 +        </tr>
  13.564 +        <tr>
  13.565 +          <td class="paramkey"></td>
  13.566 +          <td></td>
  13.567 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const *&#160;</td>
  13.568 +          <td class="paramname"><em>array2</em>, </td>
  13.569 +        </tr>
  13.570 +        <tr>
  13.571 +          <td class="paramkey"></td>
  13.572 +          <td></td>
  13.573 +          <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a>&#160;</td>
  13.574 +          <td class="paramname"><em>cmpfnc</em>, </td>
  13.575 +        </tr>
  13.576 +        <tr>
  13.577 +          <td class="paramkey"></td>
  13.578 +          <td></td>
  13.579 +          <td class="paramtype">void *&#160;</td>
  13.580 +          <td class="paramname"><em>data</em>&#160;</td>
  13.581 +        </tr>
  13.582 +        <tr>
  13.583 +          <td></td>
  13.584 +          <td>)</td>
  13.585 +          <td></td><td></td>
  13.586 +        </tr>
  13.587 +      </table>
  13.588 +</div><div class="memdoc">
  13.589 +
  13.590 +<p>Compares two UCX arrays element-wise by using a compare function. </p>
  13.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>
  13.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>
  13.593 +<dl class="params"><dt>Parameters</dt><dd>
  13.594 +  <table class="params">
  13.595 +    <tr><td class="paramname">array1</td><td>the first array </td></tr>
  13.596 +    <tr><td class="paramname">array2</td><td>the second array </td></tr>
  13.597 +    <tr><td class="paramname">cmpfnc</td><td>the compare function </td></tr>
  13.598 +    <tr><td class="paramname">data</td><td>additional data for the compare function </td></tr>
  13.599 +  </table>
  13.600 +  </dd>
  13.601 +</dl>
  13.602 +<dl class="section return"><dt>Returns</dt><dd>1, if and only if the two arrays equal element-wise, 0 otherwise </dd></dl>
  13.603 +
  13.604 +</div>
  13.605 +</div>
  13.606 +<a id="ae7bdbed94afee9b20b38b95e3ab470f0"></a>
  13.607 +<h2 class="memtitle"><span class="permalink"><a href="#ae7bdbed94afee9b20b38b95e3ab470f0">&#9670;&nbsp;</a></span>ucx_array_find()</h2>
  13.608 +
  13.609 +<div class="memitem">
  13.610 +<div class="memproto">
  13.611 +      <table class="memname">
  13.612 +        <tr>
  13.613 +          <td class="memname">size_t ucx_array_find </td>
  13.614 +          <td>(</td>
  13.615 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> const *&#160;</td>
  13.616 +          <td class="paramname"><em>array</em>, </td>
  13.617 +        </tr>
  13.618 +        <tr>
  13.619 +          <td class="paramkey"></td>
  13.620 +          <td></td>
  13.621 +          <td class="paramtype">void *&#160;</td>
  13.622 +          <td class="paramname"><em>elem</em>, </td>
  13.623 +        </tr>
  13.624 +        <tr>
  13.625 +          <td class="paramkey"></td>
  13.626 +          <td></td>
  13.627 +          <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a>&#160;</td>
  13.628 +          <td class="paramname"><em>cmpfnc</em>, </td>
  13.629 +        </tr>
  13.630 +        <tr>
  13.631 +          <td class="paramkey"></td>
  13.632 +          <td></td>
  13.633 +          <td class="paramtype">void *&#160;</td>
  13.634 +          <td class="paramname"><em>data</em>&#160;</td>
  13.635 +        </tr>
  13.636 +        <tr>
  13.637 +          <td></td>
  13.638 +          <td>)</td>
  13.639 +          <td></td><td></td>
  13.640 +        </tr>
  13.641 +      </table>
  13.642 +</div><div class="memdoc">
  13.643 +
  13.644 +<p>Returns the index of an element containing the specified data. </p>
  13.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>
  13.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>
  13.647 +<dl class="params"><dt>Parameters</dt><dd>
  13.648 +  <table class="params">
  13.649 +    <tr><td class="paramname">array</td><td>the array where to search for the data </td></tr>
  13.650 +    <tr><td class="paramname">elem</td><td>the element data </td></tr>
  13.651 +    <tr><td class="paramname">cmpfnc</td><td>the compare function </td></tr>
  13.652 +    <tr><td class="paramname">data</td><td>additional data for the compare function </td></tr>
  13.653 +  </table>
  13.654 +  </dd>
  13.655 +</dl>
  13.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>
  13.657 +
  13.658 +</div>
  13.659 +</div>
  13.660 +<a id="ac01ee914468a16f470bf3071fffbe438"></a>
  13.661 +<h2 class="memtitle"><span class="permalink"><a href="#ac01ee914468a16f470bf3071fffbe438">&#9670;&nbsp;</a></span>ucx_array_free()</h2>
  13.662 +
  13.663 +<div class="memitem">
  13.664 +<div class="memproto">
  13.665 +      <table class="memname">
  13.666 +        <tr>
  13.667 +          <td class="memname">void ucx_array_free </td>
  13.668 +          <td>(</td>
  13.669 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.670 +          <td class="paramname"><em>array</em></td><td>)</td>
  13.671 +          <td></td>
  13.672 +        </tr>
  13.673 +      </table>
  13.674 +</div><div class="memdoc">
  13.675 +
  13.676 +<p>Destroys and frees the array. </p>
  13.677 +<dl class="params"><dt>Parameters</dt><dd>
  13.678 +  <table class="params">
  13.679 +    <tr><td class="paramname">array</td><td>the array to free </td></tr>
  13.680 +  </table>
  13.681 +  </dd>
  13.682 +</dl>
  13.683 +
  13.684 +</div>
  13.685 +</div>
  13.686 +<a id="ab0cbf243824aaebee48277315e03afce"></a>
  13.687 +<h2 class="memtitle"><span class="permalink"><a href="#ab0cbf243824aaebee48277315e03afce">&#9670;&nbsp;</a></span>ucx_array_grow()</h2>
  13.688 +
  13.689 +<div class="memitem">
  13.690 +<div class="memproto">
  13.691 +      <table class="memname">
  13.692 +        <tr>
  13.693 +          <td class="memname">int ucx_array_grow </td>
  13.694 +          <td>(</td>
  13.695 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.696 +          <td class="paramname"><em>array</em>, </td>
  13.697 +        </tr>
  13.698 +        <tr>
  13.699 +          <td class="paramkey"></td>
  13.700 +          <td></td>
  13.701 +          <td class="paramtype">size_t&#160;</td>
  13.702 +          <td class="paramname"><em>count</em>&#160;</td>
  13.703 +        </tr>
  13.704 +        <tr>
  13.705 +          <td></td>
  13.706 +          <td>)</td>
  13.707 +          <td></td><td></td>
  13.708 +        </tr>
  13.709 +      </table>
  13.710 +</div><div class="memdoc">
  13.711 +
  13.712 +<p>Resizes the capacity, if the specified number of elements would not fit. </p>
  13.713 +<p>A call to ucx_array_grow(array, count) is effectively the same as ucx_array_reserve(array, array-&gt;size+count).</p>
  13.714 +<dl class="params"><dt>Parameters</dt><dd>
  13.715 +  <table class="params">
  13.716 +    <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
  13.717 +    <tr><td class="paramname">count</td><td>the number of elements that should additionally fit into the array </td></tr>
  13.718 +  </table>
  13.719 +  </dd>
  13.720 +</dl>
  13.721 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
  13.722 +
  13.723 +</div>
  13.724 +</div>
  13.725 +<a id="ad921e85c28ffae32230777a53c5037e5"></a>
  13.726 +<h2 class="memtitle"><span class="permalink"><a href="#ad921e85c28ffae32230777a53c5037e5">&#9670;&nbsp;</a></span>ucx_array_init()</h2>
  13.727 +
  13.728 +<div class="memitem">
  13.729 +<div class="memproto">
  13.730 +      <table class="memname">
  13.731 +        <tr>
  13.732 +          <td class="memname">void ucx_array_init </td>
  13.733 +          <td>(</td>
  13.734 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.735 +          <td class="paramname"><em>array</em>, </td>
  13.736 +        </tr>
  13.737 +        <tr>
  13.738 +          <td class="paramkey"></td>
  13.739 +          <td></td>
  13.740 +          <td class="paramtype">size_t&#160;</td>
  13.741 +          <td class="paramname"><em>capacity</em>, </td>
  13.742 +        </tr>
  13.743 +        <tr>
  13.744 +          <td class="paramkey"></td>
  13.745 +          <td></td>
  13.746 +          <td class="paramtype">size_t&#160;</td>
  13.747 +          <td class="paramname"><em>elemsize</em>&#160;</td>
  13.748 +        </tr>
  13.749 +        <tr>
  13.750 +          <td></td>
  13.751 +          <td>)</td>
  13.752 +          <td></td><td></td>
  13.753 +        </tr>
  13.754 +      </table>
  13.755 +</div><div class="memdoc">
  13.756 +
  13.757 +<p>Initializes a UCX array structure with the given capacity and element size. </p>
  13.758 +<p>The structure must be uninitialized as the data pointer will be overwritten.</p>
  13.759 +<dl class="params"><dt>Parameters</dt><dd>
  13.760 +  <table class="params">
  13.761 +    <tr><td class="paramname">array</td><td>the structure to initialize </td></tr>
  13.762 +    <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
  13.763 +    <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
  13.764 +  </table>
  13.765 +  </dd>
  13.766 +</dl>
  13.767 +
  13.768 +</div>
  13.769 +</div>
  13.770 +<a id="a2451e61ebb15a7ba1c1319267ba75b8c"></a>
  13.771 +<h2 class="memtitle"><span class="permalink"><a href="#a2451e61ebb15a7ba1c1319267ba75b8c">&#9670;&nbsp;</a></span>ucx_array_init_a()</h2>
  13.772 +
  13.773 +<div class="memitem">
  13.774 +<div class="memproto">
  13.775 +      <table class="memname">
  13.776 +        <tr>
  13.777 +          <td class="memname">void ucx_array_init_a </td>
  13.778 +          <td>(</td>
  13.779 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.780 +          <td class="paramname"><em>array</em>, </td>
  13.781 +        </tr>
  13.782 +        <tr>
  13.783 +          <td class="paramkey"></td>
  13.784 +          <td></td>
  13.785 +          <td class="paramtype">size_t&#160;</td>
  13.786 +          <td class="paramname"><em>capacity</em>, </td>
  13.787 +        </tr>
  13.788 +        <tr>
  13.789 +          <td class="paramkey"></td>
  13.790 +          <td></td>
  13.791 +          <td class="paramtype">size_t&#160;</td>
  13.792 +          <td class="paramname"><em>elemsize</em>, </td>
  13.793 +        </tr>
  13.794 +        <tr>
  13.795 +          <td class="paramkey"></td>
  13.796 +          <td></td>
  13.797 +          <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td>
  13.798 +          <td class="paramname"><em>allocator</em>&#160;</td>
  13.799 +        </tr>
  13.800 +        <tr>
  13.801 +          <td></td>
  13.802 +          <td>)</td>
  13.803 +          <td></td><td></td>
  13.804 +        </tr>
  13.805 +      </table>
  13.806 +</div><div class="memdoc">
  13.807 +
  13.808 +<p>Initializes a UCX array structure using the specified allocator. </p>
  13.809 +<p>The structure must be uninitialized as the data pointer will be overwritten.</p>
  13.810 +<dl class="params"><dt>Parameters</dt><dd>
  13.811 +  <table class="params">
  13.812 +    <tr><td class="paramname">array</td><td>the structure to initialize </td></tr>
  13.813 +    <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
  13.814 +    <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
  13.815 +    <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
  13.816 +  </table>
  13.817 +  </dd>
  13.818 +</dl>
  13.819 +
  13.820 +</div>
  13.821 +</div>
  13.822 +<a id="a994a2fbf1c33a3833e2a70cd9a4352b7"></a>
  13.823 +<h2 class="memtitle"><span class="permalink"><a href="#a994a2fbf1c33a3833e2a70cd9a4352b7">&#9670;&nbsp;</a></span>ucx_array_new()</h2>
  13.824 +
  13.825 +<div class="memitem">
  13.826 +<div class="memproto">
  13.827 +      <table class="memname">
  13.828 +        <tr>
  13.829 +          <td class="memname"><a class="el" href="structUcxArray.html">UcxArray</a>* ucx_array_new </td>
  13.830 +          <td>(</td>
  13.831 +          <td class="paramtype">size_t&#160;</td>
  13.832 +          <td class="paramname"><em>capacity</em>, </td>
  13.833 +        </tr>
  13.834 +        <tr>
  13.835 +          <td class="paramkey"></td>
  13.836 +          <td></td>
  13.837 +          <td class="paramtype">size_t&#160;</td>
  13.838 +          <td class="paramname"><em>elemsize</em>&#160;</td>
  13.839 +        </tr>
  13.840 +        <tr>
  13.841 +          <td></td>
  13.842 +          <td>)</td>
  13.843 +          <td></td><td></td>
  13.844 +        </tr>
  13.845 +      </table>
  13.846 +</div><div class="memdoc">
  13.847 +
  13.848 +<p>Creates a new UCX array with the given capacity and element size. </p>
  13.849 +<dl class="params"><dt>Parameters</dt><dd>
  13.850 +  <table class="params">
  13.851 +    <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
  13.852 +    <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
  13.853 +  </table>
  13.854 +  </dd>
  13.855 +</dl>
  13.856 +<dl class="section return"><dt>Returns</dt><dd>a pointer to a new UCX array structure </dd></dl>
  13.857 +
  13.858 +</div>
  13.859 +</div>
  13.860 +<a id="a177170258c215eb2e4f5a32e59f0cb1b"></a>
  13.861 +<h2 class="memtitle"><span class="permalink"><a href="#a177170258c215eb2e4f5a32e59f0cb1b">&#9670;&nbsp;</a></span>ucx_array_new_a()</h2>
  13.862 +
  13.863 +<div class="memitem">
  13.864 +<div class="memproto">
  13.865 +      <table class="memname">
  13.866 +        <tr>
  13.867 +          <td class="memname"><a class="el" href="structUcxArray.html">UcxArray</a>* ucx_array_new_a </td>
  13.868 +          <td>(</td>
  13.869 +          <td class="paramtype">size_t&#160;</td>
  13.870 +          <td class="paramname"><em>capacity</em>, </td>
  13.871 +        </tr>
  13.872 +        <tr>
  13.873 +          <td class="paramkey"></td>
  13.874 +          <td></td>
  13.875 +          <td class="paramtype">size_t&#160;</td>
  13.876 +          <td class="paramname"><em>elemsize</em>, </td>
  13.877 +        </tr>
  13.878 +        <tr>
  13.879 +          <td class="paramkey"></td>
  13.880 +          <td></td>
  13.881 +          <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td>
  13.882 +          <td class="paramname"><em>allocator</em>&#160;</td>
  13.883 +        </tr>
  13.884 +        <tr>
  13.885 +          <td></td>
  13.886 +          <td>)</td>
  13.887 +          <td></td><td></td>
  13.888 +        </tr>
  13.889 +      </table>
  13.890 +</div><div class="memdoc">
  13.891 +
  13.892 +<p>Creates a new UCX array using the specified allocator. </p>
  13.893 +<dl class="params"><dt>Parameters</dt><dd>
  13.894 +  <table class="params">
  13.895 +    <tr><td class="paramname">capacity</td><td>the initial capacity </td></tr>
  13.896 +    <tr><td class="paramname">elemsize</td><td>the element size </td></tr>
  13.897 +    <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
  13.898 +  </table>
  13.899 +  </dd>
  13.900 +</dl>
  13.901 +<dl class="section return"><dt>Returns</dt><dd>a pointer to new UCX array structure </dd></dl>
  13.902 +
  13.903 +</div>
  13.904 +</div>
  13.905 +<a id="a95b52acc2193b5c33cf0eaa4f2082477"></a>
  13.906 +<h2 class="memtitle"><span class="permalink"><a href="#a95b52acc2193b5c33cf0eaa4f2082477">&#9670;&nbsp;</a></span>ucx_array_prepend_from()</h2>
  13.907 +
  13.908 +<div class="memitem">
  13.909 +<div class="memproto">
  13.910 +      <table class="memname">
  13.911 +        <tr>
  13.912 +          <td class="memname">int ucx_array_prepend_from </td>
  13.913 +          <td>(</td>
  13.914 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.915 +          <td class="paramname"><em>array</em>, </td>
  13.916 +        </tr>
  13.917 +        <tr>
  13.918 +          <td class="paramkey"></td>
  13.919 +          <td></td>
  13.920 +          <td class="paramtype">void *&#160;</td>
  13.921 +          <td class="paramname"><em>data</em>, </td>
  13.922 +        </tr>
  13.923 +        <tr>
  13.924 +          <td class="paramkey"></td>
  13.925 +          <td></td>
  13.926 +          <td class="paramtype">size_t&#160;</td>
  13.927 +          <td class="paramname"><em>count</em>&#160;</td>
  13.928 +        </tr>
  13.929 +        <tr>
  13.930 +          <td></td>
  13.931 +          <td>)</td>
  13.932 +          <td></td><td></td>
  13.933 +        </tr>
  13.934 +      </table>
  13.935 +</div><div class="memdoc">
  13.936 +
  13.937 +<p>Inserts elements at the beginning of the array. </p>
  13.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>
  13.939 +<dl class="params"><dt>Parameters</dt><dd>
  13.940 +  <table class="params">
  13.941 +    <tr><td class="paramname">array</td><td>a pointer the array where to prepend the data </td></tr>
  13.942 +    <tr><td class="paramname">data</td><td>a pointer to the data to insert (may be <code>NULL</code>) </td></tr>
  13.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>
  13.944 +  </table>
  13.945 +  </dd>
  13.946 +</dl>
  13.947 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if a reallocation was necessary but failed </dd></dl>
  13.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>
  13.949 +<dd>
  13.950 +<a class="el" href="array_8h.html#a1bb545d065358d265d80d815ba382a28" title="Sets elements starting at the specified index. ">ucx_array_set_from()</a> </dd>
  13.951 +<dd>
  13.952 +ucx_array_prepend() </dd></dl>
  13.953 +
  13.954 +</div>
  13.955 +</div>
  13.956 +<a id="aa45eac6b697f83adac81c0860cf306b8"></a>
  13.957 +<h2 class="memtitle"><span class="permalink"><a href="#aa45eac6b697f83adac81c0860cf306b8">&#9670;&nbsp;</a></span>ucx_array_remove()</h2>
  13.958 +
  13.959 +<div class="memitem">
  13.960 +<div class="memproto">
  13.961 +      <table class="memname">
  13.962 +        <tr>
  13.963 +          <td class="memname">void ucx_array_remove </td>
  13.964 +          <td>(</td>
  13.965 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
  13.966 +          <td class="paramname"><em>array</em>, </td>
  13.967 +        </tr>
  13.968 +        <tr>
  13.969 +          <td class="paramkey"></td>
  13.970 +          <td></td>
  13.971 +          <td class="paramtype">size_t&#160;</td>
  13.972 +          <td class="paramname"><em>index</em>&#160;</td>
  13.973 +        </tr>
  13.974 +        <tr>
  13.975 +          <td></td>
  13.976 +          <td>)</td>
  13.977 +          <td></td><td></td>
  13.978 +        </tr>
  13.979 +      </table>
  13.980 +</div><div class="memdoc">
  13.981 +
  13.982 +<p>Removes an element from the array. </p>
  13.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>
  13.984 +<dl class="params"><dt>Parameters</dt><dd>
  13.985 +  <table class="params">
  13.986 +    <tr><td class="paramname">array</td><td>pointer to the array from which the element shall be removed </td></tr>
  13.987 +    <tr><td class="paramname">index</td><td>the index of the element to remove </td></tr>
  13.988 +  </table>
  13.989 +  </dd>
  13.990 +</dl>
  13.991 +
  13.992 +</div>
  13.993 +</div>
  13.994 +<a id="a548d81b07612bae3ba8c4c4b49104b8e"></a>
  13.995 +<h2 class="memtitle"><span class="permalink"><a href="#a548d81b07612bae3ba8c4c4b49104b8e">&#9670;&nbsp;</a></span>ucx_array_remove_fast()</h2>
  13.996 +
  13.997 +<div class="memitem">
  13.998 +<div class="memproto">
  13.999 +      <table class="memname">
 13.1000 +        <tr>
 13.1001 +          <td class="memname">void ucx_array_remove_fast </td>
 13.1002 +          <td>(</td>
 13.1003 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
 13.1004 +          <td class="paramname"><em>array</em>, </td>
 13.1005 +        </tr>
 13.1006 +        <tr>
 13.1007 +          <td class="paramkey"></td>
 13.1008 +          <td></td>
 13.1009 +          <td class="paramtype">size_t&#160;</td>
 13.1010 +          <td class="paramname"><em>index</em>&#160;</td>
 13.1011 +        </tr>
 13.1012 +        <tr>
 13.1013 +          <td></td>
 13.1014 +          <td>)</td>
 13.1015 +          <td></td><td></td>
 13.1016 +        </tr>
 13.1017 +      </table>
 13.1018 +</div><div class="memdoc">
 13.1019 +
 13.1020 +<p>Removes an element from the array. </p>
 13.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>
 13.1022 +<dl class="params"><dt>Parameters</dt><dd>
 13.1023 +  <table class="params">
 13.1024 +    <tr><td class="paramname">array</td><td>pointer to the array from which the element shall be removed </td></tr>
 13.1025 +    <tr><td class="paramname">index</td><td>the index of the element to remove </td></tr>
 13.1026 +  </table>
 13.1027 +  </dd>
 13.1028 +</dl>
 13.1029 +
 13.1030 +</div>
 13.1031 +</div>
 13.1032 +<a id="a1c3bf8433c1de3c933f3854ab297fe1d"></a>
 13.1033 +<h2 class="memtitle"><span class="permalink"><a href="#a1c3bf8433c1de3c933f3854ab297fe1d">&#9670;&nbsp;</a></span>ucx_array_reserve()</h2>
 13.1034 +
 13.1035 +<div class="memitem">
 13.1036 +<div class="memproto">
 13.1037 +      <table class="memname">
 13.1038 +        <tr>
 13.1039 +          <td class="memname">int ucx_array_reserve </td>
 13.1040 +          <td>(</td>
 13.1041 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
 13.1042 +          <td class="paramname"><em>array</em>, </td>
 13.1043 +        </tr>
 13.1044 +        <tr>
 13.1045 +          <td class="paramkey"></td>
 13.1046 +          <td></td>
 13.1047 +          <td class="paramtype">size_t&#160;</td>
 13.1048 +          <td class="paramname"><em>capacity</em>&#160;</td>
 13.1049 +        </tr>
 13.1050 +        <tr>
 13.1051 +          <td></td>
 13.1052 +          <td>)</td>
 13.1053 +          <td></td><td></td>
 13.1054 +        </tr>
 13.1055 +      </table>
 13.1056 +</div><div class="memdoc">
 13.1057 +
 13.1058 +<p>Resizes the array only, if the capacity is insufficient. </p>
 13.1059 +<p>If the requested capacity is smaller than the current capacity, this function does nothing.</p>
 13.1060 +<dl class="params"><dt>Parameters</dt><dd>
 13.1061 +  <table class="params">
 13.1062 +    <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
 13.1063 +    <tr><td class="paramname">capacity</td><td>the guaranteed capacity </td></tr>
 13.1064 +  </table>
 13.1065 +  </dd>
 13.1066 +</dl>
 13.1067 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
 13.1068 +
 13.1069 +</div>
 13.1070 +</div>
 13.1071 +<a id="a27762e7c06a6c781015e3c8ceeee0ce3"></a>
 13.1072 +<h2 class="memtitle"><span class="permalink"><a href="#a27762e7c06a6c781015e3c8ceeee0ce3">&#9670;&nbsp;</a></span>ucx_array_resize()</h2>
 13.1073 +
 13.1074 +<div class="memitem">
 13.1075 +<div class="memproto">
 13.1076 +      <table class="memname">
 13.1077 +        <tr>
 13.1078 +          <td class="memname">int ucx_array_resize </td>
 13.1079 +          <td>(</td>
 13.1080 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
 13.1081 +          <td class="paramname"><em>array</em>, </td>
 13.1082 +        </tr>
 13.1083 +        <tr>
 13.1084 +          <td class="paramkey"></td>
 13.1085 +          <td></td>
 13.1086 +          <td class="paramtype">size_t&#160;</td>
 13.1087 +          <td class="paramname"><em>capacity</em>&#160;</td>
 13.1088 +        </tr>
 13.1089 +        <tr>
 13.1090 +          <td></td>
 13.1091 +          <td>)</td>
 13.1092 +          <td></td><td></td>
 13.1093 +        </tr>
 13.1094 +      </table>
 13.1095 +</div><div class="memdoc">
 13.1096 +
 13.1097 +<p>Sets the capacity of the array. </p>
 13.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>
 13.1099 +<dl class="params"><dt>Parameters</dt><dd>
 13.1100 +  <table class="params">
 13.1101 +    <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
 13.1102 +    <tr><td class="paramname">capacity</td><td>the new capacity </td></tr>
 13.1103 +  </table>
 13.1104 +  </dd>
 13.1105 +</dl>
 13.1106 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
 13.1107 +
 13.1108 +</div>
 13.1109 +</div>
 13.1110 +<a id="a1bb545d065358d265d80d815ba382a28"></a>
 13.1111 +<h2 class="memtitle"><span class="permalink"><a href="#a1bb545d065358d265d80d815ba382a28">&#9670;&nbsp;</a></span>ucx_array_set_from()</h2>
 13.1112 +
 13.1113 +<div class="memitem">
 13.1114 +<div class="memproto">
 13.1115 +      <table class="memname">
 13.1116 +        <tr>
 13.1117 +          <td class="memname">int ucx_array_set_from </td>
 13.1118 +          <td>(</td>
 13.1119 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
 13.1120 +          <td class="paramname"><em>array</em>, </td>
 13.1121 +        </tr>
 13.1122 +        <tr>
 13.1123 +          <td class="paramkey"></td>
 13.1124 +          <td></td>
 13.1125 +          <td class="paramtype">size_t&#160;</td>
 13.1126 +          <td class="paramname"><em>index</em>, </td>
 13.1127 +        </tr>
 13.1128 +        <tr>
 13.1129 +          <td class="paramkey"></td>
 13.1130 +          <td></td>
 13.1131 +          <td class="paramtype">void *&#160;</td>
 13.1132 +          <td class="paramname"><em>data</em>, </td>
 13.1133 +        </tr>
 13.1134 +        <tr>
 13.1135 +          <td class="paramkey"></td>
 13.1136 +          <td></td>
 13.1137 +          <td class="paramtype">size_t&#160;</td>
 13.1138 +          <td class="paramname"><em>count</em>&#160;</td>
 13.1139 +        </tr>
 13.1140 +        <tr>
 13.1141 +          <td></td>
 13.1142 +          <td>)</td>
 13.1143 +          <td></td><td></td>
 13.1144 +        </tr>
 13.1145 +      </table>
 13.1146 +</div><div class="memdoc">
 13.1147 +
 13.1148 +<p>Sets elements starting at the specified index. </p>
 13.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>
 13.1150 +<dl class="params"><dt>Parameters</dt><dd>
 13.1151 +  <table class="params">
 13.1152 +    <tr><td class="paramname">array</td><td>a pointer the array where to set the data </td></tr>
 13.1153 +    <tr><td class="paramname">index</td><td>the index of the element to set </td></tr>
 13.1154 +    <tr><td class="paramname">data</td><td>a pointer to the data to insert (may be <code>NULL</code>) </td></tr>
 13.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>
 13.1156 +  </table>
 13.1157 +  </dd>
 13.1158 +</dl>
 13.1159 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if a reallocation was necessary but failed </dd></dl>
 13.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>
 13.1161 +<dd>
 13.1162 +ucx_array_set() </dd></dl>
 13.1163 +
 13.1164 +</div>
 13.1165 +</div>
 13.1166 +<a id="a2daf50e80aee9bccebee876a7efd2dfc"></a>
 13.1167 +<h2 class="memtitle"><span class="permalink"><a href="#a2daf50e80aee9bccebee876a7efd2dfc">&#9670;&nbsp;</a></span>ucx_array_shrink()</h2>
 13.1168 +
 13.1169 +<div class="memitem">
 13.1170 +<div class="memproto">
 13.1171 +      <table class="memname">
 13.1172 +        <tr>
 13.1173 +          <td class="memname">int ucx_array_shrink </td>
 13.1174 +          <td>(</td>
 13.1175 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
 13.1176 +          <td class="paramname"><em>array</em></td><td>)</td>
 13.1177 +          <td></td>
 13.1178 +        </tr>
 13.1179 +      </table>
 13.1180 +</div><div class="memdoc">
 13.1181 +
 13.1182 +<p>Shrinks the memory to exactly fit the contents. </p>
 13.1183 +<p>After this operation, the capacity equals the size.</p>
 13.1184 +<dl class="params"><dt>Parameters</dt><dd>
 13.1185 +  <table class="params">
 13.1186 +    <tr><td class="paramname">array</td><td>a pointer to the array </td></tr>
 13.1187 +  </table>
 13.1188 +  </dd>
 13.1189 +</dl>
 13.1190 +<dl class="section return"><dt>Returns</dt><dd>zero on success, non-zero if reallocation failed </dd></dl>
 13.1191 +
 13.1192 +</div>
 13.1193 +</div>
 13.1194 +<a id="add773514569b872a6624381b4b6af52c"></a>
 13.1195 +<h2 class="memtitle"><span class="permalink"><a href="#add773514569b872a6624381b4b6af52c">&#9670;&nbsp;</a></span>ucx_array_sort()</h2>
 13.1196 +
 13.1197 +<div class="memitem">
 13.1198 +<div class="memproto">
 13.1199 +      <table class="memname">
 13.1200 +        <tr>
 13.1201 +          <td class="memname">void ucx_array_sort </td>
 13.1202 +          <td>(</td>
 13.1203 +          <td class="paramtype"><a class="el" href="structUcxArray.html">UcxArray</a> *&#160;</td>
 13.1204 +          <td class="paramname"><em>array</em>, </td>
 13.1205 +        </tr>
 13.1206 +        <tr>
 13.1207 +          <td class="paramkey"></td>
 13.1208 +          <td></td>
 13.1209 +          <td class="paramtype"><a class="el" href="ucx_8h.html#afe5e2d5dbf34778e0e97852051570791">cmp_func</a>&#160;</td>
 13.1210 +          <td class="paramname"><em>cmpfnc</em>, </td>
 13.1211 +        </tr>
 13.1212 +        <tr>
 13.1213 +          <td class="paramkey"></td>
 13.1214 +          <td></td>
 13.1215 +          <td class="paramtype">void *&#160;</td>
 13.1216 +          <td class="paramname"><em>data</em>&#160;</td>
 13.1217 +        </tr>
 13.1218 +        <tr>
 13.1219 +          <td></td>
 13.1220 +          <td>)</td>
 13.1221 +          <td></td><td></td>
 13.1222 +        </tr>
 13.1223 +      </table>
 13.1224 +</div><div class="memdoc">
 13.1225 +
 13.1226 +<p>Sorts a <a class="el" href="structUcxArray.html" title="UCX array type. ">UcxArray</a> with the best available sort algorithm. </p>
 13.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>
 13.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>
 13.1229 +<dl class="params"><dt>Parameters</dt><dd>
 13.1230 +  <table class="params">
 13.1231 +    <tr><td class="paramname">array</td><td>the array to sort </td></tr>
 13.1232 +    <tr><td class="paramname">cmpfnc</td><td>the function that shall be used to compare the element data </td></tr>
 13.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>
 13.1234 +  </table>
 13.1235 +  </dd>
 13.1236 +</dl>
 13.1237 +
 13.1238 +</div>
 13.1239 +</div>
 13.1240 +<a id="ad0a8d76980cf1c1910e64a245803fb9a"></a>
 13.1241 +<h2 class="memtitle"><span class="permalink"><a href="#ad0a8d76980cf1c1910e64a245803fb9a">&#9670;&nbsp;</a></span>ucx_array_util_set_a()</h2>
 13.1242 +
 13.1243 +<div class="memitem">
 13.1244 +<div class="memproto">
 13.1245 +      <table class="memname">
 13.1246 +        <tr>
 13.1247 +          <td class="memname">int ucx_array_util_set_a </td>
 13.1248 +          <td>(</td>
 13.1249 +          <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td>
 13.1250 +          <td class="paramname"><em>alloc</em>, </td>
 13.1251 +        </tr>
 13.1252 +        <tr>
 13.1253 +          <td class="paramkey"></td>
 13.1254 +          <td></td>
 13.1255 +          <td class="paramtype">void **&#160;</td>
 13.1256 +          <td class="paramname"><em>array</em>, </td>
 13.1257 +        </tr>
 13.1258 +        <tr>
 13.1259 +          <td class="paramkey"></td>
 13.1260 +          <td></td>
 13.1261 +          <td class="paramtype">size_t *&#160;</td>
 13.1262 +          <td class="paramname"><em>capacity</em>, </td>
 13.1263 +        </tr>
 13.1264 +        <tr>
 13.1265 +          <td class="paramkey"></td>
 13.1266 +          <td></td>
 13.1267 +          <td class="paramtype">size_t&#160;</td>
 13.1268 +          <td class="paramname"><em>elmsize</em>, </td>
 13.1269 +        </tr>
 13.1270 +        <tr>
 13.1271 +          <td class="paramkey"></td>
 13.1272 +          <td></td>
 13.1273 +          <td class="paramtype">size_t&#160;</td>
 13.1274 +          <td class="paramname"><em>idx</em>, </td>
 13.1275 +        </tr>
 13.1276 +        <tr>
 13.1277 +          <td class="paramkey"></td>
 13.1278 +          <td></td>
 13.1279 +          <td class="paramtype">void *&#160;</td>
 13.1280 +          <td class="paramname"><em>data</em>&#160;</td>
 13.1281 +        </tr>
 13.1282 +        <tr>
 13.1283 +          <td></td>
 13.1284 +          <td>)</td>
 13.1285 +          <td></td><td></td>
 13.1286 +        </tr>
 13.1287 +      </table>
 13.1288 +</div><div class="memdoc">
 13.1289 +
 13.1290 +<p>Sets an element in an arbitrary user defined array. </p>
 13.1291 +<p>The data is copied from the specified data location.</p>
 13.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>
 13.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>
 13.1294 +<dl class="params"><dt>Parameters</dt><dd>
 13.1295 +  <table class="params">
 13.1296 +    <tr><td class="paramname">alloc</td><td>the allocator that shall be used to reallocate the array </td></tr>
 13.1297 +    <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
 13.1298 +    <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
 13.1299 +    <tr><td class="paramname">elmsize</td><td>the size of each element </td></tr>
 13.1300 +    <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
 13.1301 +    <tr><td class="paramname">data</td><td>a pointer to the element data </td></tr>
 13.1302 +  </table>
 13.1303 +  </dd>
 13.1304 +</dl>
 13.1305 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
 13.1306 +
 13.1307 +</div>
 13.1308 +</div>
 13.1309 +<a id="ad708b333c0c1b02c998309a58ea65e31"></a>
 13.1310 +<h2 class="memtitle"><span class="permalink"><a href="#ad708b333c0c1b02c998309a58ea65e31">&#9670;&nbsp;</a></span>ucx_array_util_setptr_a()</h2>
 13.1311 +
 13.1312 +<div class="memitem">
 13.1313 +<div class="memproto">
 13.1314 +      <table class="memname">
 13.1315 +        <tr>
 13.1316 +          <td class="memname">int ucx_array_util_setptr_a </td>
 13.1317 +          <td>(</td>
 13.1318 +          <td class="paramtype"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> *&#160;</td>
 13.1319 +          <td class="paramname"><em>alloc</em>, </td>
 13.1320 +        </tr>
 13.1321 +        <tr>
 13.1322 +          <td class="paramkey"></td>
 13.1323 +          <td></td>
 13.1324 +          <td class="paramtype">void **&#160;</td>
 13.1325 +          <td class="paramname"><em>array</em>, </td>
 13.1326 +        </tr>
 13.1327 +        <tr>
 13.1328 +          <td class="paramkey"></td>
 13.1329 +          <td></td>
 13.1330 +          <td class="paramtype">size_t *&#160;</td>
 13.1331 +          <td class="paramname"><em>capacity</em>, </td>
 13.1332 +        </tr>
 13.1333 +        <tr>
 13.1334 +          <td class="paramkey"></td>
 13.1335 +          <td></td>
 13.1336 +          <td class="paramtype">size_t&#160;</td>
 13.1337 +          <td class="paramname"><em>idx</em>, </td>
 13.1338 +        </tr>
 13.1339 +        <tr>
 13.1340 +          <td class="paramkey"></td>
 13.1341 +          <td></td>
 13.1342 +          <td class="paramtype">void *&#160;</td>
 13.1343 +          <td class="paramname"><em>ptr</em>&#160;</td>
 13.1344 +        </tr>
 13.1345 +        <tr>
 13.1346 +          <td></td>
 13.1347 +          <td>)</td>
 13.1348 +          <td></td><td></td>
 13.1349 +        </tr>
 13.1350 +      </table>
 13.1351 +</div><div class="memdoc">
 13.1352 +
 13.1353 +<p>Stores a pointer in an arbitrary user defined array. </p>
 13.1354 +<p>The element size of the array must be sizeof(void*).</p>
 13.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>
 13.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>
 13.1357 +<dl class="params"><dt>Parameters</dt><dd>
 13.1358 +  <table class="params">
 13.1359 +    <tr><td class="paramname">alloc</td><td>the allocator that shall be used to reallocate the array </td></tr>
 13.1360 +    <tr><td class="paramname">array</td><td>a pointer to location of the array pointer </td></tr>
 13.1361 +    <tr><td class="paramname">capacity</td><td>a pointer to the capacity </td></tr>
 13.1362 +    <tr><td class="paramname">idx</td><td>the index of the element to set </td></tr>
 13.1363 +    <tr><td class="paramname">ptr</td><td>the pointer to store </td></tr>
 13.1364 +  </table>
 13.1365 +  </dd>
 13.1366 +</dl>
 13.1367 +<dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on error (errno will be set) </dd></dl>
 13.1368 +
 13.1369 +</div>
 13.1370 +</div>
 13.1371 +</div><!-- contents -->
 13.1372 +<!-- start footer part -->
 13.1373 +<hr class="footer"/><address class="footer"><small>
 13.1374 +Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
 13.1375 +<img class="footer" src="doxygen.png" alt="doxygen"/>
 13.1376 +</a> 1.8.13
 13.1377 +</small></address>
 13.1378 +</body>
 13.1379 +</html>