#include <smallVector.h>

Inheritance diagram for TfSmallVector< T, N >:

Public Types
Relevant Typedefs.
XXX: Functionality currently missing, and which we would like to add as needed: emplace shrink_to_fit shrink_to_local / shrink_to_internal (or similar, free standing function)
typedef T	value_type

typedef T &	reference

typedef const T &	const_reference

Public Types inherited from TfSmallVectorBase
using	size_type = std::uint32_t

using	difference_type = std::int32_t

Public Member Functions
reference	front ()

const_reference	front () const

reference	back ()

const_reference	back () const

reference	operator[] (size_type i)

const_reference	operator[] (size_type i) const

value_type *	data ()

const value_type *	data () const

bool	operator== (const TfSmallVector &rhs) const

bool	operator!= (const TfSmallVector &rhs) const

Returns an iterator to the beginning of the vector.
iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

Returns an iterator to the end of the vector.
iterator	end ()

const_iterator	end () const

const_iterator	cend () const

Returns a reverse iterator to the beginning of the vector.
reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

const_reverse_iterator	crbegin () const

Returns a reverse iterator to the end of the vector.
reverse_iterator	rend ()

const_reverse_iterator	rend () const

const_reverse_iterator	crend () const

Iterator Support.
}@
enum	DefaultInitTag { DefaultInit }

using	iterator = T *

using	const_iterator = const T *

typedef std::reverse_iterator < iterator >	reverse_iterator

typedef std::reverse_iterator < const_iterator >	const_reverse_iterator

template<typename _ForwardIterator >
using	_EnableIfForwardIterator = typename std::enable_if< std::is_convertible< typename std::iterator_traits< _ForwardIterator >::iterator_category, std::forward_iterator_tag >::value >::type

	TfSmallVector ()
	}@ More...

	TfSmallVector (size_type n)

	TfSmallVector (size_type n, const value_type &v)

	TfSmallVector (size_type n, DefaultInitTag)

	TfSmallVector (const TfSmallVector &rhs)

	TfSmallVector (TfSmallVector &&rhs)

	TfSmallVector (std::initializer_list< T > values)
	Construct a new vector from initializer list. More...

template<typename ForwardIterator , typename = _EnableIfForwardIterator<ForwardIterator>>
	TfSmallVector (ForwardIterator first, ForwardIterator last)

	~TfSmallVector ()

TfSmallVector &	operator= (const TfSmallVector &rhs)

TfSmallVector &	operator= (TfSmallVector &&rhs)

TfSmallVector &	operator= (std::initializer_list< T > ilist)

void	swap (TfSmallVector &rhs)

iterator	insert (const_iterator it, value_type &&v)

iterator	insert (const_iterator it, const value_type &v)

iterator	erase (const_iterator it)

iterator	erase (const_iterator it, const_iterator last)

void	reserve (size_type newCapacity)

void	resize (size_type newSize, const value_type &v=value_type())

void	clear ()

template<typename ForwardIterator , typename = _EnableIfForwardIterator<ForwardIterator>>
void	assign (ForwardIterator first, ForwardIterator last)

void	assign (std::initializer_list< T > ilist)

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

void	push_back (const value_type &v)

void	push_back (value_type &&v)

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

void	insert (iterator pos, std::initializer_list< T > ilist)

void	pop_back ()

size_type	size () const

bool	empty () const

size_type	capacity () const

static constexpr size_type	max_size ()

static constexpr size_type	internal_capacity ()

Additional Inherited Members
Static Public Member Functions inherited from TfSmallVectorBase
template<typename U >
static constexpr size_type	ComputeSerendipitousLocalCapacity ()

Static Protected Member Functions inherited from TfSmallVectorBase
template<typename Iterator >
static Iterator	_UninitializedMove (Iterator first, Iterator last, Iterator dest)

template<typename U >
static void	_MoveConstruct (U p, U src)

Detailed Description

template<typename T, uint32_t N>
class TfSmallVector< T, N >

This is a small-vector class with local storage optimization, the local storage can be specified via a template parameter, and expresses the number of entries the container can store locally.

In addition to the local storage optimization, this vector is also optimized for storing a smaller number of entries on the heap: It features a reduced memory footprint (minimum 16 bytes) by limiting max_size() to 2^32, which should still be more than enough for most use cases where a small-vector is advantageous.

TfSmallVector mimics the std::vector API, and can thus be easily used as a drop-in replacement where appropriate. Note, however, that not all the methods on std::vector are implemented here, and that TfSmallVector may have methods in addition to those that you would find on std::vector.

Note that a TfSmallVector that has grown beyond its local storage, will NOT move its entries back into the local storage once it shrinks back to N.

Definition at line 177 of file smallVector.h.