olaf_deque.h File Reference

A double ended queue interface. More...

Go to the source code of this file.

Typedefs
typedef struct Olaf_Deque	Olaf_Deque

Functions
Olaf_Deque *	olaf_deque_new (size_t size)
	Create an new double ended queue.
void	olaf_deque_push_back (Olaf_Deque *olaf_deque, size_t value)
	Push a value to the end of the deque.
size_t	olaf_deque_back (Olaf_Deque *olaf_deque)
	Return the back of the deque.
bool	olaf_deque_empty (Olaf_Deque *olaf_deque)
	Checks if the deque is empty.
size_t	olaf_deque_front (Olaf_Deque *olaf_deque)
	The front of the deque.
void	olaf_deque_pop_back (Olaf_Deque *olaf_deque)
	Pop the back from the deque.
void	olaf_deque_pop_front (Olaf_Deque *olaf_deque)
	Remove the front of the deque.
void	olaf_deque_destroy (Olaf_Deque *olaf_deque)
	Free resources and memory related to the deque.

Detailed Description

A double ended queue interface.

This hides the underlying dequeue implementation used and gives a stable and simple interface for use in Olaf. It also manages memory related to the deque. Additionally, it adds a level of indirection which might come in handy to replace the underlying implementation.

Function Documentation

olaf_deque_back()

size_t olaf_deque_back

(

Olaf_Deque *

olaf_deque

)

Return the back of the deque.

Parameters

olaf_deque

The olaf deque

Returns

The back, tail of the deque

olaf_deque_destroy()

void olaf_deque_destroy

(

Olaf_Deque *

olaf_deque

)

Free resources and memory related to the deque.

Parameters

olaf_deque

The olaf deque

olaf_deque_empty()

bool olaf_deque_empty

(

Olaf_Deque *

olaf_deque

)

Checks if the deque is empty.

Parameters

olaf_deque

The olaf deque

Returns

True if the deque is empty

olaf_deque_front()

size_t olaf_deque_front

(

Olaf_Deque *

olaf_deque

)

The front of the deque.

Parameters

olaf_deque

The olaf deque

Returns

The front of the deque.

olaf_deque_new()

Olaf_Deque * olaf_deque_new

(

size_t

size

)

Create an new double ended queue.

Parameters

[in]

size

The maximum size of de deque. Memory is allocated on initialization.

Returns

The state of the deque.

olaf_deque_pop_back()

void olaf_deque_pop_back

(

Olaf_Deque *

olaf_deque

)

Pop the back from the deque.

Parameters

olaf_deque

The olaf deque

olaf_deque_pop_front()

void olaf_deque_pop_front

(

Olaf_Deque *

olaf_deque

)

Remove the front of the deque.

Parameters

olaf_deque

The olaf deque

olaf_deque_push_back()

void olaf_deque_push_back	(	Olaf_Deque *	olaf_deque,
		size_t	value
	)

Push a value to the end of the deque.

Parameters

	olaf_deque	The olaf deque
[in]	value	The value