idav: comparison ucx/cx/array

-:c3f2f16fa4b8
+:dde28a806552
 /**
 * The maximum item size in an array list that fits into
 * a stack buffer when swapped.
 */
-cx_attr_export
+CX_EXPORT extern const unsigned cx_array_swap_sbo_size;
-extern const unsigned cx_array_swap_sbo_size;
 /**
 * Declares variables for an array that can be used with the convenience macros.
 *
 * @par Examples
 struct cx_array_reallocator_s {
 /**
 * Reallocates space for the given array.
 *
 * Implementations are not required to free the original array.
-* This allows reallocation of static memory by allocating heap memory
+* This allows reallocation of static or stack memory by allocating heap memory
-* and copying the array contents. The information in the custom fields of
+* and copying the array contents; namely when @c stack_ptr in this struct
-* the referenced allocator can be used to track the state of the memory
+* is not @c NULL and @p array equals @c stack_ptr.
-* or to transport other additional data.
 *
 * @param array the array to reallocate
 * @param old_capacity the old number of elements
 * @param new_capacity the new number of elements
 * @param elem_size the size of each element
 * @param alloc a reference to this allocator
 * @return a pointer to the reallocated memory or @c NULL on failure
 */
-cx_attr_nodiscard
+void *(*realloc)( void *array, size_t old_capacity, size_t new_capacity,
-cx_attr_nonnull_arg(5)
+size_t elem_size, struct cx_array_reallocator_s *alloc);
-cx_attr_allocsize(3, 4)
-void *(*realloc)(
-void *array,
-size_t old_capacity,
-size_t new_capacity,
-size_t elem_size,
-struct cx_array_reallocator_s *alloc
-);
 /**
-* Custom data pointer.
+* The allocator that shall be used for the reallocations.
 */
-void *ptr1;
+const CxAllocator *allocator;
 /**
-* Custom data pointer.
+* Optional pointer to stack memory
+* if the array is originally located on the stack.
 */
-void *ptr2;
+const void *stack_ptr;
-/**
-* Custom data integer.
-*/
-size_t int1;
-/**
-* Custom data integer.
-*/
-size_t int2;
 };
 /**
 * Typedef for the array reallocator struct.
 */
 typedef struct cx_array_reallocator_s CxArrayReallocator;
 /**
 * A default array reallocator that is based on the cxDefaultAllocator.
 */
-cx_attr_export
+CX_EXPORT extern CxArrayReallocator *cx_array_default_reallocator;
-extern CxArrayReallocator *cx_array_default_reallocator;
 /**
 * Creates a new array reallocator.
 *
 * When @p allocator is @c NULL, the cxDefaultAllocator will be used.
 *
-* When @p stackmem is not @c NULL, the reallocator is supposed to be used
+* When @p stack_ptr is not @c NULL, the reallocator is supposed to be used
-* @em only for the specific array initially located at @p stackmem.
+* @em only for the specific array initially located at @p stack_ptr.
 * When reallocation is needed, the reallocator checks if the array is
-* still located at @p stackmem and copies the contents to the heap.
+* still located at @p stack_ptr and copies the contents to the heap.
 *
 * @note Invoking this function with both arguments being @c NULL will return a
 * reallocator that behaves like #cx_array_default_reallocator.
 *
 * @param allocator the allocator this reallocator shall be based on
-* @param stackmem the address of the array when the array is initially located
+* @param stack_ptr the address of the array when the array is initially located
 * on the stack or shall not reallocate in place
 * @return an array reallocator
 */
-cx_attr_export
+CX_EXPORT CxArrayReallocator cx_array_reallocator(
-CxArrayReallocator cx_array_reallocator(
+const struct cx_allocator_s *allocator, const void *stack_ptr);
-const struct cx_allocator_s *allocator,
-const void *stackmem
-);
 /**
 * Reserves memory for additional elements.
 *
 * This function checks if the @p capacity of the array is sufficient to hold
 *
 * The @p width in bytes refers to the size and capacity.
 * Both must have the same width.
 * Supported are 0, 1, 2, and 4, as well as 8 if running on a 64-bit
 * architecture. If set to zero, the native word width is used.
+*
+* @note This function will reserve the minimum required capacity to hold
+* the additional elements and does not perform an overallocation.
 *
 * @param array a pointer to the target array
 * @param size a pointer to the size of the array
 * @param capacity a pointer to the capacity of the array
 * @param width the width in bytes for the @p size and @p capacity or zero for default
 * @retval zero success
 * @retval non-zero failure
 * @see cx_array_reallocator()
 */
 cx_attr_nonnull_arg(1, 2, 3)
-cx_attr_export
+CX_EXPORT int cx_array_reserve(void **array, void *size, void *capacity,
-int cx_array_reserve(
+unsigned width, size_t elem_size, size_t elem_count,
-void **array,
+CxArrayReallocator *reallocator);
-void *size,
-void *capacity,
-unsigned width,
-size_t elem_size,
-size_t elem_count,
-CxArrayReallocator *reallocator
-);
 /**
 * Copies elements from one array to another.
 *
 * The elements are copied to the @p target array at the specified @p index,
 *
 * The @p width in bytes refers to the size and capacity.
 * Both must have the same width.
 * Supported are 0, 1, 2, and 4, as well as 8 if running on a 64-bit
 * architecture. If set to zero, the native word width is used.
+*
+* @note When this function does reallocate the array, it may allocate more
+* space than required to avoid further allocations in the near future.
 *
 * @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 capacity of the target array
 * @param width the width in bytes for the @p size and @p capacity or zero for default
 * @param reallocator the array reallocator to use
 * (@c NULL defaults to #cx_array_default_reallocator)
 * @retval zero success
 * @retval non-zero failure
 * @see cx_array_reallocator()
+* @see cx_array_reserve()
 */
 cx_attr_nonnull_arg(1, 2, 3, 6)
