Implements a drop-in replacement for std::vector<T> which stores up to N elements directly (without heap allocation). More...

#include <prevector.h>

Inheritance diagram for prevector< N, T, Size, Diff >:

[legend]

Collaboration diagram for prevector< N, T, Size, Diff >:

[legend]

Classes
class	const_iterator

union	direct_or_indirect

class	iterator

Public Types
typedef Size	size_type

typedef Diff	difference_type

typedef T	value_type

typedef value_type &	reference

typedef const value_type &	const_reference

typedef value_type *	pointer

typedef const value_type *	const_pointer

Public Member Functions
void	assign (size_type n, const T &val)

template<std::input_iterator InputIterator>
void	assign (InputIterator first, InputIterator last)

	prevector ()=default

	prevector (size_type n)

	prevector (size_type n, const T &val)

template<std::input_iterator InputIterator>
	prevector (InputIterator first, InputIterator last)

	prevector (const prevector< N, T, Size, Diff > &other)

	prevector (prevector< N, T, Size, Diff > &&other) noexcept

prevector &	operator= (const prevector< N, T, Size, Diff > &other)

prevector &	operator= (prevector< N, T, Size, Diff > &&other) noexcept

size_type	size () const

bool	empty () const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

size_t	capacity () const

T &	operator[] (size_type pos)

const T &	operator[] (size_type pos) const

void	resize (size_type new_size)

void	reserve (size_type new_capacity)

void	shrink_to_fit ()

void	clear ()

iterator	insert (iterator pos, const T &value)

void	insert (iterator pos, size_type count, const T &value)

template<std::input_iterator InputIterator>
void	insert (iterator pos, InputIterator first, InputIterator last)

void	resize_uninitialized (size_type new_size)

iterator	erase (iterator pos)

iterator	erase (iterator first, iterator last)

template<typename... Args>
void	emplace_back (Args &&... args)

void	push_back (const T &value)

void	pop_back ()

T &	front ()

const T &	front () const

T &	back ()

const T &	back () const

void	swap (prevector< N, T, Size, Diff > &other) noexcept

	~prevector ()

bool	operator== (const prevector< N, T, Size, Diff > &other) const

bool	operator< (const prevector< N, T, Size, Diff > &other) const

size_t	allocated_memory () const

value_type *	data ()

const value_type *	data () const

Static Public Attributes
static constexpr unsigned int	STATIC_SIZE {N}

Private Member Functions
T *	direct_ptr (difference_type pos)

const T *	direct_ptr (difference_type pos) const

T *	indirect_ptr (difference_type pos)

const T *	indirect_ptr (difference_type pos) const

bool	is_direct () const

void	change_capacity (size_type new_capacity)

T *	item_ptr (difference_type pos)

const T *	item_ptr (difference_type pos) const

void	fill (T *dst, ptrdiff_t count, const T &value=T{})

template<std::input_iterator InputIterator>
void	fill (T *dst, InputIterator first, InputIterator last)

Private Attributes
direct_or_indirect	_union = {}

size_type	_size = 0

Detailed Description

template<unsigned int N, typename T, typename Size = uint32_t, typename Diff = int32_t>
class prevector< N, T, Size, Diff >

Implements a drop-in replacement for std::vector<T> which stores up to N elements directly (without heap allocation).

The types Size and Diff are used to store element counts, and can be any unsigned + signed type.

Storage layout is either:

Direct allocation:
- Size _size: the number of used elements (between 0 and N)
- T direct[N]: an array of N elements of type T (only the first _size are initialized).
Indirect allocation:
- Size _size: the number of used elements plus N + 1
- Size capacity: the number of allocated elements
- T* indirect: a pointer to an array of capacity elements of type T (only the first _size are initialized).

The data type T must be movable by memmove/realloc(). Once we switch to C++, move constructors can be used instead.

Definition at line 37 of file prevector.h.

Member Typedef Documentation

◆ const_pointer

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef const value_type* prevector< N, T, Size, Diff >::const_pointer

Definition at line 49 of file prevector.h.

◆ const_reference

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef const value_type& prevector< N, T, Size, Diff >::const_reference

Definition at line 47 of file prevector.h.

◆ difference_type

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef Diff prevector< N, T, Size, Diff >::difference_type

Definition at line 44 of file prevector.h.

◆ pointer

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef value_type* prevector< N, T, Size, Diff >::pointer

Definition at line 48 of file prevector.h.

◆ reference

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef value_type& prevector< N, T, Size, Diff >::reference

Definition at line 46 of file prevector.h.

◆ size_type

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef Size prevector< N, T, Size, Diff >::size_type

Definition at line 43 of file prevector.h.

◆ value_type

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

typedef T prevector< N, T, Size, Diff >::value_type

Definition at line 45 of file prevector.h.

Constructor & Destructor Documentation

◆ prevector() [1/6]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector< N, T, Size, Diff >::prevector ( )

default

◆ prevector() [2/6]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector< N, T, Size, Diff >::prevector ( size_type n )

inlineexplicit

Definition at line 198 of file prevector.h.

Here is the call graph for this function:

◆ prevector() [3/6]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector< N, T, Size, Diff >::prevector	(	size_type	n,
		const T &	val )

inlineexplicit

Definition at line 202 of file prevector.h.

Here is the call graph for this function:

◆ prevector() [4/6]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

template<std::input_iterator InputIterator>

prevector< N, T, Size, Diff >::prevector	(	InputIterator	first,
		InputIterator	last )

inline

Definition at line 209 of file prevector.h.

Here is the call graph for this function:

◆ prevector() [5/6]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector< N, T, Size, Diff >::prevector ( const prevector< N, T, Size, Diff > & other )

inline

Definition at line 216 of file prevector.h.

Here is the call graph for this function:

◆ prevector() [6/6]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector< N, T, Size, Diff >::prevector ( prevector< N, T, Size, Diff > && other )

inlinenoexcept

Definition at line 223 of file prevector.h.

◆ ~prevector()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector< N, T, Size, Diff >::~prevector ( )

inline

Definition at line 422 of file prevector.h.

Here is the call graph for this function:

Member Function Documentation

◆ allocated_memory()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

size_t prevector< N, T, Size, Diff >::allocated_memory ( ) const

inline

Definition at line 469 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assign() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

template<std::input_iterator InputIterator>

void prevector< N, T, Size, Diff >::assign	(	InputIterator	first,
		InputIterator	last )

inline

Definition at line 186 of file prevector.h.

Here is the call graph for this function:

◆ assign() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::assign	(	size_type	n,
		const T &	val )

inline

Definition at line 176 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ back() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

T & prevector< N, T, Size, Diff >::back ( )

inline

Definition at line 408 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ back() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const T & prevector< N, T, Size, Diff >::back ( ) const

inline

Definition at line 412 of file prevector.h.

Here is the call graph for this function:

◆ begin() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

iterator prevector< N, T, Size, Diff >::begin ( )

inline

Definition at line 255 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ begin() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const_iterator prevector< N, T, Size, Diff >::begin ( ) const

inline

Definition at line 256 of file prevector.h.

Here is the call graph for this function:

◆ capacity()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

size_t prevector< N, T, Size, Diff >::capacity ( ) const

inline

Definition at line 260 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ change_capacity()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::change_capacity ( size_type new_capacity )

inlineprivate

Definition at line 128 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::clear ( )

inline

Definition at line 303 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

value_type * prevector< N, T, Size, Diff >::data ( )

inline

Definition at line 477 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const value_type * prevector< N, T, Size, Diff >::data ( ) const

inline

Definition at line 481 of file prevector.h.

Here is the call graph for this function:

◆ direct_ptr() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

T * prevector< N, T, Size, Diff >::direct_ptr ( difference_type pos )

inlineprivate

Definition at line 122 of file prevector.h.

Here is the caller graph for this function:

◆ direct_ptr() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const T * prevector< N, T, Size, Diff >::direct_ptr ( difference_type pos ) const

inlineprivate

Definition at line 123 of file prevector.h.

◆ emplace_back()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

template<typename... Args>

void prevector< N, T, Size, Diff >::emplace_back ( Args &&... args )

inline

Definition at line 383 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ empty()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

bool prevector< N, T, Size, Diff >::empty ( ) const

inline

Definition at line 251 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

iterator prevector< N, T, Size, Diff >::end ( )

inline

Definition at line 257 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const_iterator prevector< N, T, Size, Diff >::end ( ) const

inline

Definition at line 258 of file prevector.h.

Here is the call graph for this function:

◆ erase() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

iterator prevector< N, T, Size, Diff >::erase	(	iterator	first,
		iterator	last )

inline

Definition at line 368 of file prevector.h.

Here is the call graph for this function:

◆ erase() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

iterator prevector< N, T, Size, Diff >::erase ( iterator pos )

inline

Definition at line 364 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fill() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

template<std::input_iterator InputIterator>

void prevector< N, T, Size, Diff >::fill	(	T *	dst,
		InputIterator	first,
		InputIterator	last )

inlineprivate

Definition at line 167 of file prevector.h.

Here is the call graph for this function:

◆ fill() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::fill	(	T *	dst,
		ptrdiff_t	count,
		const T &	value = T{} )

inlineprivate

Definition at line 162 of file prevector.h.

Here is the caller graph for this function:

◆ front() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

T & prevector< N, T, Size, Diff >::front ( )

inline

Definition at line 400 of file prevector.h.

Here is the call graph for this function:

◆ front() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const T & prevector< N, T, Size, Diff >::front ( ) const

inline

Definition at line 404 of file prevector.h.

Here is the call graph for this function:

◆ indirect_ptr() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

T * prevector< N, T, Size, Diff >::indirect_ptr ( difference_type pos )

inlineprivate

Definition at line 124 of file prevector.h.

Here is the caller graph for this function:

◆ indirect_ptr() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const T * prevector< N, T, Size, Diff >::indirect_ptr ( difference_type pos ) const

inlineprivate

Definition at line 125 of file prevector.h.

◆ insert() [1/3]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

iterator prevector< N, T, Size, Diff >::insert	(	iterator	pos,
		const T &	value )

inline

Definition at line 307 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert() [2/3]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

template<std::input_iterator InputIterator>

void prevector< N, T, Size, Diff >::insert	(	iterator	pos,
		InputIterator	first,
		InputIterator	last )

inline

Definition at line 335 of file prevector.h.

Here is the call graph for this function:

◆ insert() [3/3]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::insert	(	iterator	pos,
		size_type	count,
		const T &	value )

inline

Definition at line 321 of file prevector.h.

Here is the call graph for this function:

◆ is_direct()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

bool prevector< N, T, Size, Diff >::is_direct ( ) const

inlineprivate

Definition at line 126 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ item_ptr() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

T * prevector< N, T, Size, Diff >::item_ptr ( difference_type pos )

inlineprivate

Definition at line 159 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ item_ptr() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const T * prevector< N, T, Size, Diff >::item_ptr ( difference_type pos ) const

inlineprivate

Definition at line 160 of file prevector.h.

Here is the call graph for this function:

◆ operator<()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

bool prevector< N, T, Size, Diff >::operator< ( const prevector< N, T, Size, Diff > & other ) const

inline

Definition at line 446 of file prevector.h.

Here is the call graph for this function:

◆ operator=() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector & prevector< N, T, Size, Diff >::operator= ( const prevector< N, T, Size, Diff > & other )

inline

Definition at line 229 of file prevector.h.

Here is the call graph for this function:

◆ operator=() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

prevector & prevector< N, T, Size, Diff >::operator= ( prevector< N, T, Size, Diff > && other )

inlinenoexcept

Definition at line 237 of file prevector.h.

Here is the call graph for this function:

◆ operator==()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

bool prevector< N, T, Size, Diff >::operator== ( const prevector< N, T, Size, Diff > & other ) const

inline

Definition at line 429 of file prevector.h.

Here is the call graph for this function:

◆ operator[]() [1/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

T & prevector< N, T, Size, Diff >::operator[] ( size_type pos )

inline

Definition at line 268 of file prevector.h.

Here is the call graph for this function:

◆ operator[]() [2/2]

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

const T & prevector< N, T, Size, Diff >::operator[] ( size_type pos ) const

inline

Definition at line 272 of file prevector.h.

Here is the call graph for this function:

◆ pop_back()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::pop_back ( )

inline

Definition at line 396 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ push_back()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::push_back ( const T & value )

inline

Definition at line 392 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reserve()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::reserve ( size_type new_capacity )

inline

Definition at line 293 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resize()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::resize ( size_type new_size )

inline

Definition at line 276 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resize_uninitialized()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::resize_uninitialized ( size_type new_size )

inline

Definition at line 349 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shrink_to_fit()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::shrink_to_fit ( )

inline

Definition at line 299 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

size_type prevector< N, T, Size, Diff >::size ( ) const

inline

Definition at line 247 of file prevector.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ swap()

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

void prevector< N, T, Size, Diff >::swap ( prevector< N, T, Size, Diff > & other )

inlinenoexcept

Definition at line 416 of file prevector.h.

Here is the caller graph for this function:

Member Data Documentation

◆ _size

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

size_type prevector< N, T, Size, Diff >::_size = 0

private

Definition at line 117 of file prevector.h.

◆ _union

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

direct_or_indirect prevector< N, T, Size, Diff >::_union = {}

private

Definition at line 116 of file prevector.h.

◆ STATIC_SIZE

template<unsigned int N, typename T , typename Size = uint32_t, typename Diff = int32_t>

constexpr unsigned int prevector< N, T, Size, Diff >::STATIC_SIZE {N}

staticconstexpr

Definition at line 41 of file prevector.h.

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

src/prevector.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_pointer

◆ const_reference

◆ difference_type

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ prevector() [1/6]

◆ prevector() [2/6]

◆ prevector() [3/6]

◆ prevector() [4/6]

◆ prevector() [5/6]

◆ prevector() [6/6]

◆ ~prevector()

Member Function Documentation

◆ allocated_memory()

◆ assign() [1/2]

◆ assign() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ change_capacity()

◆ clear()

◆ data() [1/2]

◆ data() [2/2]

◆ direct_ptr() [1/2]

◆ direct_ptr() [2/2]

◆ emplace_back()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ fill() [1/2]

◆ fill() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ indirect_ptr() [1/2]

◆ indirect_ptr() [2/2]

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ is_direct()

◆ item_ptr() [1/2]

◆ item_ptr() [2/2]

◆ operator<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ push_back()

◆ reserve()

◆ resize()

◆ resize_uninitialized()

◆ shrink_to_fit()

◆ size()

◆ swap()

Member Data Documentation

◆ _size

◆ _union

◆ STATIC_SIZE