ucx: docs/src/features.md@adc3c48dd3af (annotated)

docs/src/features.md@adc3c48dd3af (annotated)

docs/src/features.md

Tue, 27 Jun 2023 18:10:34 +0200

author: Mike Becker <universe@uap-core.de>
date: Tue, 27 Jun 2023 18:10:34 +0200
changeset 722: adc3c48dd3af
parent 720: f73adc75e50a
child 723: c33e0ac069dd
permissions: -rw-r--r--

add allocator example

 ---
 title: UCX Features
 ---
 <div id="modules">
 ------------------------ -------------------------  -------------------  ---------------------------------
 [Allocator](#allocator)  [String](#string)          [Buffer](#buffer)    [Memory&nbsp;Pool](#memory-pool)
 [Iterator](#iterator)    [Collection](#collection)  [List](#list)        [Map](#map)
 [Utilities](#utilities)
 ------------------------ -------------------------  -------------------  ---------------------------------
 </div>
 ## Allocator
 *Header file:* [allocator.h](api/allocator_8h.html)
 The UCX allocator provides an interface for implementing an own memory allocation mechanism.
 Various function in UCX provide an additional alternative signature that takes an allocator as
 argument. A default allocator implementation using the stdlib memory management functions is
 available via the global symbol `cxDefaultAllocator`.
 If you want to define your own allocator, you need to initialize the `CxAllocator` structure
 with a pointer to an allocator class (containing function pointers for the memory management
 functions) and an optional pointer to an arbitrary memory region that can be used to store
 state information for the allocator. An example is shown below:
 ```c
 struct my_allocator_state {
     size_t total;
     size_t avail;
     char[] mem;
 };
 static cx_allocator_class my_allocator_class = {
         my_malloc_impl,
         my_realloc_impl,   // all these functions are somewhere defined
         my_calloc_impl,
         my_free_impl
 };
 CxAllocator create_my_allocator(size_t n) {
     CxAllocator alloc;
     alloc.cl = &my_allocator_class;
     alloc.data = calloc(1, sizeof(struct my_allocator_state) + n);
     return alloc;
 }
 void free_my_allocator(CxAllocator *alloc) {
     free(alloc.data);
     free(alloc);
 }
 ```
 ## String
 *Header file:* [string.h](api/string_8h.html)
 ## Buffer
 *Header file:* [buffer.h](api/buffer_8h.html)
 ## Memory Pool
 *Header file:* [mempool.h](api/mempool_8h.html)
 ### Basic Memory Pool
 *Header file:* [basic_mempool.h](api/basic__mempool_8h.html)
 ## Iterator
 *Header file:* [iterator.h](api/iterator_8h.html)
 ## Collection
 *Header file:* [collection.h](api/collection_8h.html)
 ## List
 *Header file:* [list.h](api/list_8h.html)
 ### Linked List
 *Header file:* [linked_list.h](api/linked__list_8h.html)
 ### Array List
 *Header file:* [array_list.h](api/array__list_8h.html)
 ## Map
 *Header file:* [map.h](api/map_8h.html)
 ### Hash Map
 *Header file:* [hash_map.h](api/hash__map_8h.html)
 ## Utilities
 *Header file:* [utils.h](api/utils_8h.html)
 ### Printf Functions
 *Header file:* [printf.h](api/printf_8h.html)
 ### Compare Functions
 *Header file:* [compare.h](api/compare_8h.html)

Mercurial > hg > ucx / annotate

docs/src/features.md@adc3c48dd3af (annotated)

docs/src/features.md