Typed vector

Generic vector of typed values. More...

Collaboration diagram for Typed vector:

Data Structures
struct	typevec_t
	A vector with a fixed type size. More...

Functions
CT_STD_API void	typevec_init (typevec_t *vec, size_t width, size_t len, arena_t *arena)
	initialize a typed vector More...
CT_STD_API typevec_t	typevec_make (size_t width, size_t len, arena_t *arena)
	create a new typed vector on the stack More...
CT_NODISCARD CT_STD_API typevec_t *	typevec_new (size_t width, size_t len, arena_t *arena)
	create a new typed vector on the heap More...
CT_NODISCARD CT_STD_API typevec_t *	typevec_of (size_t width, size_t len, arena_t *arena)
	create a new typed vector with an initial size and length More...
CT_NODISCARD CT_STD_API typevec_t *	typevec_of_array (size_t width, STA_READS(count *width) const void *src, size_t count, arena_t *arena)
	create a new typed vector from an array this copies count * width bytes from src to the vector More...
CT_NODISCARD CT_STD_API typevec_t *	typevec_slice (const typevec_t *vec, size_t start, size_t end)
	create a new typevec from an existing typevec More...
CT_NODISCARD CT_PUREFN CT_STD_API size_t	typevec_len (const typevec_t *vec)
	get the length of a vector More...
CT_STD_API void	typevec_set (typevec_t *vec, size_t index, const void *src)
	set an element in the vector More...
CT_STD_API void	typevec_get (const typevec_t *vec, size_t index, STA_WRITES(vec->width) void *dst)
	get an element from the vector More...
CT_STD_API void	typevec_tail (const typevec_t *vec, void *dst)
	get the last element from the vector More...
CT_STD_API void *	typevec_push (typevec_t *vec, const void *src)
	push a value onto the vector More...
CT_STD_API void	typevec_append (typevec_t *vec, const void *src, size_t len)
	append multiple values onto the vector More...
CT_STD_API void	typevec_pop (typevec_t *vec, void *dst)
	pop a value from the vector More...
CT_NODISCARD CT_PUREFN CT_STD_API void *	typevec_offset (const typevec_t *vec, size_t index)
	get a pointer to the value at the given index More...
CT_NODISCARD CT_PUREFN CT_STD_API void *	typevec_data (const typevec_t *vec)
	get a pointer to the underlying data More...
CT_STD_API void	typevec_sort (typevec_t *vec, int(*cmp)(const void *, const void *))
	sort a vector More...
CT_STD_API void	typevec_reset (typevec_t *vec)
	reset a vector More...

Variables
CT_STD_API const typevec_t	kEmptyTypevec

Detailed Description

Generic vector of typed values.

Function Documentation

typevec_append()

CT_STD_API void typevec_append	(	typevec_t *	vec,
		const void *	src,
		size_t	len
	)

append multiple values onto the vector

Note

this copies len * type_size bytes from src to the vector

Parameters

vec	the vector to append the values onto
src	the values to append
len	the number of values to append

Definition at line 169 of file vector.c.

typevec_data()

CT_NODISCARD CT_PUREFN CT_STD_API void* typevec_data

(

const typevec_t *

vec

)

get a pointer to the underlying data

Note

the pointer is only valid until the next call to typevec_push or typevec_pop

Parameters

vec	the vector to get the data from

Returns

void* a pointer to the data

Definition at line 199 of file vector.c.

typevec_get()

CT_STD_API void typevec_get	(	const typevec_t *	vec,
		size_t	index,
		STA_WRITES(vec->width) void *	dst
	)

get an element from the vector

Precondition

index < typevec_len(vec) this copies width bytes from the vector at index index to dst

Parameters

vec	the vector to get the value from
index	the index to get the value from
dst	the destination to copy the value to

typevec_init()

CT_STD_API void typevec_init	(	typevec_t *	vec,
		size_t	width,
		size_t	len,
		arena_t *	arena
	)

initialize a typed vector

Parameters

vec	the vector to initialize
width	the size of the type
len	the initial length of the vector
arena	the arena to allocate from

Definition at line 53 of file vector.c.

typevec_len()

CT_NODISCARD CT_PUREFN CT_STD_API size_t typevec_len

(

const typevec_t *

vec

)

get the length of a vector

Parameters

