docs/api-2.1/array_8h_source.html

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2019 Mike Becker, Olaf Wintermann All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
 #ifndef UCX_ARRAY_H
 #define UCX_ARRAY_H

 #include "ucx.h"
 #include "allocator.h"

 #ifdef  __cplusplus
 extern "C" {
 #endif

 typedef struct {
     size_t capacity;
     size_t size;
     size_t elemsize;
     void* data;
     UcxAllocator* allocator;
 } UcxArray;

 #define ucx_array_util_set(array, capacity, elmsize, idx, data) \
     ucx_array_util_set_a(ucx_default_allocator(), (void**)(array), capacity, \
                          elmsize, idx, data)

 int ucx_array_util_set_a(UcxAllocator* alloc, void** array, size_t* capacity,
     size_t elmsize, size_t idx, void* data);

 #define ucx_array_util_setptr(array, capacity, idx, ptr) \
     ucx_array_util_setptr_a(ucx_default_allocator(), (void**)(array), \
                             capacity, idx, ptr)

 int ucx_array_util_setptr_a(UcxAllocator* alloc, void** array, size_t* capacity,
     size_t idx, void* ptr);


 UcxArray* ucx_array_new(size_t capacity, size_t elemsize);

 UcxArray* ucx_array_new_a(size_t capacity, size_t elemsize,
         UcxAllocator* allocator);

 void ucx_array_init(UcxArray* array, size_t capacity, size_t elemsize);

 void ucx_array_init_a(UcxArray* array, size_t capacity, size_t elemsize,
         UcxAllocator* allocator);

 int ucx_array_clone(UcxArray* dest, UcxArray const* src);


 int ucx_array_equals(UcxArray const *array1, UcxArray const *array2,
         cmp_func cmpfnc, void* data);

 void ucx_array_destroy(UcxArray *array);

 void ucx_array_free(UcxArray *array);

 int ucx_array_append_from(UcxArray *array, void *data, size_t count);


 int ucx_array_prepend_from(UcxArray *array, void *data, size_t count);


 int ucx_array_set_from(UcxArray *array, size_t index, void *data, size_t count);

 int ucx_array_concat(UcxArray *array1, const UcxArray *array2);

 void *ucx_array_at(UcxArray const* array, size_t index);

 size_t ucx_array_find(UcxArray const *array, void *elem,
     cmp_func cmpfnc, void *data);

 int ucx_array_contains(UcxArray const *array, void *elem,
     cmp_func cmpfnc, void *data);

 void ucx_array_sort(UcxArray* array, cmp_func cmpfnc, void *data);

 void ucx_array_remove(UcxArray *array, size_t index);

 void ucx_array_remove_fast(UcxArray *array, size_t index);

 int ucx_array_shrink(UcxArray* array);

 int ucx_array_resize(UcxArray* array, size_t capacity);

 int ucx_array_reserve(UcxArray* array, size_t capacity);

 int ucx_array_grow(UcxArray* array, size_t count);


 #ifdef  __cplusplus
 }
 #endif

 #endif  /* UCX_ARRAY_H */

ucx_array_append_from
int ucx_array_append_from(UcxArray *array, void *data, size_t count)
Inserts elements at the end of the array.
Definition: array.c:206

universe@390: ucx_array_prepend_from
int ucx_array_prepend_from(UcxArray *array, void *data, size_t count)
Inserts elements at the beginning of the array.
Definition: array.c:221

universe@390: ucx_array_grow
int ucx_array_grow(UcxArray *array, size_t count)
Resizes the capacity, if the specified number of elements would not fit.
Definition: array.c:465

universe@390: cmp_func
int(* cmp_func)(const void *, const void *, void *)
Function pointer to a compare function.
Definition: ucx.h:84

universe@390: ucx_array_shrink
int ucx_array_shrink(UcxArray *array)
Shrinks the memory to exactly fit the contents.
Definition: array.c:418

universe@390: ucx_array_concat
int ucx_array_concat(UcxArray *array1, const UcxArray *array2)
Concatenates two arrays.
Definition: array.c:259

universe@390: ucx.h
Main UCX Header providing most common definitions.

universe@390: UcxArray::capacity
size_t capacity
The current capacity of the array.
Definition: array.h:53

