Generic vector. More...

Collaboration diagram for Generic vector:

Functions
CT_STD_API void	vector_delete (STA_RELEASE vector_t *vector)
	destroy a vector More...

CT_NODISCARD CT_STD_API vector_t *	vector_new (size_t size, arena_t *arena)
	create a new vector with an initial capacity More...

CT_NODISCARD CT_STD_API vector_t *	vector_of (size_t len, arena_t *arena)
	create a new vector with a specified length More...

CT_NODISCARD CT_STD_API vector_t *	vector_init (void value, arena_t arena)
	create a new vector with a single initial value More...

CT_NODISCARD CT_STD_API vector_t *	vector_clone (vector_t *vector)
	clone a vector More...

CT_STD_API void	vector_push (vector_t *vector, void value)
	push a value onto the end of a vector More...

CT_STD_API void	vector_drop (vector_t *vector)
	pop a value from the end of a vector More...

CT_STD_API void	vector_set (vector_t vector, size_t index, void value)
	set a value in a vector More...

CT_NODISCARD CT_PUREFN CT_STD_API void *	vector_get (const vector_t *vector, size_t index)
	get a value from a vector More...

CT_NODISCARD CT_PUREFN CT_STD_API void *	vector_tail (const vector_t *vector)
	get the last element of a vector More...

CT_NODISCARD CT_PUREFN CT_STD_API size_t	vector_len (const vector_t *vector)
	get the length of a vector More...

CT_STD_API void	vector_append (vector_t *vector, const vector_t other)
	append the contents of one vector to another this copies the contents of `other` into `vector` More...

CT_PUREFN CT_STD_API size_t	vector_find (vector_t vector, const void element)
	find an element in a vector searches via pointer equality More...

CT_STD_API void	vector_reset (vector_t *vec)
	reset the contents of a vector More...

CT_STD_API void **	vector_data (vector_t *vec)
	get the data of a vector More...

Variables
CT_STD_API vector_t	gEmptyVector
	a global empty vector used to avoid allocating alot of empty vectors More...

CT_STD_API const vector_t	kEmptyVector
	a global empty vector used to avoid allocating alot of empty vectors More...

Detailed Description

Generic vector.

Function Documentation

◆ vector_append()

CT_STD_API void vector_append	(	vector_t **	vector,
		const vector_t *	other
	)

append the contents of one vector to another this copies the contents of other into vector

Parameters

vector	the vector to append to
other	the vector to append

Definition at line 176 of file vector.c.

◆ vector_clone()

CT_NODISCARD CT_STD_API vector_t* vector_clone ( vector_t * vector )

clone a vector

Parameters

vector the vector to clone

Returns: a new vector with the same contents as vector

Definition at line 89 of file vector.c.

◆ vector_data()

CT_STD_API void** vector_data ( vector_t * vec )

get the data of a vector

Warning: this is only valid until the next modification of the vector

Parameters

vec	the vector to get the data of

Returns: the data of vec

Definition at line 196 of file vector.c.

◆ vector_delete()

CT_STD_API void vector_delete ( STA_RELEASE vector_t * vector )

destroy a vector

Note: this only frees the vector itself, not the data it references

Parameters

vector the vector to destroy

◆ vector_drop()

CT_STD_API void vector_drop ( vector_t * vector )

pop a value from the end of a vector

Warning: invalid on an empty vector

Parameters

vector the vector to pop from

Definition at line 117 of file vector.c.

◆ vector_find()

CT_PUREFN CT_STD_API size_t vector_find	(	vector_t *	vector,
		const void *	element
	)

find an element in a vector searches via pointer equality

Parameters

vector	the vector to search
element	the element to search for

Returns: the index of element in vector or SIZE_MAX if not found

Definition at line 160 of file vector.c.

◆ vector_get()

CT_NODISCARD CT_PUREFN CT_STD_API void* vector_get	(	const vector_t *	vector,
		size_t	index
	)

get a value from a vector

Precondition: index < vector_len(vector)

Parameters

vector	the vector to get from
index	the index to get

Returns: the value at index

Definition at line 134 of file vector.c.

◆ vector_init()

CT_NODISCARD CT_STD_API vector_t* vector_init	(	void *	value,
		arena_t *	arena
	)

create a new vector with a single initial value

this is equivalent to

vector_t *vec = vector_of(1, arena);

vector_set(vec, 0, value);

vector_of

CT_NODISCARD CT_STD_API vector_t * vector_of(size_t len, arena_t *arena)

create a new vector with a specified length

Definition: vector.c:71

vector_set

CT_STD_API void vector_set(vector_t *vector, size_t index, void *value)

set a value in a vector

Definition: vector.c:125

vector_t

a generic vector of pointers

Definition: vector.c:16

Parameters

value	the initial value of the vector
arena	the arena to allocate from

Returns: a new vector

Definition at line 79 of file vector.c.

◆ vector_len()

CT_NODISCARD CT_PUREFN CT_STD_API size_t vector_len ( const vector_t * vector )

get the length of a vector

Parameters

vector the vector to get the length of

Returns: the length of vector

Definition at line 152 of file vector.c.

◆ vector_new()

CT_NODISCARD CT_STD_API vector_t* vector_new	(	size_t	size,
		arena_t *	arena
	)

create a new vector with an initial capacity

Parameters

size	the initial capacity of the vector
arena	the arena to allocate from

Returns: a new vector

Definition at line 63 of file vector.c.

◆ vector_of()

CT_NODISCARD CT_STD_API vector_t* vector_of	(	size_t	len,
		arena_t *	arena
	)

create a new vector with a specified length

Note: these elements should be filled in manually by the caller using vector_set vector_push is invalid until the vector is filled.

Parameters

len	the initial size of the vector
arena	the arena to allocate from

Returns: a new vector

Definition at line 71 of file vector.c.

◆ vector_push()

CT_STD_API void vector_push	(	vector_t **	vector,
		void *	value
	)

push a value onto the end of a vector

Parameters

vector	the vector to push onto
value	the value to push

Definition at line 108 of file vector.c.

◆ vector_reset()

CT_STD_API void vector_reset ( vector_t * vec )

reset the contents of a vector

Warning: this does not free the data the vector references

Parameters

vec	the vector to reset

Definition at line 188 of file vector.c.

◆ vector_set()

CT_STD_API void vector_set	(	vector_t *	vector,
		size_t	index,
		void *	value
	)

set a value in a vector

Precondition: index < vector_len(vector)

Parameters

vector	the vector to set in
index	the index to set
value	the value to set

Definition at line 125 of file vector.c.

◆ vector_tail()

CT_NODISCARD CT_PUREFN CT_STD_API void* vector_tail ( const vector_t * vector )

get the last element of a vector

Precondition: vector_len(vector) > 0

Parameters

vector the vector to get the last element of

Returns: the last element of vector

Definition at line 143 of file vector.c.

Variable Documentation

◆ gEmptyVector

CT_STD_API vector_t gEmptyVector

extern

a global empty vector used to avoid allocating alot of empty vectors

holding off on making it const until all the parsers are updated to handle it

Warning: doing anything with this vector aside from getting its length is invalid

Definition at line 24 of file vector.c.

◆ kEmptyVector

CT_STD_API const vector_t kEmptyVector

extern

a global empty vector used to avoid allocating alot of empty vectors

Warning: doing anything with this vector aside from getting its length is invalid

Definition at line 25 of file vector.c.

Functions

Variables

Detailed Description

Function Documentation

◆ vector_append()

◆ vector_clone()

◆ vector_data()

◆ vector_delete()

◆ vector_drop()

◆ vector_find()

◆ vector_get()

◆ vector_init()

◆ vector_len()

◆ vector_new()

◆ vector_of()

◆ vector_push()

◆ vector_reset()

◆ vector_set()

◆ vector_tail()

Variable Documentation

◆ gEmptyVector

◆ kEmptyVector