vec	the vector to get the length of

Returns

the length of the vector

Definition at line 120 of file vector.c.

typevec_make()

CT_STD_API typevec_t typevec_make	(	size_t	width,
		size_t	len,
		arena_t *	arena
	)

create a new typed vector on the stack

Parameters

width	the size of the type
len	the initial length of the vector
arena	the arena to allocate from

Returns

the new vector

Definition at line 69 of file vector.c.

typevec_new()

CT_NODISCARD CT_STD_API typevec_t* typevec_new	(	size_t	width,
		size_t	len,
		arena_t *	arena
	)

create a new typed vector on the heap

Parameters

width	the size of the type
len	the initial length of the vector
arena	the arena to allocate from

Returns

the new vector

Definition at line 77 of file vector.c.

typevec_of()

CT_NODISCARD CT_STD_API typevec_t* typevec_of	(	size_t	width,
		size_t	len,
		arena_t *	arena
	)

create a new typed vector with an initial size and length

Note

it is expected that the user will fill the vector up to len using typevec_set with valid values rather than using typevec_push

Parameters

width	the size of the type
len	the initial length of the vector
arena	the arena to allocate from

Returns

the new vector

Definition at line 83 of file vector.c.

typevec_of_array()

CT_NODISCARD CT_STD_API typevec_t* typevec_of_array	(	size_t	width,
		STA_READS(count *width) const void *	src,
		size_t	count,
		arena_t *	arena
	)

create a new typed vector from an array this copies count * width bytes from src to the vector

Parameters

width	the size of the type
src	the array to copy from
count	the number of elements in the array
arena	the arena to allocate from

Returns

the new vector

typevec_offset()

CT_NODISCARD CT_PUREFN CT_STD_API void* typevec_offset	(	const typevec_t *	vec,
		size_t	index
	)

get a pointer to the value at the given index

Precondition

index < typevec_len(vec)

Note

the pointer is only valid until the next call to typevec_push or typevec_pop

Parameters

vec	the vector to get the value from
index	the index to get the value from

Returns

void* a pointer to the value

Definition at line 191 of file vector.c.

typevec_pop()

CT_STD_API void typevec_pop	(	typevec_t *	vec,
		void *	dst
	)

pop a value from the vector

Parameters

vec	the vector to pop the value from
dst	the destination to copy the value to

Definition at line 182 of file vector.c.

typevec_push()

CT_STD_API void* typevec_push	(	typevec_t *	vec,
		const void *	src
	)

push a value onto the vector

Parameters

vec	the vector to push the value onto
src	the value to push

Definition at line 156 of file vector.c.

typevec_reset()

CT_STD_API void typevec_reset

(

typevec_t *

vec

)

reset a vector

Warning

this does not perform cleanup on the data in the vector if the data requires cleanup, it must be done manually.

Parameters

vec	the vector to reset

Definition at line 217 of file vector.c.

typevec_set()

CT_STD_API void typevec_set	(	typevec_t *	vec,
		size_t	index,
		const void *	src
	)

set an element in the vector

Precondition

index < typevec_len(vec) this reads width bytes from src and copies them to the vector

Parameters

vec	the vector to set the value in
index	the index to set the value at
src	the value to set

Definition at line 128 of file vector.c.

typevec_slice()

CT_NODISCARD CT_STD_API typevec_t* typevec_slice	(	const typevec_t *	vec,
		size_t	start,
		size_t	end
	)

create a new typevec from an existing typevec

Precondition

start < end and end <= typevec_len(vec)

Parameters

vec	the vector to copy
start	the start index
end	the end index

Returns

the new vector

Definition at line 104 of file vector.c.

typevec_sort()

CT_STD_API void typevec_sort	(	typevec_t *	vec,
		int(*)(const void *, const void *)	cmp
	)

sort a vector

Parameters

vec	the vector to sort
cmp	the comparison function

Definition at line 206 of file vector.c.

typevec_tail()

CT_STD_API void typevec_tail	(	const typevec_t *	vec,
		void *	dst
	)

get the last element from the vector

Parameters

vec	the vector to get the value from
dst	the destination to copy the value to

Definition at line 148 of file vector.c.

Variable Documentation

kEmptyTypevec

CT_STD_API const typevec_t kEmptyTypevec

extern

Definition at line 13 of file vector.c.