universe@390: ucx_array_util_set_a
int ucx_array_util_set_a(UcxAllocator *alloc, void **array, size_t *capacity, size_t elmsize, size_t idx, void *data)
Sets an element in an arbitrary user defined array.
Definition: array.c:72

universe@390: ucx_array_equals
int ucx_array_equals(UcxArray const *array1, UcxArray const *array2, cmp_func cmpfnc, void *data)
Compares two UCX arrays element-wise by using a compare function.
Definition: array.c:166

universe@390: ucx_array_init_a
void ucx_array_init_a(UcxArray *array, size_t capacity, size_t elemsize, UcxAllocator *allocator)
Initializes a UCX array structure using the specified allocator.
Definition: array.c:136

universe@390: ucx_array_sort
void ucx_array_sort(UcxArray *array, cmp_func cmpfnc, void *data)
Sorts a UcxArray with the best available sort algorithm.
Definition: array.c:395

universe@390: UcxArray::data
void * data
A pointer to the data.
Definition: array.h:65

universe@390: ucx_array_new
UcxArray * ucx_array_new(size_t capacity, size_t elemsize)
Creates a new UCX array with the given capacity and element size.
Definition: array.c:119

universe@390: ucx_array_remove
void ucx_array_remove(UcxArray *array, size_t index)
Removes an element from the array.
Definition: array.c:400

universe@390: UcxArray::allocator
UcxAllocator * allocator
The allocator used for the data.
Definition: array.h:69

universe@390: ucx_array_set_from
int ucx_array_set_from(UcxArray *array, size_t index, void *data, size_t count)
Sets elements starting at the specified index.
Definition: array.c:240

universe@390: ucx_array_remove_fast
void ucx_array_remove_fast(UcxArray *array, size_t index)
Removes an element from the array.
Definition: array.c:409

universe@390: UcxAllocator
UCX allocator data structure containing memory management functions.
Definition: allocator.h:88

universe@390: ucx_array_contains
int ucx_array_contains(UcxArray const *array, void *elem, cmp_func cmpfnc, void *data)
Checks, if an array contains a specific element.
Definition: array.c:309

universe@390: ucx_array_find
size_t ucx_array_find(UcxArray const *array, void *elem, cmp_func cmpfnc, void *data)
Returns the index of an element containing the specified data.
Definition: array.c:286

universe@390: UcxArray
UCX array type.
Definition: array.h:49

universe@390: UcxArray::size
size_t size
The actual number of elements in the array.
Definition: array.h:57

universe@390: ucx_array_destroy
void ucx_array_destroy(UcxArray *array)
Destroys the array.
Definition: array.c:194

universe@390: ucx_array_util_setptr_a
int ucx_array_util_setptr_a(UcxAllocator *alloc, void **array, size_t *capacity, size_t idx, void *ptr)
Stores a pointer in an arbitrary user defined array.
Definition: array.c:112

universe@390: allocator.h
Allocator for custom memory management.

universe@390: ucx_array_free
void ucx_array_free(UcxArray *array)
Destroys and frees the array.
Definition: array.c:201

universe@390: ucx_array_clone
int ucx_array_clone(UcxArray *dest, UcxArray const *src)
Creates an shallow copy of an array.
Definition: array.c:151

universe@390: ucx_array_at
void * ucx_array_at(UcxArray const *array, size_t index)
Returns a pointer to the array element at the specified index.
Definition: array.c:280

universe@390: ucx_array_resize
int ucx_array_resize(UcxArray *array, size_t capacity)
Sets the capacity of the array.
Definition: array.c:430

universe@390: ucx_array_init
void ucx_array_init(UcxArray *array, size_t capacity, size_t elemsize)
Initializes a UCX array structure with the given capacity and element size.
Definition: array.c:132

universe@390: UcxArray::elemsize
size_t elemsize
The size of an individual element in bytes.
Definition: array.h:61

universe@390: ucx_array_reserve
int ucx_array_reserve(UcxArray *array, size_t capacity)
Resizes the array only, if the capacity is insufficient.
Definition: array.c:449

universe@390: ucx_array_new_a
UcxArray * ucx_array_new_a(size_t capacity, size_t elemsize, UcxAllocator *allocator)
Creates a new UCX array using the specified allocator.
Definition: array.c:123

universe@390: