circular_buffer.h File Reference

Go to the source code of this file.

Data Structures
struct	cvx_container
struct	circular_buffer_vtabv
struct	circular_buffer
struct	circular_buffer_iter

Typedefs
typedef struct cvx_container	cvx_container

Enumerations
enum	cvx_flags {   CVX_FLAG_OK = 0 , CVX_FLAG_VTAB = 1 , CVX_FLAG_WRONG_TAG = 2 , CVX_FLAG_ALLOC = 3 ,   CVX_FLAG_EMPTY = 4 , CVX_FLAG_FULL = 5 , CVX_FLAG_RANGE = 6 , CVX_FLAG_NOT_FOUND = 7 ,   CVX_FLAG_INVALID = 8 , CVX_FLAG_DUPLICATE = 9 , CVX_FLAG_ERROR = 10 }
	circular_buffer.h More...
enum	cvx_heap_order { CVX_MAX_HEAP = 1 , CVX_MIN_HEAP = -1 }
	enum cvx_heap_order More...

Functions
void	cb_init (struct circular_buffer *self, struct circular_buffer_vtabv *vtabv, size_t capacity)
void	cb_clone (struct circular_buffer *orig, struct circular_buffer *clone)
void	cb_drop (struct circular_buffer *self)
enum cvx_flags	cb_flag (struct circular_buffer *_self_)
size_t	cb_count (struct circular_buffer *_self_)
size_t	cb_capacity (struct circular_buffer *_self_)
_Bool	cb_empty (struct circular_buffer *_self_)
_Bool	cb_full (struct circular_buffer *_self_)
_Bool	cb_is_linearized (struct circular_buffer *_self_)
TVal	cb_front (struct circular_buffer *_self_)
TVal	cb_back (struct circular_buffer *_self_)
TVal	cb_get (struct circular_buffer *_self_, size_t _index_)
void	cb_push_back (struct circular_buffer *_self_, TVal _item_)
	Push an element to the back. When full, overwrites the front element.
void	cb_push_front (struct circular_buffer *_self_, TVal _item_)
	Push an element to the front. When full, overwrites the back element.
TVal	cb_pop_back (struct circular_buffer *_self_)
	Remove and return the back element.
TVal	cb_pop_front (struct circular_buffer *_self_)
	Remove and return the front element.
void	cb_set_capacity (struct circular_buffer *_self_, size_t _new_cap_)
	Resize the buffer. If shrinking below count, drops the excess front elements.
void	cb_linearize (struct circular_buffer *_self_)
	Rearrange the internal buffer so elements are contiguous starting at index 0.
struct circular_buffer_iter	cb_iter_init_start (struct circular_buffer *_target_)
	ITERATOR.
struct circular_buffer_iter	cb_iter_init_end (struct circular_buffer *_target_)
struct circular_buffer_iter *	cb_iter_start (struct circular_buffer *_target_)
struct circular_buffer_iter *	cb_iter_end (struct circular_buffer *_target_)
void	cb_iter_drop (struct circular_buffer_iter *_iter_)
_Bool	cb_iter_at_start (struct circular_buffer_iter *_iter_)
_Bool	cb_iter_at_end (struct circular_buffer_iter *_iter_)
size_t	cb_iter_count (struct circular_buffer_iter *_iter_)
void	cb_iter_to_start (struct circular_buffer_iter *_iter_)
void	cb_iter_to_end (struct circular_buffer_iter *_iter_)
void	cb_iter_next (struct circular_buffer_iter *_iter_)
void	cb_iter_prev (struct circular_buffer_iter *_iter_)
void	cb_iter_forward (struct circular_buffer_iter *_iter_, size_t _steps_)
void	cb_iter_backward (struct circular_buffer_iter *_iter_, size_t _steps_)
void	cb_iter_go_to (struct circular_buffer_iter *_iter_, size_t _index_)
TVal	cb_iter_value (struct circular_buffer_iter *_iter_)
size_t	cb_iter_index (struct circular_buffer_iter *_iter_)
void	cb__proxy_clone (cvx_container *_orig_, cvx_container *_clone_)
	PROXIES.
