idav: comparison ucx/cx/array

-:ae61523bce20
+:2f71f4ee247a
 * The maximum item size in an array list that fits into stack buffer when swapped.
 */
 extern unsigned cx_array_swap_sbo_size;
 /**
+* Declares variables for an array that can be used with the convenience macros.
+*
+* @see cx_array_simple_add()
+* @see cx_array_simple_copy()
+* @see cx_array_initialize()
+* @see cx_array_simple_add_sorted()
+* @see cx_array_simple_insert_sorted()
+*/
+#define CX_ARRAY_DECLARE(type, name) \
+type * name;                     \
+size_t name##_size;              \
+size_t name##_capacity
+/**
+* Initializes an array declared with CX_ARRAY_DECLARE().
+*
+* The memory for the array is allocated with stdlib malloc().
+* @param array the array
+* @param capacity the initial capacity
+*/
+#define cx_array_initialize(array, capacity) \
+array##_capacity = capacity; \
+array##_size = 0; \
+array = malloc(sizeof(array[0]) * capacity)
+/**
 * Defines a reallocation mechanism for arrays.
 */
 struct cx_array_reallocator_s {
 /**
-* Re-allocates space for the given array.
+* Reallocates space for the given array.
 *
 * Implementations are not required to free the original array.
-* This allows re-allocation of static memory by allocating heap memory
+* This allows reallocation of static memory by allocating heap memory
 * and copying the array contents. The information in the custom fields of
 * the referenced allocator can be used to track the state of the memory
 * or to transport other additional data.
 *
 * @param array the array to reallocate
 *
 * If the capacity is insufficient to hold the new data, a reallocation
 * attempt is made, unless the \p reallocator is set to \c NULL, in which case
 * this function ultimately returns a failure.
 *
-* @param target the target array
+* @param target a pointer to the target array
 * @param size a pointer to the size of the target array
 * @param capacity a pointer to the target array's capacity -
-* \c NULL if only the size shall be used to bound the array
+* \c NULL if only the size shall be used to bound the array (reallocations
+* will NOT be supported in that case)
 * @param index the index where the copied elements shall be placed
 * @param src the source array
 * @param elem_size the size of one element
 * @param elem_count the number of elements to copy
-* @param reallocator the array re-allocator to use, or \c NULL
+* @param reallocator the array reallocator to use, or \c NULL
-* if re-allocation shall not happen
+* if reallocation shall not happen
 * @return zero on success, non-zero error code on failure
 */
+__attribute__((__nonnull__(1, 2, 5)))
 enum cx_array_result cx_array_copy(
 void **target,
 size_t *size,
 size_t *capacity,
 size_t index,
-void const *src,
+const void *src,
 size_t elem_size,
 size_t elem_count,
 struct cx_array_reallocator_s *reallocator
-) __attribute__((__nonnull__(1, 2, 5)));
+);
+/**
+* Convenience macro that uses cx_array_copy() with a default layout and the default reallocator.
+*
+* @param array the name of the array (NOT a pointer to the array)
+* @param index the index where the copied elements shall be placed
+* @param src the source array
+* @param count the number of elements to copy
+* @see CX_ARRAY_DECLARE()
+*/
+#define cx_array_simple_copy(array, index, src, count) \
+cx_array_copy((void**)&(array), &(array##_size), &(array##_capacity), \
+index, src, sizeof((array)[0]), count, cx_array_default_reallocator)
 /**
 * Adds an element to an array with the possibility of allocating more space.
 *
 * The element \p elem is added to the end of the \p target array which containing
 *
 * If the capacity is insufficient to hold the new element, and the optional
 * \p reallocator is not \c NULL, an attempt increase the \p capacity is made
 * and the new capacity is written back.
 *
-* @param target the target array
+* @param target a pointer to the target array
 * @param size a pointer to the size of the target array
 * @param capacity a pointer to the target array's capacity - must not be \c NULL
 * @param elem_size the size of one element
-* @param elem the element to add
+* @param elem a pointer to the element to add
-* @param reallocator the array re-allocator to use, or \c NULL
+* @param reallocator the array reallocator to use, or \c NULL if reallocation shall not happen
-* if re-allocation shall not happen
 * @return zero on success, non-zero error code on failure
 */
 #define cx_array_add(target, size, capacity, elem_size, elem, reallocator) \
 cx_array_copy((void**)(target), size, capacity, *(size), elem, elem_size, 1, reallocator)
+/**
+* Convenience macro that uses cx_array_add() with a default layout and
+* the default reallocator.
+*
+* @param array the name of the array (NOT a pointer to the array)
+* @param elem the element to add (NOT a pointer, address is automatically taken)
+* @see CX_ARRAY_DECLARE()
+*/
+#define cx_array_simple_add(array, elem) \
+cx_array_simple_copy(array, array##_size, &(elem), 1)
+/**
+* Inserts a sorted array into another sorted array.
+*
+* If either the target or the source array is not already sorted with respect
+* to the specified \p cmp_func, the behavior is undefined.
+*
+* If the capacity is insufficient to hold the new data, a reallocation
+* attempt is made.
+*
+* @param target a pointer to the target array
+* @param size a pointer to the size of the target array
+* @param capacity a pointer to the target array's capacity
+* @param cmp_func the compare function for the elements
+* @param src the source array
+* @param elem_size the size of one element
+* @param elem_count the number of elements to insert
+* @param reallocator the array reallocator to use
+* @return zero on success, non-zero error code on failure
+*/
+__attribute__((__nonnull__))
+enum cx_array_result cx_array_insert_sorted(
+void **target,
+size_t *size,
+size_t *capacity,
+cx_compare_func cmp_func,
+const void *src,
+size_t elem_size,
+size_t elem_count,
+struct cx_array_reallocator_s *reallocator
+);
+/**
+* Inserts an element into a sorted array.
+*
+* If the target array is not already sorted with respect
+* to the specified \p cmp_func, the behavior is undefined.
+*
+* If the capacity is insufficient to hold the new data, a reallocation
+* attempt is made.
+*
+* @param target a pointer to the target array
+* @param size a pointer to the size of the target array
+* @param capacity a pointer to the target array's capacity
+* @param elem_size the size of one element
+* @param elem a pointer to the element to add
+* @param reallocator the array reallocator to use
+* @return zero on success, non-zero error code on failure
+*/
+#define cx_array_add_sorted(target, size, capacity, elem_size, elem, cmp_func, reallocator) \
+cx_array_insert_sorted((void**)(target), size, capacity, cmp_func, elem, elem_size, 1, reallocator)
+/**
+* Convenience macro for cx_array_add_sorted() with a default
+* layout and the default reallocator.
+*
+* @param array the name of the array (NOT a pointer to the array)
+* @param elem the element to add (NOT a pointer, address is automatically taken)
+* @param cmp_func the compare function for the elements
+* @see CX_ARRAY_DECLARE()
+*/
+#define cx_array_simple_add_sorted(array, elem, cmp_func) \
+cx_array_add_sorted(&array, &(array##_size), &(array##_capacity), \
+sizeof((array)[0]), &(elem), cmp_func, cx_array_default_reallocator)
+/**
+* Convenience macro for cx_array_insert_sorted() with a default
+* layout and the default reallocator.
+*
+* @param array the name of the array (NOT a pointer to the array)
+* @param src pointer to the source array
+* @param n number of elements in the source array
+* @param cmp_func the compare function for the elements
+* @see CX_ARRAY_DECLARE()
+*/
+#define cx_array_simple_insert_sorted(array, src, n, cmp_func) \
+cx_array_insert_sorted((void**)(&array), &(array##_size), &(array##_capacity), \
+cmp_func, src, sizeof((array)[0]), n, cx_array_default_reallocator)
+/**
+* Searches the largest lower bound in a sorted array.
+*
+* In other words, this function returns the index of the largest element
+* in \p arr that is less or equal to \p elem with respect to \p cmp_func.
+* When no such element exists, \p size is returned.
+*
+* If \p elem is contained in the array, this is identical to
+* #cx_array_binary_search().
+*
+* If the array is not sorted with respect to the \p cmp_func, the behavior
+* is undefined.
+*
+* @param arr the array to search
+* @param size the size of the array
+* @param elem_size the size of one element
+* @param elem the element to find
+* @param cmp_func the compare function
+* @return the index of the largest lower bound, or \p size
+*/
+__attribute__((__nonnull__))
+size_t cx_array_binary_search_inf(
+const void *arr,
+size_t size,
+size_t elem_size,
+const void *elem,
+cx_compare_func cmp_func
+);
+/**
+* Searches an item in a sorted array.
+*
+* If the array is not sorted with respect to the \p cmp_func, the behavior
+* is undefined.
+*
+* @param arr the array to search
+* @param size the size of the array
+* @param elem_size the size of one element
+* @param elem the element to find
+* @param cmp_func the compare function
+* @return the index of the element in the array, or \p size if the element
+* cannot be found
+*/
+__attribute__((__nonnull__))
+static inline size_t cx_array_binary_search(
+const void *arr,
+size_t size,
+size_t elem_size,
+const void *elem,
+cx_compare_func cmp_func
+) {
+size_t index = cx_array_binary_search_inf(
+arr, size, elem_size, elem, cmp_func
+);
+if (index < size && cmp_func(((const char *) arr) + index * elem_size, elem) == 0) {
+return index;
+} else {
+return size;
+}
+}
+/**
+* Searches the smallest upper bound in a sorted array.
+*
+* In other words, this function returns the index of the smallest element
+* in \p arr that is greater or equal to \p elem with respect to \p cmp_func.
+* When no such element exists, \p size is returned.
+*
+* If \p elem is contained in the array, this is identical to
+* #cx_array_binary_search().
+*
+* If the array is not sorted with respect to the \p cmp_func, the behavior
+* is undefined.
+*
+* @param arr the array to search
+* @param size the size of the array
+* @param elem_size the size of one element
+* @param elem the element to find
+* @param cmp_func the compare function
+* @return the index of the smallest upper bound, or \p size
+*/
+__attribute__((__nonnull__))
+static inline size_t cx_array_binary_search_sup(
+const void *arr,
+size_t size,
+size_t elem_size,
+const void *elem,
+cx_compare_func cmp_func
+) {
+size_t inf = cx_array_binary_search_inf(arr, size, elem_size, elem, cmp_func);
+if (inf == size) {
+// no infimum means, first element is supremum
+return 0;
+} else if (cmp_func(((const char *) arr) + inf * elem_size, elem) == 0) {
+return inf;
+} else {
+return inf + 1;
+}
+}
 /**
 * Swaps two array elements.
 *
 * @param arr the array
 * @param elem_size the element size
 * @param idx1 index of first element
 * @param idx2 index of second element
 */
+__attribute__((__nonnull__))
 void cx_array_swap(
 void *arr,
 size_t elem_size,
 size_t idx1,
 size_t idx2
-) __attribute__((__nonnull__));
+);
 /**
-* Allocates an array list for storing elements with \p item_size bytes each.
+* Allocates an array list for storing elements with \p elem_size bytes each.
 *
-* If \p item_size is CX_STORE_POINTERS, the created list will be created as if
+* If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
 * cxListStorePointers() was called immediately after creation and the compare
 * function will be automatically set to cx_cmp_ptr(), if none is given.
 *
 * @param allocator the allocator for allocating the list memory
 * (if \c NULL the cxDefaultAllocator will be used)
 * @param comparator the comparator for the elements
 * (if \c NULL, and the list is not storing pointers, sort and find
 * functions will not work)
-* @param item_size the size of each element in bytes
+* @param elem_size the size of each element in bytes
 * @param initial_capacity the initial number of elements the array can store
 * @return the created list
 */
 CxList *cxArrayListCreate(
-CxAllocator const *allocator,
+const CxAllocator *allocator,
 cx_compare_func comparator,
-size_t item_size,
+size_t elem_size,
 size_t initial_capacity
 );
 /**
-* Allocates an array list for storing elements with \p item_size bytes each.
+* Allocates an array list for storing elements with \p elem_size bytes each.
 *
 * The list will use the cxDefaultAllocator and \em NO compare function.
 * If you want to call functions that need a compare function, you have to
 * set it immediately after creation or use cxArrayListCreate().
 *
-* If \p item_size is CX_STORE_POINTERS, the created list will be created as if
+* If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
 * cxListStorePointers() was called immediately after creation and the compare
 * function will be automatically set to cx_cmp_ptr().
 *
-* @param item_size the size of each element in bytes
+* @param elem_size the size of each element in bytes
 * @param initial_capacity the initial number of elements the array can store
 * @return the created list
 */
-#define cxArrayListCreateSimple(item_size, initial_capacity) \
+#define cxArrayListCreateSimple(elem_size, initial_capacity) \
-cxArrayListCreate(NULL, NULL, item_size, initial_capacity)
+cxArrayListCreate(NULL, NULL, elem_size, initial_capacity)
 #ifdef __cplusplus
 } // extern "C"
 #endif

comparison: ucx/cx/array_list.h

ucx/cx/array_list.h

Mercurial > hg > idav / file comparison

comparison: ucx/cx/array_list.h

ucx/cx/array_list.h