SmallVector - This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small. More...

#include <OgreSmallVector.h>

Inheritance diagram for Ogre::SmallVector< T, N >:

Public Types
typedef const T *	const_iterator

typedef const T *	const_pointer

typedef const T &	const_reference

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

typedef ptrdiff_t	difference_type

typedef SuperClass::iterator	iterator

typedef T *	pointer

typedef T &	reference

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef SuperClass::size_type	size_type

typedef T	value_type

Public Member Functions
	SmallVector ()

	SmallVector (const SmallVector &RHS)

template<typename ItTy >
	SmallVector (ItTy S, ItTy E)

	SmallVector (unsigned Size, const T &Value=T())

template<typename in_iter >
void	append (in_iter in_start, in_iter in_end)
	append - Add the specified range to the end of the SmallVector. More...

void	append (size_type NumInputs, const T &Elt)
	append - Add the specified range to the end of the SmallVector. More...

void	assign (unsigned NumElts, const T &Elt)

reference	back ()

const_reference	back () const

iterator	begin ()

const_iterator	begin () const

size_t	capacity () const
	capacity - Return the total number of elements in the currently allocated buffer. More...

void	clear ()

pointer	data ()
	data - Return a pointer to the vector's buffer, even if empty(). More...

const_pointer	data () const
	data - Return a pointer to the vector's buffer, even if empty(). More...

bool	empty () const

iterator	end ()

const_iterator	end () const

iterator	erase (iterator I)

iterator	erase (iterator S, iterator E)

reference	front ()

const_reference	front () const

void	grow (size_t MinSize=0)
	grow - double the size of the allocated memory, guaranteeing space for at least one more element or MinSize if specified. More...

iterator	insert (iterator I, const T &Elt)

template<typename ItTy >
iterator	insert (iterator I, ItTy From, ItTy To)

iterator	insert (iterator I, size_type NumToInsert, const T &Elt)

size_type	max_size () const

bool	operator!= (const SmallVectorImpl &RHS) const

bool	operator< (const SmallVectorImpl &RHS) const

const SmallVector &	operator= (const SmallVector &RHS)

bool	operator== (const SmallVectorImpl &RHS) const

reference	operator[] (unsigned idx)

const_reference	operator[] (unsigned idx) const

void	pop_back ()

T	pop_back_val ()

void	push_back (const T &Elt)

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

void	reserve (unsigned N)

void	resize (unsigned N)

void	resize (unsigned N, const T &NV)

void	set_size (unsigned N)
	set_size - Set the array size to More...

size_type	size () const

void	swap (SmallVectorImpl &RHS)

Static Public Member Functions
static void	destroy_range (T S, T E)

static void	uninitialized_copy (It1 I, It1 E, It2 Dest)
	uninitialized_copy - Copy the range [I, E) onto the uninitialized memory starting with "Dest", constructing elements into it as needed. More...

Detailed Description

template<typename T, unsigned N>
class Ogre::SmallVector< T, N >

SmallVector - This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.

It contains some number of elements in-place, which allows it to avoid heap allocation when the actual number of elements is below that threshold. This allows normal "small" cases to be fast without losing generality for large inputs.

Note that this does not attempt to be exception safe.

Member Typedef Documentation

◆ const_iterator

template<typename T >

typedef const T* Ogre::SmallVectorTemplateCommon< T >::const_iterator

inherited

◆ const_pointer

template<typename T >

typedef const T* Ogre::SmallVectorTemplateCommon< T >::const_pointer

inherited

◆ const_reference

template<typename T >

typedef const T& Ogre::SmallVectorTemplateCommon< T >::const_reference

inherited

◆ const_reverse_iterator

template<typename T >

typedef std::reverse_iterator<const_iterator> Ogre::SmallVectorTemplateCommon< T >::const_reverse_iterator

inherited

◆ difference_type

template<typename T >

typedef ptrdiff_t Ogre::SmallVectorTemplateCommon< T >::difference_type

inherited

◆ iterator

template<typename T >

typedef SuperClass::iterator Ogre::SmallVectorImpl< T >::iterator

inherited

◆ pointer

template<typename T >

typedef T* Ogre::SmallVectorTemplateCommon< T >::pointer

inherited

◆ reference

template<typename T >

typedef T& Ogre::SmallVectorTemplateCommon< T >::reference

inherited

◆ reverse_iterator

template<typename T >

typedef std::reverse_iterator<iterator> Ogre::SmallVectorTemplateCommon< T >::reverse_iterator

