STL-like deque container using pre-allocated buffer. More...

#include <PreallocatedDeque.h>

Public Types
typedef T	value_type

typedef std::size_t	size_type

typedef std::ptrdiff_t	difference_type

typedef PreallocatedDeque_iterator< T, T &, T , PreallocatedDeque >	iterator

typedef PreallocatedDeque_iterator< T, const T &, const T , const PreallocatedDeque >	const_iterator

typedef value_type &	reference

typedef const value_type &	const_reference

typedef value_type *	pointer

typedef const value_type *	const_pointer

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
	PreallocatedDeque ()
	Default constructor.

	PreallocatedDeque (void *preallocated_buffer, size_type buffer_size)
	Constructor.

	~PreallocatedDeque ()
	Destructor.

void	init (void *preallocated_buffer, size_type buffer_size)
	Initialize.

PreallocatedDeque &	operator= (const PreallocatedDeque &x)

size_type	size () const

size_type	max_size () const

size_type	available_size () const

bool	empty () const

bool	full () const

void	clear ()

reference	operator[] (size_type idx)

const_reference	operator[] (size_type idx) const

reference	at (size_type idx)

const_reference	at (size_type idx) const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

reference	front ()

const_reference	front () const

reference	back ()

const_reference	back () const

void	resize (size_type n, const T &data=T())

void	push_back (const T &data)

void	pop_back ()

void	push_front (const T &data)

void	pop_front ()

void	assign (size_type n, const T &data)

template<typename InputIterator >
void	assign (InputIterator first, InputIterator last)

iterator	insert (iterator pos, const T &data)

void	insert (iterator pos, size_type n, const T &data)

template<typename InputIterator >
void	insert (iterator pos, InputIterator first, InputIterator last)

iterator	erase (iterator pos)

iterator	erase (iterator first, iterator last)

Detailed Description

template<typename T>
class Container::PreallocatedDeque< T >

STL-like deque container using pre-allocated buffer.

Template Parameters

T	Type of element

Almost all the method specification is similar as STL deque, but this container can not expand the capacity.

Over capacity addition of element throws the exception derived from std::exception. But if CPPELIB_NO_EXCEPTIONS macro is defined, aborted instead of the exception.

Member Typedef Documentation

◆ const_iterator

template<typename T >

typedef PreallocatedDeque_iterator<T, const T&, const T*, const PreallocatedDeque*> Container::PreallocatedDeque< T >::const_iterator

◆ const_pointer

template<typename T >

typedef const value_type* Container::PreallocatedDeque< T >::const_pointer

◆ const_reference

template<typename T >

typedef const value_type& Container::PreallocatedDeque< T >::const_reference

◆ const_reverse_iterator

template<typename T >

typedef std::reverse_iterator<const_iterator> Container::PreallocatedDeque< T >::const_reverse_iterator

◆ difference_type

template<typename T >

typedef std::ptrdiff_t Container::PreallocatedDeque< T >::difference_type

◆ iterator

template<typename T >

typedef PreallocatedDeque_iterator<T, T&, T*, PreallocatedDeque*> Container::PreallocatedDeque< T >::iterator

◆ pointer

template<typename T >

typedef value_type* Container::PreallocatedDeque< T >::pointer

◆ reference

template<typename T >

typedef value_type& Container::PreallocatedDeque< T >::reference

◆ reverse_iterator

template<typename T >

typedef std::reverse_iterator<iterator> Container::PreallocatedDeque< T >::reverse_iterator

◆ size_type

template<typename T >

typedef std::size_t Container::PreallocatedDeque< T >::size_type

◆ value_type

template<typename T >

typedef T Container::PreallocatedDeque< T >::value_type

Constructor & Destructor Documentation

◆ PreallocatedDeque() [1/2]

template<typename T >

Container::PreallocatedDeque< T >::PreallocatedDeque ( )

inline

Default constructor.

Attention: If you use default constructor, you need to call init() before other method call.

◆ PreallocatedDeque() [2/2]

template<typename T >

Container::PreallocatedDeque< T >::PreallocatedDeque	(	void *	preallocated_buffer,
		size_type	buffer_size
	)

inline

Constructor.

Parameters

preallocated_buffer	Pre-allocated buffer by caller
buffer_size	Number of bytes of preallocated_buffer

Attention: preallocated_buffer must be aligned on the boundary of type T.

◆ ~PreallocatedDeque()

template<typename T >

Container::PreallocatedDeque< T >::~PreallocatedDeque ( )

inline

Destructor.

Note: All elements are erased, but pre-allocated buffer is not released.

Member Function Documentation

◆ assign() [1/2]

template<typename T >

template<typename InputIterator >

void Container::PreallocatedDeque< T >::assign	(	InputIterator	first,
		InputIterator	last
	)

inline

◆ assign() [2/2]

template<typename T >

void Container::PreallocatedDeque< T >::assign	(	size_type	n,
		const T &	data
	)

inline

◆ at() [1/2]

template<typename T >

reference Container::PreallocatedDeque< T >::at ( size_type idx )

inline

◆ at() [2/2]

