vector.h

Go to the documentation of this file.

/*
 * @file vector.h
 * @brief A minimal vector (resizing array) data type.
 * @ingroup Utilities
 *
 * This is intended to be the simplest way of storing a collection of
 * pointers that is frequently filled and then completely emptied.
 *
 * The corresponding `.c` files are in reactor-c/core/utils/vector
 *
 * @author Peter Donovan
 * @author Soroush Bateni
 */
 
#ifndef VECTOR_H
#define VECTOR_H
 
#include <stddef.h>
#include <stdlib.h>

typedef struct vector_t {
  void** start;

  void** next;

  void** end;

  int votes_required;

  int votes;
} vector_t;

vector_t vector_new(size_t initial_capacity);

void vector_free(vector_t* v);

void vector_push(vector_t* v, void* element);

void vector_pushall(vector_t* v, void** array, size_t size);

void* vector_pop(vector_t* v);

void** vector_at(vector_t* v, size_t idx);

size_t vector_size(vector_t* v);

void vector_vote(vector_t* v);
 
#endif /* VECTOR_H */