inherited

◆ size_type

template<typename T >

typedef SuperClass::size_type Ogre::SmallVectorImpl< T >::size_type

inherited

◆ value_type

template<typename T >

typedef T Ogre::SmallVectorTemplateCommon< T >::value_type

inherited

Constructor & Destructor Documentation

◆ SmallVector() [1/4]

template<typename T , unsigned N>

Ogre::SmallVector< T, N >::SmallVector ( )

inline

◆ SmallVector() [2/4]

template<typename T , unsigned N>

Ogre::SmallVector< T, N >::SmallVector	(	unsigned	Size,
		const T &	Value = `T()`
	)

inlineexplicit

References Ogre::SmallVectorImpl< T >::push_back(), and Ogre::SmallVectorImpl< T >::reserve().

◆ SmallVector() [3/4]

template<typename T , unsigned N>

template<typename ItTy >

Ogre::SmallVector< T, N >::SmallVector	(	ItTy	S,
		ItTy	E
	)

inline

References Ogre::SmallVectorImpl< T >::append().

◆ SmallVector() [4/4]

template<typename T , unsigned N>

Ogre::SmallVector< T, N >::SmallVector ( const SmallVector< T, N > & RHS )

inline

References Ogre::SmallVectorBase::empty(), and Ogre::SmallVectorImpl< T >::operator=().

Member Function Documentation

◆ append() [1/2]

template<typename T >

template<typename in_iter >

void Ogre::SmallVectorImpl< T >::append	(	in_iter	in_start,
		in_iter	in_end
	)

inlineinherited

append - Add the specified range to the end of the SmallVector.

References Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow(), and Ogre::SmallVectorTemplateCommon< T >::size().

Referenced by Ogre::SmallVector< T, N >::SmallVector(), Ogre::SmallVector< T, 0 >::SmallVector(), and Ogre::SmallVectorImpl< T >::insert().

◆ append() [2/2]

template<typename T >

void Ogre::SmallVectorImpl< T >::append	(	size_type	NumInputs,
		const T &	Elt
	)

inlineinherited

append - Add the specified range to the end of the SmallVector.

References Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow(), and Ogre::SmallVectorTemplateCommon< T >::size().

◆ assign()

template<typename T >

void Ogre::SmallVectorImpl< T >::assign	(	unsigned	NumElts,
		const T &	Elt
	)

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::capacity(), Ogre::SmallVectorImpl< T >::clear(), Ogre::SmallVectorTemplateCommon< T >::end(), and Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow().

◆ back() [1/2]

template<typename T >

reference Ogre::SmallVectorTemplateCommon< T >::back ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end().

Referenced by Ogre::SmallVectorImpl< T >::insert(), and Ogre::SmallVectorImpl< T >::pop_back_val().

◆ back() [2/2]

template<typename T >

