vector.h

Go to the documentation of this file.

 
#ifndef _VECTOR_H_
#define _VECTOR_H_
 
#include <stdbool.h>    /* bool, true, false */
#include <stddef.h>     /* size_t */
#include <sys/types.h>  /* ssize_t */
 
#define TMP_REF(type, value) (type[1]){value}
 
typedef struct vector_t vector_t;
 
typedef struct alloc_opts_t
{
    size_t size;
    void *data;
}
alloc_opts_t;
 
typedef struct vector_opts_t
{
    alloc_opts_t alloc_opts;  
    size_t ext_header_size;   
    /* required: */
    size_t element_size;      
    /* optional: */
    size_t initial_cap;       
}
vector_opts_t;
 
typedef enum vector_status_t
{
    VECTOR_SUCCESS = 0, 
    VECTOR_ALLOC_ERROR, 
    VECTOR_STATUS_LAST  
}
vector_status_t;
 
#define VECTOR_DEFAULT_ARGS \
    .initial_cap = 10
 
typedef bool (*predicate_t) (const void *const element, void *const param);
 
typedef ssize_t (*compare_t) (const void *const value, const void *const element, void *const param);
 
typedef int (*foreach_t) (const void *const element, void *const param);
 
typedef int (*aggregate_t) (const void *const element, void *const acc, void *const param);
 
typedef int (*transform_t) (void *const element, void *const param);
#define alloc_opts(...) (alloc_opts_t){__VA_ARGS__}
 
#define vector_create(...) \
    vector_create_( \
        &(vector_opts_t) { \
            VECTOR_DEFAULT_ARGS,\
            __VA_ARGS__ \
        }\
    )\
 
vector_t *vector_create_(const vector_opts_t *const opts);
 
 
void vector_destroy(vector_t *const vector);
 
 
vector_t *vector_clone(const vector_t *const vector);
 
 
vector_status_t vector_resize(vector_t **const vector, const size_t capacity, const vector_status_t error);
 
void* vector_get_ext_header(const vector_t *const vector);
 
 
size_t vector_ext_header_size(const vector_t *const vector);
 
 
size_t vector_data_offset(const vector_t *const vector);
 
alloc_opts_t vector_alloc_opts(const vector_t *const vector);
 
 
size_t vector_element_size(const vector_t *const vector);
 
 
size_t vector_capacity(const vector_t *const vector);
 
 
size_t vector_capacity_bytes(const vector_t *const vector);
 
void *vector_linear_find(const vector_t *const vector,
        const size_t limit,
        const predicate_t predicate,
        void *const param);
 
 
void *vector_binary_find(const vector_t *const vector,
        const void *const value,
        const size_t limit,
        const compare_t cmp,
        void *const param);
 
 
ssize_t vector_binary_find_index(const vector_t *const vector,
        const void *const value,
        const size_t limit,
        const compare_t cmp,
        void *const param);
 
char *vector_data(const vector_t *const vector);
 
 
void *vector_get(const vector_t *const vector, const size_t index);
 
 
void vector_set(vector_t *const vector, const size_t index, const void *const value);
 
 
void vector_set_zero(vector_t *const vector, const size_t index);
 
 
void vector_copy(const vector_t *const vector,
        char *dest,
        const size_t offset,
        const size_t length);
 
 
void vector_move(const vector_t *const vector,
        char *dest,
        const size_t offset,
        const size_t length);
 
 
void vector_part_copy(const vector_t *const vector,
        char *dest,
        const size_t offset,
        const size_t length,
        const size_t part_offset,
        const size_t part_length);
 
 
void vector_spread(vector_t *const vector, const size_t index, const size_t amount);
 
 
void vector_shift(vector_t *const vector,
        const size_t offset,
        const size_t length,
        const ssize_t shift);
 
 
void vector_swap(vector_t *const vector,
        const size_t index_a,
        const size_t index_b);
 
 
int vector_foreach(const vector_t *const vector,
        const size_t limit,
        const foreach_t func,
        void *const param);
 
 
int vector_aggregate(const vector_t *const vector,
        const size_t limit,
        const aggregate_t func,
        void *const acc,
        void *const param);
 
 
int vector_transform(vector_t *const vector,
        const size_t limit,
        const transform_t func,
        void *const param);
 
void *vector_alloc(const size_t alloc_size, void *const param);
 
 
void *vector_realloc(void *ptr, const size_t alloc_size, void *const param);
 
 
void vector_free(void *ptr, void *const param);
 
size_t calc_aligned_size(const size_t size, const size_t alignment);
 
ssize_t cmp_lex_asc(const void *const value, const void *const element, void *const param);
 
 
ssize_t cmp_lex_dsc(const void *const value, const void *const element, void *const param);
 
#endif/*_VECTOR_H_*/