marigold_dynamic_array.h

Go to the documentation of this file.

#ifndef DYNAMIC_ARRAY_H
#define DYNAMIC_ARRAY_H
 
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
 
typedef struct dynamic_array
{
        size_t item_size;
        void* memory_block_pointer;
 
        unsigned int starting_capacity;
        unsigned int current_capacity;
        unsigned int current_size;
 
        unsigned short owner_count;
 
        unsigned char growth_factor;
        bool is_multithread_safe;
} dynamic_array;
 
dynamic_array* dynamic_array_create(size_t item_size,
                                    unsigned int starting_capacity,
                                    unsigned char growth_factor,
                                    bool is_multithread_safe);
 
unsigned int dynamic_array_get_occupancy(const dynamic_array* array);
 
unsigned int dynamic_array_get_capacity(const dynamic_array* array);
 
void* dynamic_array_get_pointer_to_index(const dynamic_array* array,
                                         const unsigned int index);
 
const void* dynamic_array_get_const_pointer_to_index(const dynamic_array* array,
                                                     const unsigned int index);
 
bool dynamic_array_append(const dynamic_array* array,
                          const void* element);
 
bool dynamic_array_pop(const dynamic_array* array);
 
bool dynamic_array_remove(const dynamic_array* array,
                          const unsigned int index);
 
void dynamic_array_clear(const dynamic_array* array);
 
bool dynamic_array_is_empty(const dynamic_array* array);
 
bool dynamic_array_increase_capacity(const dynamic_array* array,
                                     const unsigned int new_capacity);
 
bool dynamic_array_acquire(const dynamic_array* array);
 
bool dynamic_array_release(const dynamic_array* array);
 
unsigned short dynamic_array_get_owner_count(const dynamic_array* array);
 
bool dynamic_array_is_thread_safe(const dynamic_array* array);
 
bool dynamic_array_clone(const dynamic_array* original_array,
                         const dynamic_array* new_array);
 
#endif /* DYNAMIC_ARRAY_H */