array.h

Go to the documentation of this file.

/*
 * 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 */