vector.h

Go to the documentation of this file.

/*
 * This file defines a minimal vector (resizing array) data type.
 * It is intended to be the simplest way of storing a collection of
 * pointers that is frequently filled and then completely emptied.
 *
 * @author Peter Donovan (peterdonovan@berkeley.edu)
 * @author Soroush Bateni (soroush@utdallas.edu)
 */
 
#ifndef VECTOR_H
#define VECTOR_H
 
#include <stddef.h>
#include <stdlib.h>
 
typedef struct vector_t {
  void** start;       /* The start of the underlying array. */
  void** next;        /* The element after the last element in the underlying array.
                            start <= next <= end. */
  void** end;         /* The end of the underlying array. */
  int votes_required; /* The number of votes required to shrink this vector. */
  int votes;          /* The number of votes to shrink this vector. */
} 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 */