array_list.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 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_LIST_H
#define UCX_ARRAY_LIST_H
 
#include "list.h"

CX_EXPORT extern const unsigned cx_array_swap_sbo_size;

#define CX_ARRAY(type, name) \
    struct { \
        type *data; \
        size_t size; \
        size_t capacity; \
    } name

typedef struct cx_array_s {
    void *data;
    size_t size;
    size_t capacity;
} CxArray;

CX_EXTERN CX_NONNULL
int cx_array_init_(const CxAllocator *allocator, CxArray *array, size_t elem_size, size_t capacity);

#define cx_array_init_a(allocator, array, capacity) cx_array_init_(allocator, (CxArray*)&(array), sizeof((array).data[0]), capacity)

#define cx_array_init(array, capacity) cx_array_init_a(cxDefaultAllocator, array, capacity)

CX_EXTERN CX_NONNULL
void cx_array_init_fixed_(CxArray *array, const void *data, size_t capacity, size_t size);

#define cx_array_init_fixed(array, fixed_size_array, num_initialized) \
        cx_array_init_fixed_((CxArray*)&(array), fixed_size_array, cx_nmemb(fixed_size_array), num_initialized)

CX_EXTERN CX_NONNULL
int cx_array_reserve_(const CxAllocator *allocator, CxArray *array, size_t elem_size, size_t capacity);

#define cx_array_reserve_a(allocator, array, capacity) \
        cx_array_reserve_(allocator, (CxArray*)&(array), sizeof((array).data[0]), capacity)

#define cx_array_reserve(array, capacity) \
        cx_array_reserve_a(cxDefaultAllocator, array, capacity)

CX_EXTERN CX_NONNULL
int cx_array_copy_to_new_(const CxAllocator *allocator, CxArray *array, size_t elem_size, size_t capacity);

#define cx_array_copy_to_new_a(allocator, array, capacity) \
        cx_array_copy_to_new_(allocator, (CxArray*)&(array), sizeof((array).data[0]), capacity)

#define cx_array_copy_to_new(array, capacity) \
        cx_array_copy_to_new_a(cxDefaultAllocator, array, capacity)

CX_EXTERN CX_NONNULL_ARG(1, 2)
int cx_array_insert_(const CxAllocator *allocator, CxArray *array,
        size_t elem_size, size_t index, const void *other, size_t n);

#define cx_array_add_a(allocator, array, element) \
        cx_array_insert_(allocator, (CxArray*)&(array), sizeof((array).data[0]), (array).size, (void*)&(element), 1)

#define cx_array_add(array, element) \
        cx_array_add_a(cxDefaultAllocator, array, element)

#define cx_array_insert_a(allocator, array, index, element) \
        cx_array_insert_(allocator, (CxArray*)&(array), sizeof((array).data[0]), index, (void*)&(element), 1)

#define cx_array_insert(array, index, element) \
        cx_array_insert_a(cxDefaultAllocator, array, index, element)

#define cx_array_insert_array_a(allocator, array, index, other, n) \
        cx_array_insert_(allocator, (CxArray*)&(array), sizeof((array).data[0]), index, other, n)

#define cx_array_insert_array(array, index, other, n) \
        cx_array_insert_array_a(cxDefaultAllocator, array, index, other, n)

#define cx_array_add_array_a(allocator, array, other, n) \
        cx_array_insert_(allocator, (CxArray*)&(array), sizeof((array).data[0]), (array).size, other, n)

#define cx_array_add_array(array, other, n) \
        cx_array_add_array_a(cxDefaultAllocator, array, other, n)

CX_EXTERN CX_NONNULL
int cx_array_insert_sorted_(const CxAllocator *allocator, CxArray *array,
        size_t elem_size, const void *sorted_data, size_t n,
        cx_compare_func cmp_func, bool allow_duplicates);

#define cx_array_insert_sorted_a(allocator, array, element, cmp_func) \
        cx_array_insert_sorted_(allocator, (CxArray*)&(array), sizeof((array).data[0]), (void*)&(element), 1, cmp_func, true)

#define cx_array_insert_sorted(array, element, cmp_func) \
        cx_array_insert_sorted_a(cxDefaultAllocator, array, element, cmp_func)

#define cx_array_insert_sorted_array_a(allocator, array, sorted_data, n, cmp_func) \
        cx_array_insert_sorted_(allocator, (CxArray*)&(array), sizeof((array).data[0]), sorted_data, n, cmp_func, true)

#define cx_array_insert_sorted_array(array, sorted_data, n, cmp_func) \
        cx_array_insert_sorted_array_a(cxDefaultAllocator, array, sorted_data, n, cmp_func)

#define cx_array_insert_unique_a(allocator, array, element, cmp_func) \
        cx_array_insert_sorted_(allocator, (CxArray*)&(array), sizeof((array).data[0]), (void*)&(element), 1, cmp_func, false)

#define cx_array_insert_unique(array, element, cmp_func) \
        cx_array_insert_unique_a(cxDefaultAllocator, array, element, cmp_func)

#define cx_array_insert_unique_array_a(allocator, array, sorted_data, n, cmp_func) \
        cx_array_insert_sorted_(allocator, (CxArray*)&(array), sizeof((array).data[0]), sorted_data, n, cmp_func, false)

#define cx_array_insert_unique_array(array, sorted_data, n, cmp_func) \
        cx_array_insert_unique_array_a(cxDefaultAllocator, array, sorted_data, n, cmp_func)