void	cb__proxy_drop (cvx_container *_col_)
enum cvx_flags	cb__proxy_flag (cvx_container *_col_)
size_t	cb__proxy_count (cvx_container *_col_)
size_t	cb__proxy_capacity (cvx_container *_col_)
_Bool	cb__proxy_empty (cvx_container *_col_)
_Bool	cb__proxy_full (cvx_container *_col_)
_Bool	cb__proxy_is_linearized (cvx_container *_col_)
TVal	cb__proxy_front (cvx_container *_col_)
TVal	cb__proxy_back (cvx_container *_col_)
TVal	cb__proxy_get (cvx_container *_col_, size_t _index_)
void	cb__proxy_push_back (cvx_container *_col_, TVal _item_)
void	cb__proxy_push_front (cvx_container *_col_, TVal _item_)
TVal	cb__proxy_pop_back (cvx_container *_col_)
TVal	cb__proxy_pop_front (cvx_container *_col_)
void	cb__proxy_set_capacity (cvx_container *_col_, size_t _new_cap_)
void	cb__proxy_linearize (cvx_container *_col_)
cvx_container *	cb__proxy_iter_start (cvx_container *_col_)
cvx_container *	cb__proxy_iter_end (cvx_container *_col_)
void	cb__proxy_iter_drop (cvx_container *_col_)
_Bool	cb__proxy_iter_at_start (cvx_container *_col_)
_Bool	cb__proxy_iter_at_end (cvx_container *_col_)
size_t	cb__proxy_iter_count (cvx_container *_col_)
void	cb__proxy_iter_to_start (cvx_container *_col_)
void	cb__proxy_iter_to_end (cvx_container *_col_)
void	cb__proxy_iter_next (cvx_container *_col_)
void	cb__proxy_iter_prev (cvx_container *_col_)
void	cb__proxy_iter_forward (cvx_container *_col_, size_t _steps_)
void	cb__proxy_iter_backward (cvx_container *_col_, size_t _steps_)
void	cb__proxy_iter_go_to (cvx_container *_col_, size_t _index_)
TVal	cb__proxy_iter_value (cvx_container *_col_)
size_t	cb__proxy_iter_index (cvx_container *_col_)

Typedef Documentation

cvx_container

typedef struct cvx_container cvx_container

Enumeration Type Documentation

cvx_flags

enum cvx_flags

circular_buffer.h

Status

[x] concept [ ] v1 [ ] tests [ ] refine [ ] stabilize

Status and error flags for the CVX library.

Error Handling

Enumerator
CVX_FLAG_OK	No errors.
CVX_FLAG_VTAB	Required vtab function was not provided.
CVX_FLAG_WRONG_TAG	Tags are checked so you don't pass the wrong struct to a function.
CVX_FLAG_ALLOC	Allocation failed.
CVX_FLAG_EMPTY	Operation can not proceed because the container is empty.
CVX_FLAG_FULL	When a container that doesn't resize is full.
CVX_FLAG_RANGE	Index out of range.
CVX_FLAG_NOT_FOUND	Key or value not found.
CVX_FLAG_INVALID	Invalid argument or operation.
CVX_FLAG_DUPLICATE	Duplicate key or value.
CVX_FLAG_ERROR	Generic error, or unknown error.

cvx_heap_order

enum cvx_heap_order

enum cvx_heap_order

Defines the two possible heaps:

• Max Heap has the greatest element at the top
• Min Heap has the smallest element at the top

Enumerator
CVX_MAX_HEAP
CVX_MIN_HEAP

Function Documentation

cb__proxy_back()

TVal cb__proxy_back

(

cvx_container *

_col_

)

cb__proxy_capacity()

size_t cb__proxy_capacity

(

cvx_container *

_col_

)

cb__proxy_clone()

void cb__proxy_clone	(	cvx_container *	_orig_,
		cvx_container *	_clone_
	)

PROXIES.

cb__proxy_count()

size_t cb__proxy_count

(

cvx_container *

_col_

)

cb__proxy_drop()

void cb__proxy_drop

(

cvx_container *

_col_

)

cb__proxy_empty()

_Bool cb__proxy_empty

(

cvx_container *

_col_

)

cb__proxy_flag()

enum cvx_flags cb__proxy_flag

(

cvx_container *

_col_

)

cb__proxy_front()

TVal cb__proxy_front

(

cvx_container *

_col_

)

cb__proxy_full()

_Bool cb__proxy_full

(

cvx_container *

_col_

)

cb__proxy_get()

TVal cb__proxy_get	(	cvx_container *	_col_,
		size_t	_index_
	)

cb__proxy_is_linearized()

_Bool cb__proxy_is_linearized

(

cvx_container *

_col_

)

cb__proxy_iter_at_end()

_Bool cb__proxy_iter_at_end

(

cvx_container *

_col_

)

cb__proxy_iter_at_start()

_Bool cb__proxy_iter_at_start

(

cvx_container *

_col_

)

cb__proxy_iter_backward()

void cb__proxy_iter_backward	(	cvx_container *	_col_,
		size_t	_steps_
	)

cb__proxy_iter_count()

size_t cb__proxy_iter_count

(

cvx_container *

_col_

)

cb__proxy_iter_drop()

void cb__proxy_iter_drop

(

cvx_container *

_col_

)

cb__proxy_iter_end()

cvx_container * cb__proxy_iter_end

(

cvx_container *

_col_

)

cb__proxy_iter_forward()

void cb__proxy_iter_forward	(	cvx_container *	_col_,
		size_t	_steps_
	)

cb__proxy_iter_go_to()

void cb__proxy_iter_go_to	(	cvx_container *	_col_,
		size_t	_index_
	)

cb__proxy_iter_index()

size_t cb__proxy_iter_index

(

cvx_container *

_col_

)

cb__proxy_iter_next()

void cb__proxy_iter_next

(

cvx_container *

_col_

)

cb__proxy_iter_prev()

void cb__proxy_iter_prev

(

cvx_container *

_col_

)

cb__proxy_iter_start()

cvx_container * cb__proxy_iter_start

(

cvx_container *

_col_

)

