Stefan Scholz / ETL
Embed: (wiki syntax)

« Back to documentation index

deque_base Class Reference

The base class for all templated deque types. More...

#include <deque.h>

Inherited by ideque< T >.

Public Member Functions

size_type size () const
 Gets the current size of the deque.
bool empty () const
 Checks the 'empty' state of the deque.
bool full () const
 Checks the 'full' state of the deque.
size_type max_size () const
 Returns the maximum possible size of the deque.
size_t available () const
 Returns the remaining capacity.

Protected Member Functions

 deque_base (size_t max_size_, size_t buffer_size_)
 Constructor.

Protected Attributes

size_type current_size
 The current number of elements in the deque.
const size_type CAPACITY
 The maximum number of elements in the deque.
const size_type BUFFER_SIZE
 The number of elements in the buffer.
etl::debug_count construct_count
 Internal debugging.

Detailed Description

The base class for all templated deque types.

Definition at line 140 of file deque.h.


Constructor & Destructor Documentation

deque_base ( size_t  max_size_,
size_t  buffer_size_ 
) [protected]

Constructor.

Definition at line 196 of file deque.h.


Member Function Documentation

size_t available (  ) const

Returns the remaining capacity.

Returns:
The remaining capacity.

Definition at line 186 of file deque.h.

bool empty (  ) const

Checks the 'empty' state of the deque.

Returns:
true if empty.

Definition at line 159 of file deque.h.

bool full (  ) const

Checks the 'full' state of the deque.

Returns:
true if full.

Definition at line 168 of file deque.h.

size_type max_size (  ) const

Returns the maximum possible size of the deque.

Returns:
The maximum size of the deque.

Definition at line 177 of file deque.h.

size_type size (  ) const

Gets the current size of the deque.

Returns:
The current size of the deque.

Definition at line 150 of file deque.h.


Field Documentation

const size_type BUFFER_SIZE [protected]

The number of elements in the buffer.

Definition at line 205 of file deque.h.

const size_type CAPACITY [protected]

The maximum number of elements in the deque.

Definition at line 204 of file deque.h.

Internal debugging.

Definition at line 206 of file deque.h.

size_type current_size [protected]

The current number of elements in the deque.

Definition at line 203 of file deque.h.