template<typename T >

const_reference Container::PreallocatedDeque< T >::at ( size_type idx ) const

inline

◆ available_size()

template<typename T >

size_type Container::PreallocatedDeque< T >::available_size ( ) const

inline

◆ back() [1/2]

template<typename T >

reference Container::PreallocatedDeque< T >::back ( )

inline

◆ back() [2/2]

template<typename T >

const_reference Container::PreallocatedDeque< T >::back ( ) const

inline

◆ begin() [1/2]

template<typename T >

iterator Container::PreallocatedDeque< T >::begin ( )

inline

◆ begin() [2/2]

template<typename T >

const_iterator Container::PreallocatedDeque< T >::begin ( ) const

inline

◆ clear()

template<typename T >

void Container::PreallocatedDeque< T >::clear ( )

inline

◆ empty()

template<typename T >

bool Container::PreallocatedDeque< T >::empty ( ) const

inline

◆ end() [1/2]

template<typename T >

iterator Container::PreallocatedDeque< T >::end ( )

inline

◆ end() [2/2]

template<typename T >

const_iterator Container::PreallocatedDeque< T >::end ( ) const

inline

◆ erase() [1/2]

template<typename T >

iterator Container::PreallocatedDeque< T >::erase	(	iterator	first,
		iterator	last
	)

inline

◆ erase() [2/2]

template<typename T >

iterator Container::PreallocatedDeque< T >::erase ( iterator pos )

inline

◆ front() [1/2]

template<typename T >

reference Container::PreallocatedDeque< T >::front ( )

inline

◆ front() [2/2]

template<typename T >

const_reference Container::PreallocatedDeque< T >::front ( ) const

inline

◆ full()

template<typename T >

bool Container::PreallocatedDeque< T >::full ( ) const

inline

◆ init()

template<typename T >

void Container::PreallocatedDeque< T >::init	(	void *	preallocated_buffer,
		size_type	buffer_size
	)

inline

Initialize.

Parameters

preallocated_buffer	Pre-allocated buffer by caller
buffer_size	Number of bytes of preallocated_buffer

Attention: preallocated_buffer must be aligned on the boundary of type T.; If you use default constructor, you need to call init() before other method call.

Note: Pre-allocated buffer can be set only one time.

◆ insert() [1/3]

template<typename T >

iterator Container::PreallocatedDeque< T >::insert	(	iterator	pos,
		const T &	data
	)

inline

◆ insert() [2/3]

template<typename T >

template<typename InputIterator >

void Container::PreallocatedDeque< T >::insert	(	iterator	pos,
		InputIterator	first,
		InputIterator	last
	)

inline

◆ insert() [3/3]

template<typename T >

void Container::PreallocatedDeque< T >::insert	(	iterator	pos,
		size_type	n,
		const T &	data
	)

inline

◆ max_size()

template<typename T >

size_type Container::PreallocatedDeque< T >::max_size ( ) const

inline

◆ operator=()

template<typename T >

PreallocatedDeque & Container::PreallocatedDeque< T >::operator= ( const PreallocatedDeque< T > & x )

inline

◆ operator[]() [1/2]

template<typename T >

reference Container::PreallocatedDeque< T >::operator[] ( size_type idx )

inline

◆ operator[]() [2/2]

template<typename T >

const_reference Container::PreallocatedDeque< T >::operator[] ( size_type idx ) const

inline

◆ pop_back()

template<typename T >

void Container::PreallocatedDeque< T >::pop_back ( )

inline

◆ pop_front()

template<typename T >

void Container::PreallocatedDeque< T >::pop_front ( )

inline

◆ push_back()

template<typename T >

void Container::PreallocatedDeque< T >::push_back ( const T & data )

inline

◆ push_front()

template<typename T >

void Container::PreallocatedDeque< T >::push_front ( const T & data )

inline

◆ rbegin() [1/2]

template<typename T >

reverse_iterator Container::PreallocatedDeque< T >::rbegin ( )

inline

◆ rbegin() [2/2]

template<typename T >

const_reverse_iterator Container::PreallocatedDeque< T >::rbegin ( ) const

inline

◆ rend() [1/2]

template<typename T >

reverse_iterator Container::PreallocatedDeque< T >::rend ( )

inline

◆ rend() [2/2]

template<typename T >

const_reverse_iterator Container::PreallocatedDeque< T >::rend ( ) const

inline

◆ resize()

template<typename T >

void Container::PreallocatedDeque< T >::resize	(	size_type	n,
		const T &	data = `T()`
	)

inline

◆ size()

template<typename T >

size_type Container::PreallocatedDeque< T >::size ( ) const

inline

The documentation for this class was generated from the following file:

mechanism/Container/PreallocatedDeque.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ PreallocatedDeque() [1/2]

◆ PreallocatedDeque() [2/2]

◆ ~PreallocatedDeque()

Member Function Documentation

◆ assign() [1/2]

◆ assign() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ available_size()

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ full()

◆ init()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ max_size()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ pop_front()

◆ push_back()

◆ push_front()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ resize()

◆ size()