cb__proxy_iter_to_end()

void cb__proxy_iter_to_end

(

cvx_container *

_col_

)

cb__proxy_iter_to_start()

void cb__proxy_iter_to_start

(

cvx_container *

_col_

)

cb__proxy_iter_value()

TVal cb__proxy_iter_value

(

cvx_container *

_col_

)

cb__proxy_linearize()

void cb__proxy_linearize

(

cvx_container *

_col_

)

cb__proxy_pop_back()

TVal cb__proxy_pop_back

(

cvx_container *

_col_

)

cb__proxy_pop_front()

TVal cb__proxy_pop_front

(

cvx_container *

_col_

)

cb__proxy_push_back()

void cb__proxy_push_back	(	cvx_container *	_col_,
		TVal	_item_
	)

cb__proxy_push_front()

void cb__proxy_push_front	(	cvx_container *	_col_,
		TVal	_item_
	)

cb__proxy_set_capacity()

void cb__proxy_set_capacity	(	cvx_container *	_col_,
		size_t	_new_cap_
	)

cb_back()

TVal cb_back

(

struct circular_buffer *

_self_

)

cb_capacity()

size_t cb_capacity

(

struct circular_buffer *

_self_

)

cb_clone()

void cb_clone	(	struct circular_buffer *	orig,
		struct circular_buffer *	clone
	)

cb_count()

size_t cb_count

(

struct circular_buffer *

_self_

)

cb_drop()

void cb_drop

(

struct circular_buffer *

self

)

cb_empty()

_Bool cb_empty

(

struct circular_buffer *

_self_

)

cb_flag()

enum cvx_flags cb_flag

(

struct circular_buffer *

_self_

)

cb_front()

TVal cb_front

(

struct circular_buffer *

_self_

)

cb_full()

_Bool cb_full

(

struct circular_buffer *

_self_

)

cb_get()

TVal cb_get	(	struct circular_buffer *	_self_,
		size_t	_index_
	)

cb_init()

void cb_init	(	struct circular_buffer *	self,
		struct circular_buffer_vtabv *	vtabv,
		size_t	capacity
	)

cb_is_linearized()

_Bool cb_is_linearized

(

struct circular_buffer *

_self_

)

cb_iter_at_end()

_Bool cb_iter_at_end

(

struct circular_buffer_iter *

_iter_

)

cb_iter_at_start()

_Bool cb_iter_at_start

(

struct circular_buffer_iter *

_iter_

)

cb_iter_backward()

void cb_iter_backward	(	struct circular_buffer_iter *	_iter_,
		size_t	_steps_
	)

cb_iter_count()

size_t cb_iter_count

(

struct circular_buffer_iter *

_iter_

)

cb_iter_drop()

void cb_iter_drop

(

struct circular_buffer_iter *

_iter_

)

cb_iter_end()

struct circular_buffer_iter * cb_iter_end

(

struct circular_buffer *

_target_

)

cb_iter_forward()

void cb_iter_forward	(	struct circular_buffer_iter *	_iter_,
		size_t	_steps_
	)

cb_iter_go_to()

void cb_iter_go_to	(	struct circular_buffer_iter *	_iter_,
		size_t	_index_
	)

cb_iter_index()

size_t cb_iter_index

(

struct circular_buffer_iter *

_iter_

)

cb_iter_init_end()

struct circular_buffer_iter cb_iter_init_end

(

struct circular_buffer *

_target_

)

cb_iter_init_start()

struct circular_buffer_iter cb_iter_init_start

(

struct circular_buffer *

_target_

)

ITERATOR.

cb_iter_next()

void cb_iter_next

(

struct circular_buffer_iter *

_iter_

)

cb_iter_prev()

void cb_iter_prev

(

struct circular_buffer_iter *

_iter_

)

cb_iter_start()

struct circular_buffer_iter * cb_iter_start

(

struct circular_buffer *

_target_

)

cb_iter_to_end()

void cb_iter_to_end

(

struct circular_buffer_iter *

_iter_

)

cb_iter_to_start()

void cb_iter_to_start

(

struct circular_buffer_iter *

_iter_

)

cb_iter_value()

TVal cb_iter_value

(

struct circular_buffer_iter *

_iter_

)

cb_linearize()

void cb_linearize

(

struct circular_buffer *

_self_

)

Rearrange the internal buffer so elements are contiguous starting at index 0.

cb_pop_back()

TVal cb_pop_back

(

struct circular_buffer *

_self_

)

Remove and return the back element.

cb_pop_front()

TVal cb_pop_front

(

struct circular_buffer *

_self_

)

Remove and return the front element.

cb_push_back()

void cb_push_back	(	struct circular_buffer *	_self_,
		TVal	_item_
	)

Push an element to the back. When full, overwrites the front element.

cb_push_front()

void cb_push_front	(	struct circular_buffer *	_self_,
		TVal	_item_
	)

Push an element to the front. When full, overwrites the back element.

cb_set_capacity()

void cb_set_capacity	(	struct circular_buffer *	_self_,
		size_t	_new_cap_
	)

Resize the buffer. If shrinking below count, drops the excess front elements.