-cx_attr_export
+CX_EXPORT int cx_array_copy(void **target, void *size, void *capacity, unsigned width,
-int cx_array_copy(
+size_t index, const void *src, size_t elem_size, size_t elem_count,
-void **target,
+CxArrayReallocator *reallocator);
-void *size,
-void *capacity,
-unsigned width,
-size_t index,
-const void *src,
-size_t elem_size,
-size_t elem_count,
-CxArrayReallocator *reallocator
-);
 /**
 * Convenience macro that uses cx_array_copy() with a default layout and
 * the specified reallocator.
 *
 * (@c NULL defaults to #cx_array_default_reallocator)
 * @retval zero success
 * @retval non-zero failure
 */
 cx_attr_nonnull_arg(1, 2, 3, 5)
-cx_attr_export
+CX_EXPORT int cx_array_insert_sorted(void **target, size_t *size, size_t *capacity,
-int cx_array_insert_sorted(
+cx_compare_func cmp_func, const void *src, size_t elem_size, size_t elem_count,
-void **target,
+CxArrayReallocator *reallocator);
-size_t *size,
-size_t *capacity,
-cx_compare_func cmp_func,
-const void *src,
-size_t elem_size,
-size_t elem_count,
-CxArrayReallocator *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
+* If the capacity is not enough to hold the new data, a reallocation
 * attempt is made.
 *
 * The \@ SIZE_TYPE is flexible and can be any unsigned integer type.
 * It is important, however, that @p size and @p capacity are pointers to
 * variables of the same type.
 * (@c NULL defaults to #cx_array_default_reallocator)
 * @retval zero success
 * @retval non-zero failure
 */
 cx_attr_nonnull_arg(1, 2, 3, 5)
-cx_attr_export
+CX_EXPORT int cx_array_insert_unique(void **target, size_t *size, size_t *capacity,
-int cx_array_insert_unique(
+cx_compare_func cmp_func, const void *src, size_t elem_size, size_t elem_count,
-void **target,
+CxArrayReallocator *reallocator);
-size_t *size,
-size_t *capacity,
-cx_compare_func cmp_func,
-const void *src,
-size_t elem_size,
-size_t elem_count,
-CxArrayReallocator *reallocator
-);
 /**
 * Inserts an element into a sorted array if it does not exist.
 *
 * If the target array is not already sorted with respect
 * @return the index of the largest lower bound, or @p size
 * @see cx_array_binary_search_sup()
 * @see cx_array_binary_search()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT size_t cx_array_binary_search_inf(const void *arr, size_t size,
-size_t cx_array_binary_search_inf(
+size_t elem_size, const void *elem, cx_compare_func cmp_func);
-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
 * cannot be found
 * @see cx_array_binary_search_inf()
 * @see cx_array_binary_search_sup()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT size_t cx_array_binary_search(const void *arr, size_t size,
-size_t cx_array_binary_search(
+size_t elem_size, const void *elem, cx_compare_func cmp_func);
-const void *arr,
-size_t size,
-size_t elem_size,
-const void *elem,
-cx_compare_func cmp_func
-);
 /**
 * Searches the smallest upper bound in a sorted array.
 *
 * In other words, this function returns the index of the smallest element
 * @return the index of the smallest upper bound, or @p size
 * @see cx_array_binary_search_inf()
 * @see cx_array_binary_search()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT size_t cx_array_binary_search_sup(const void *arr, size_t size,
-size_t cx_array_binary_search_sup(
+size_t elem_size, const void *elem, cx_compare_func cmp_func);
-const void *arr,
-size_t size,
-size_t elem_size,
-const void *elem,
-cx_compare_func cmp_func
-);
 /**
 * Swaps two array elements.
 *
 * @param arr the array
 * @param elem_size the element size
 * @param idx1 index of the first element
 * @param idx2 index of the second element
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT void cx_array_swap(void *arr, size_t elem_size, size_t idx1, size_t idx2);
-void cx_array_swap(
-void *arr,
-size_t elem_size,
-size_t idx1,
-size_t idx2
-);
 /**
 * Allocates an array list for storing elements with @p elem_size bytes each.
 *
 * If @p elem_size is #CX_STORE_POINTERS, the created list stores pointers instead of
 * @return the created list
 */
 cx_attr_nodiscard
 cx_attr_malloc
 cx_attr_dealloc(cxListFree, 1)
-cx_attr_export
+CX_EXPORT CxList *cxArrayListCreate(const CxAllocator *allocator,
-CxList *cxArrayListCreate(
+cx_compare_func comparator, size_t elem_size, size_t initial_capacity);
-const CxAllocator *allocator,
-cx_compare_func comparator,
-size_t elem_size,
-size_t initial_capacity
-);
 /**
 * Allocates an array list for storing elements with @p elem_size bytes each.
 *
 * The list will use the cxDefaultAllocator and @em NO compare function.

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