const_reference Ogre::SmallVectorTemplateCommon< T >::back ( ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end().

◆ begin() [1/2]

template<typename T >

iterator Ogre::SmallVectorTemplateCommon< T >::begin ( )

inlineinherited

◆ begin() [2/2]

template<typename T >

const_iterator Ogre::SmallVectorTemplateCommon< T >::begin ( ) const

inlineinherited

◆ capacity()

template<typename T >

size_t Ogre::SmallVectorTemplateCommon< T >::capacity ( ) const

inlineinherited

capacity - Return the total number of elements in the currently allocated buffer.

References Ogre::SmallVectorTemplateCommon< T >::begin().

Referenced by Ogre::SmallVectorImpl< T >::assign(), Ogre::SmallVectorImpl< T >::reserve(), Ogre::SmallVectorImpl< T >::resize(), Ogre::SmallVectorImpl< T >::set_size(), and Ogre::SmallVectorImpl< T >::swap().

◆ clear()

template<typename T >

void Ogre::SmallVectorImpl< T >::clear ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::destroy_range(), and Ogre::SmallVectorTemplateCommon< T >::end().

Referenced by Ogre::SmallVectorImpl< T >::assign().

◆ data() [1/2]

template<typename T >

pointer Ogre::SmallVectorTemplateCommon< T >::data ( )

inlineinherited

data - Return a pointer to the vector's buffer, even if empty().

References Ogre::SmallVectorTemplateCommon< T >::begin().

◆ data() [2/2]

template<typename T >

const_pointer Ogre::SmallVectorTemplateCommon< T >::data ( ) const

inlineinherited

data - Return a pointer to the vector's buffer, even if empty().

References Ogre::SmallVectorTemplateCommon< T >::begin().

◆ destroy_range()

static void Ogre::SmallVectorTemplateBase< T, isPodLike >::destroy_range	(	T *	S,
		T *	E
	)

inlinestaticinherited

◆ empty()

bool Ogre::SmallVectorBase::empty ( ) const

inlineinherited

Referenced by Ogre::SmallVector< T, N >::SmallVector().

◆ end() [1/2]

template<typename T >

iterator Ogre::SmallVectorTemplateCommon< T >::end ( )

inlineinherited

◆ end() [2/2]

template<typename T >

const_iterator Ogre::SmallVectorTemplateCommon< T >::end ( ) const

inlineinherited

◆ erase() [1/2]

template<typename T >

iterator Ogre::SmallVectorImpl< T >::erase ( iterator I )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end(), and Ogre::SmallVectorImpl< T >::pop_back().

◆ erase() [2/2]

template<typename T >

iterator Ogre::SmallVectorImpl< T >::erase	(	iterator	S,
		iterator	E
	)

inlineinherited

References Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::destroy_range(), and Ogre::SmallVectorTemplateCommon< T >::end().

◆ front() [1/2]

template<typename T >

reference Ogre::SmallVectorTemplateCommon< T >::front ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin().

◆ front() [2/2]

template<typename T >

const_reference Ogre::SmallVectorTemplateCommon< T >::front ( ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin().

◆ grow()

void Ogre::SmallVectorTemplateBase< T, isPodLike >::grow ( size_t MinSize = 0 )

inherited

grow - double the size of the allocated memory, guaranteeing space for at least one more element or MinSize if specified.

◆ insert() [1/3]

template<typename T >

iterator Ogre::SmallVectorImpl< T >::insert	(	iterator	I,
		const T &	Elt
	)

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::back(), Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow(), and Ogre::SmallVectorImpl< T >::push_back().

◆ insert() [2/3]

template<typename T >

template<typename ItTy >

iterator Ogre::SmallVectorImpl< T >::insert	(	iterator	I,
		ItTy	From,
		ItTy	To
	)

inlineinherited

References Ogre::SmallVectorImpl< T >::append(), Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorImpl< T >::reserve(), Ogre::SmallVectorTemplateCommon< T >::size(), and Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::uninitialized_copy().

◆ insert() [3/3]

template<typename T >

iterator Ogre::SmallVectorImpl< T >::insert	(	iterator	I,
		size_type	NumToInsert,
		const T &	Elt
	)

inlineinherited

References Ogre::SmallVectorImpl< T >::append(), Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorImpl< T >::reserve(), Ogre::SmallVectorTemplateCommon< T >::size(), and Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::uninitialized_copy().

◆ max_size()

template<typename T >

size_type Ogre::SmallVectorTemplateCommon< T >::max_size ( ) const

inlineinherited

◆ operator!=()

template<typename T >

bool Ogre::SmallVectorImpl< T >::operator!= ( const SmallVectorImpl< T > & RHS ) const

inlineinherited

◆ operator<()

template<typename T >

bool Ogre::SmallVectorImpl< T >::operator< ( const SmallVectorImpl< T > & RHS ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), and Ogre::SmallVectorTemplateCommon< T >::end().

◆ operator=()

template<typename T , unsigned N>

const SmallVector& Ogre::SmallVector< T, N >::operator= ( const SmallVector< T, N > & RHS )

inline

References Ogre::SmallVectorImpl< T >::operator=().

◆ operator==()

template<typename T >

bool Ogre::SmallVectorImpl< T >::operator== ( const SmallVectorImpl< T > & RHS ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::end(), and Ogre::SmallVectorTemplateCommon< T >::size().

◆ operator[]() [1/2]

template<typename T >

reference Ogre::SmallVectorTemplateCommon< T >::operator[] ( unsigned idx )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), and Ogre::SmallVectorTemplateCommon< T >::end().

◆ operator[]() [2/2]

template<typename T >

const_reference Ogre::SmallVectorTemplateCommon< T >::operator[] ( unsigned idx ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), and Ogre::SmallVectorTemplateCommon< T >::end().

◆ pop_back()

template<typename T >

void Ogre::SmallVectorImpl< T >::pop_back ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end().

Referenced by Ogre::SmallVectorImpl< T >::erase(), and Ogre::SmallVectorImpl< T >::pop_back_val().

◆ pop_back_val()

template<typename T >

T Ogre::SmallVectorImpl< T >::pop_back_val ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::back(), and Ogre::SmallVectorImpl< T >::pop_back().

◆ push_back()

template<typename T >

void Ogre::SmallVectorImpl< T >::push_back ( const T & Elt )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end(), and Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow().

Referenced by Ogre::SmallVector< T, N >::SmallVector(), Ogre::SmallVector< T, 0 >::SmallVector(), and Ogre::SmallVectorImpl< T >::insert().

◆ rbegin() [1/2]

template<typename T >

reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rbegin ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end().

◆ rbegin() [2/2]

template<typename T >

const_reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rbegin ( ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::end().

◆ rend() [1/2]

template<typename T >

reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rend ( )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin().

◆ rend() [2/2]

template<typename T >

const_reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rend ( ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin().

◆ reserve()

template<typename T >

void Ogre::SmallVectorImpl< T >::reserve ( unsigned N )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::capacity(), and Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow().

Referenced by Ogre::SmallVector< T, N >::SmallVector(), Ogre::SmallVector< T, 0 >::SmallVector(), and Ogre::SmallVectorImpl< T >::insert().

◆ resize() [1/2]

template<typename T >

void Ogre::SmallVectorImpl< T >::resize ( unsigned N )

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::capacity(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::destroy_range(), Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow(), and Ogre::SmallVectorTemplateCommon< T >::size().

◆ resize() [2/2]

template<typename T >

void Ogre::SmallVectorImpl< T >::resize	(	unsigned	N,
		const T &	NV
	)

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::capacity(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::destroy_range(), Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorTemplateBase< T, isPodLike< T >::value >::grow(), and Ogre::SmallVectorTemplateCommon< T >::size().

◆ set_size()

template<typename T >

void Ogre::SmallVectorImpl< T >::set_size ( unsigned N )

inlineinherited

set_size - Set the array size to

N, which the current array must have enough capacity for.

This does not construct or destroy any elements in the vector.

Clients can use this in conjunction with capacity() to write past the end of the buffer when they know that more elements are available, and only update the size later. This avoids the cost of value initializing elements which will only be overwritten.

References Ogre::SmallVectorTemplateCommon< T >::begin(), and Ogre::SmallVectorTemplateCommon< T >::capacity().

◆ size()

template<typename T >

size_type Ogre::SmallVectorTemplateCommon< T >::size ( ) const

inlineinherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), and Ogre::SmallVectorTemplateCommon< T >::end().

Referenced by Ogre::SmallVectorImpl< T >::append(), Ogre::SmallVectorImpl< T >::insert(), Ogre::SmallVectorImpl< T >::operator=(), Ogre::SmallVectorImpl< T >::operator==(), Ogre::SmallVectorImpl< T >::resize(), and Ogre::SmallVectorImpl< T >::swap().

◆ swap()

template<typename T >

void Ogre::SmallVectorImpl< T >::swap ( SmallVectorImpl< T > & RHS )

inherited

References Ogre::SmallVectorTemplateCommon< T >::begin(), Ogre::SmallVectorTemplateCommon< T >::capacity(), Ogre::SmallVectorTemplateCommon< T >::end(), Ogre::SmallVectorTemplateBase< T, isPodLike >::grow(), Ogre::SmallVectorTemplateCommon< T >::size(), and std::swap().

Referenced by std::swap().

◆ uninitialized_copy()

static void Ogre::SmallVectorTemplateBase< T, isPodLike >::uninitialized_copy	(	It1	I,
		It1	E,
		It2	Dest
	)

inlinestaticinherited

uninitialized_copy - Copy the range [I, E) onto the uninitialized memory starting with "Dest", constructing elements into it as needed.

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

OgreSmallVector.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

template<typename T, unsigned N> class Ogre::SmallVector< T, N >

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

◆ SmallVector() [1/4]

◆ SmallVector() [2/4]

◆ SmallVector() [3/4]

◆ SmallVector() [4/4]

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ assign()

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ clear()

◆ data() [1/2]

◆ data() [2/2]

◆ destroy_range()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ grow()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ max_size()

◆ operator!=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ pop_back_val()

◆ push_back()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ reserve()

◆ resize() [1/2]

◆ resize() [2/2]

◆ set_size()

◆ size()

◆ swap()

◆ uninitialized_copy()

template<typename T, unsigned N>
class Ogre::SmallVector< T, N >