CX_EXTERN CX_NONNULL_ARG(1, 2, 4, 6)
int cx_array_insert_sorted_c_(const CxAllocator *allocator, CxArray *array,
        size_t elem_size, const void *sorted_data, size_t n,
        cx_compare_func2 cmp_func, void *context, bool allow_duplicates);

#define cx_array_insert_sorted_ca(allocator, array, element, cmp_func, context) \
        cx_array_insert_sorted_c_(allocator, (CxArray*)&(array), sizeof((array).data[0]), (void*)&(element), 1, cmp_func, context, true)

#define cx_array_insert_sorted_c(array, element, cmp_func, context) \
        cx_array_insert_sorted_ca(cxDefaultAllocator, array, element, cmp_func, context)

#define cx_array_insert_sorted_array_ca(allocator, array, sorted_data, n, cmp_func, context) \
        cx_array_insert_sorted_c_(allocator, (CxArray*)&(array), sizeof((array).data[0]), sorted_data, n, cmp_func, context, true)

#define cx_array_insert_sorted_array_c(array, sorted_data, n, cmp_func, context) \
        cx_array_insert_sorted_array_ca(cxDefaultAllocator, array, sorted_data, n, cmp_func, context)

#define cx_array_insert_unique_ca(allocator, array, element, cmp_func, context) \
        cx_array_insert_sorted_c_(allocator, (CxArray*)&(array), sizeof((array).data[0]), (void*)&(element), 1, cmp_func, context, false)

#define cx_array_insert_unique_c(array, element, cmp_func, context) \
        cx_array_insert_unique_ca(cxDefaultAllocator, array, element, cmp_func, context)

#define cx_array_insert_unique_array_ca(allocator, array, sorted_data, n, cmp_func, context) \
        cx_array_insert_sorted_c_(allocator, (CxArray*)&(array), sizeof((array).data[0]), sorted_data, n, cmp_func, context, false)

#define cx_array_insert_unique_array_c(array, sorted_data, n, cmp_func, context) \
        cx_array_insert_unique_array_ca(cxDefaultAllocator, array, sorted_data, n, cmp_func, context)

CX_EXTERN CX_NONNULL
void cx_array_qsort_c(void *array, size_t nmemb, size_t size,
        cx_compare_func2 fn, void *context);

CX_EXTERN CX_NONNULL
void cx_array_sort_(CxArray *array, size_t elem_size,
        cx_compare_func fn);

CX_EXTERN CX_NONNULL
void cx_array_sort_c_(CxArray *array, size_t elem_size,
        cx_compare_func2 fn, void *context);

#define cx_array_sort(array, fn) \
        cx_array_sort_((CxArray*)&(array), sizeof((array).data[0]), fn)

#define cx_array_sort_c(array, fn, context) \
        cx_array_sort_c_((CxArray*)&(array), sizeof((array).data[0]), fn, context)

CX_EXTERN CX_NODISCARD CX_NONNULL
CxIterator cx_array_iterator_(CxArray *array, size_t elem_size);

#define cx_array_iterator(array) \
        cx_array_iterator_((CxArray*)&(array), sizeof((array).data[0]))

CX_EXTERN CX_NODISCARD CX_NONNULL
CxIterator cx_array_iterator_ptr_(CxArray *array);

#define cx_array_iterator_ptr(array) \
        cx_array_iterator_ptr_((CxArray*)&(array))
 

CX_EXTERN CX_NONNULL
void cx_array_remove_(CxArray *array, size_t elem_size, size_t index, size_t n, bool fast);

#define cx_array_remove(array, index) \
        cx_array_remove_((CxArray*)&(array), sizeof((array).data[0]), index, 1, false)

#define cx_array_remove_fast(array, index) \
        cx_array_remove_((CxArray*)&(array), sizeof((array).data[0]), index, 1, true)

#define cx_array_remove_array(array, index, n) \
        cx_array_remove_((CxArray*)&(array), sizeof((array).data[0]), index, n, false)

#define cx_array_remove_array_fast(array, index, n) \
        cx_array_remove_((CxArray*)&(array), sizeof((array).data[0]), index, n, true)

CX_EXTERN CX_NONNULL
void cx_array_free_(const CxAllocator *allocator, CxArray *array);

#define cx_array_free(array) cx_array_free_(cxDefaultAllocator, (CxArray*)&(array))

#define cx_array_free_a(allocator, array) cx_array_free_(allocator, (CxArray*)&(array))
 

CX_EXTERN CX_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);

CX_EXTERN CX_NONNULL
size_t cx_array_binary_search(const void *arr, size_t size,
        size_t elem_size, const void *elem, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL
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);
 

CX_EXTERN CX_NONNULL
size_t cx_array_binary_search_inf_c(const void *arr, size_t size,
        size_t elem_size, const void *elem, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL
size_t cx_array_binary_search_c(const void *arr, size_t size,
        size_t elem_size, const void *elem, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL
size_t cx_array_binary_search_sup_c(const void *arr, size_t size,
        size_t elem_size, const void *elem, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL
void cx_array_swap(void *arr, size_t elem_size, size_t idx1, size_t idx2);

CX_EXTERN CX_NODISCARD CX_MALLOC CX_DEALLOC(cxListFree, 1)
CxList *cxArrayListCreate(const CxAllocator *allocator,
        size_t elem_size, size_t initial_capacity);
 
#endif // UCX_ARRAY_LIST_H