Ogre::SmallVector< T, 0 > Class Template Reference

Specialize SmallVector at N=0. More...

#include <OgreSmallVector.h>

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

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())
void	append (in_iter in_start, in_iter in_end)
	append - Add the specified range to the end of the SmallVector.
void	append (size_type NumInputs, const T &Elt)
	append - Add the specified range to the end of the SmallVector.
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.
void	clear ()
pointer	data ()
	data - Return a pointer to the vector's buffer, even if empty().
const_pointer	data () const
	data - Return a pointer to the vector's buffer, even if empty().
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.
iterator	insert (iterator I, const T &Elt)
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
SmallVector &	operator= (const SmallVectorImpl< T > &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
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.

Protected Member Functions
size_t	capacity_in_bytes () const
	capacity_in_bytes - This returns capacity()*sizeof(T).
iterator	capacity_ptr ()
const_iterator	capacity_ptr () const
void	grow_pod (size_t MinSizeInBytes, size_t TSize)
	grow_pod - This is an implementation of the grow() method which only works
bool	isSmall () const
	isSmall - Return true if this is a smallvector which has not had dynamic memory allocated for it.
void	setEnd (T *P)
size_t	size_in_bytes () const
	size_in_bytes - This returns size()*sizeof(T).

Protected Attributes
void *	BeginX
void *	CapacityX
void *	EndX
union Ogre::SmallVectorBase::U	FirstEl

Private Types
enum
typedef SmallVectorTemplateBase< T, isPodLike< T >::value >	SuperClass
typedef SmallVectorImpl< T >::U	U
	InlineElts - These are 'N-1' elements that are stored inline in the body of the vector.

Static Private Member Functions
static void	construct_range (T *S, T *E, const T &Elt)

Private Attributes
U	InlineElts [NumInlineEltsElts]

Detailed Description

template<typename T>
class Ogre::SmallVector< T, 0 >

Specialize SmallVector at N=0.

This specialization guarantees that it can be instantiated at an incomplete T if none of its members are required.

Definition at line 770 of file OgreSmallVector.h.

Member Typedef Documentation

const_iterator

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

Definition at line 173 of file OgreSmallVector.h.

const_pointer

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

Definition at line 181 of file OgreSmallVector.h.

const_reference

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

Definition at line 179 of file OgreSmallVector.h.

const_reverse_iterator

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

Definition at line 175 of file OgreSmallVector.h.

difference_type

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

Definition at line 170 of file OgreSmallVector.h.

iterator

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

Definition at line 332 of file OgreSmallVector.h.

pointer

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

Definition at line 180 of file OgreSmallVector.h.

reference

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

Definition at line 178 of file OgreSmallVector.h.

reverse_iterator

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

Definition at line 176 of file OgreSmallVector.h.

size_type

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

Definition at line 333 of file OgreSmallVector.h.

SuperClass

typedef SmallVectorTemplateBase<T, isPodLike<T>::value > Ogre::SmallVectorImpl< T >::SuperClass

private

Definition at line 328 of file OgreSmallVector.h.

U

typedef SmallVectorImpl<T>::U Ogre::SmallVector< T, N >::U

private

InlineElts - These are 'N-1' elements that are stored inline in the body of the vector.

The extra '1' element is stored in SmallVectorImpl.

Definition at line 720 of file OgreSmallVector.h.

value_type

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

Definition at line 171 of file OgreSmallVector.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Definition at line 721 of file OgreSmallVector.h.

Constructor & Destructor Documentation

SmallVector() [1/4]

template<typename T>

Ogre::SmallVector< T, 0 >::SmallVector

(

)

Definition at line 772 of file OgreSmallVector.h.

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

Referenced by SmallVector(), and operator=().

SmallVector() [2/4]

template<typename T>

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

explicit

Definition at line 774 of file OgreSmallVector.h.

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

SmallVector() [3/4]

template<typename T>

template<typename ItTy>

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

Definition at line 782 of file OgreSmallVector.h.

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

SmallVector() [4/4]

template<typename T>

Ogre::SmallVector< T, 0 >::SmallVector

(

const SmallVector< T, 0 > &

RHS

)

Definition at line 786 of file OgreSmallVector.h.

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

Member Function Documentation

append() [1/2]

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

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

Definition at line 411 of file OgreSmallVector.h.

append() [2/2]

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

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

Definition at line 426 of file OgreSmallVector.h.

assign()

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

Definition at line 436 of file OgreSmallVector.h.

back() [1/2]

reference Ogre::SmallVectorTemplateCommon< T >::back

(

)

Definition at line 227 of file OgreSmallVector.h.

back() [2/2]

const_reference Ogre::SmallVectorTemplateCommon< T >::back

(

)

const

Definition at line 230 of file OgreSmallVector.h.

begin() [1/2]

iterator Ogre::SmallVectorTemplateCommon< T >::begin

(

)

Definition at line 184 of file OgreSmallVector.h.

begin() [2/2]

const_iterator Ogre::SmallVectorTemplateCommon< T >::begin

(

)

const

Definition at line 185 of file OgreSmallVector.h.

capacity()

size_t Ogre::SmallVectorTemplateCommon< T >::capacity

(

)

const

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

Definition at line 204 of file OgreSmallVector.h.

capacity_in_bytes()

size_t Ogre::SmallVectorBase::capacity_in_bytes ( ) const

protected

capacity_in_bytes - This returns capacity()*sizeof(T).

Definition at line 149 of file OgreSmallVector.h.

capacity_ptr() [1/2]

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

protected

Definition at line 189 of file OgreSmallVector.h.

capacity_ptr() [2/2]

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

protected

Definition at line 190 of file OgreSmallVector.h.

clear()

void Ogre::SmallVectorImpl< T >::clear

(

)

Definition at line 350 of file OgreSmallVector.h.

construct_range()

void Ogre::SmallVectorImpl< T >::construct_range ( T * S, T * E, const T & Elt )

staticprivate

Definition at line 614 of file OgreSmallVector.h.

data() [1/2]

pointer Ogre::SmallVectorTemplateCommon< T >::data

(

)

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

Definition at line 207 of file OgreSmallVector.h.

data() [2/2]

const_pointer Ogre::SmallVectorTemplateCommon< T >::data

(

)

const

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

Definition at line 209 of file OgreSmallVector.h.

destroy_range()

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

static

Definition at line 242 of file OgreSmallVector.h.

empty()

bool Ogre::SmallVectorBase::empty

(

)

const

Definition at line 158 of file OgreSmallVector.h.

end() [1/2]

iterator Ogre::SmallVectorTemplateCommon< T >::end

(

)

Definition at line 186 of file OgreSmallVector.h.

end() [2/2]

const_iterator Ogre::SmallVectorTemplateCommon< T >::end

(

)

const

Definition at line 187 of file OgreSmallVector.h.

erase() [1/2]

iterator Ogre::SmallVectorImpl< T >::erase

(

iterator

I

)

Definition at line 444 of file OgreSmallVector.h.

erase() [2/2]

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

Definition at line 453 of file OgreSmallVector.h.

front() [1/2]

reference Ogre::SmallVectorTemplateCommon< T >::front

(

)

Definition at line 220 of file OgreSmallVector.h.

front() [2/2]

const_reference Ogre::SmallVectorTemplateCommon< T >::front

(

)

const

Definition at line 223 of file OgreSmallVector.h.

grow()

void Ogre::SmallVectorTemplateBase< T, isPodLike >::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.

grow_pod()

void Ogre::SmallVectorBase::grow_pod ( size_t MinSizeInBytes, size_t TSize )

protected

grow_pod - This is an implementation of the grow() method which only works

on POD-like data types and is out of line to reduce code duplication.

insert() [1/3]

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

Definition at line 463 of file OgreSmallVector.h.

insert() [2/3]

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

Definition at line 532 of file OgreSmallVector.h.

insert() [3/3]

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

Definition at line 484 of file OgreSmallVector.h.

isSmall()

bool Ogre::SmallVectorBase::isSmall ( ) const

protected

isSmall - Return true if this is a smallvector which has not had dynamic memory allocated for it.

Definition at line 139 of file OgreSmallVector.h.

max_size()

size_type Ogre::SmallVectorTemplateCommon< T >::max_size

(

)

const

Definition at line 200 of file OgreSmallVector.h.

operator!=()

bool Ogre::SmallVectorImpl< T >::operator!=

(

const SmallVectorImpl &

RHS

)

const

Definition at line 590 of file OgreSmallVector.h.

operator<()

bool Ogre::SmallVectorImpl< T >::operator<

(

const SmallVectorImpl &

RHS

)

const

Definition at line 594 of file OgreSmallVector.h.

operator=()

template<typename T>

SmallVector & Ogre::SmallVector< T, 0 >::operator=

(

const SmallVectorImpl< T > &

RHS

)

Definition at line 790 of file OgreSmallVector.h.

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

operator==()

bool Ogre::SmallVectorImpl< T >::operator==

(

const SmallVectorImpl &

RHS

)

const

Definition at line 586 of file OgreSmallVector.h.

operator[]() [1/2]

reference Ogre::SmallVectorTemplateCommon< T >::operator[]

(

unsigned

idx

)

Definition at line 211 of file OgreSmallVector.h.

operator[]() [2/2]

const_reference Ogre::SmallVectorTemplateCommon< T >::operator[]

(

unsigned

idx

)

const

Definition at line 215 of file OgreSmallVector.h.

pop_back()

void Ogre::SmallVectorImpl< T >::pop_back

(

)

Definition at line 395 of file OgreSmallVector.h.

pop_back_val()

T Ogre::SmallVectorImpl< T >::pop_back_val

(

)

Definition at line 400 of file OgreSmallVector.h.

push_back()

void Ogre::SmallVectorImpl< T >::push_back

(

const T &

Elt

)

Definition at line 384 of file OgreSmallVector.h.

rbegin() [1/2]

reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rbegin

(

)

Definition at line 194 of file OgreSmallVector.h.

rbegin() [2/2]

const_reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rbegin

(

)

const

Definition at line 195 of file OgreSmallVector.h.

rend() [1/2]

reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rend

(

)

Definition at line 196 of file OgreSmallVector.h.

rend() [2/2]

const_reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rend

(

)

const

Definition at line 197 of file OgreSmallVector.h.

reserve()

void Ogre::SmallVectorImpl< T >::reserve

(

unsigned

N

)

Definition at line 379 of file OgreSmallVector.h.

resize() [1/2]

void Ogre::SmallVectorImpl< T >::resize

(

unsigned

N

)

Definition at line 355 of file OgreSmallVector.h.

resize() [2/2]

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

Definition at line 367 of file OgreSmallVector.h.

set_size()

void Ogre::SmallVectorImpl< T >::set_size

(

unsigned

N

)

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.

Definition at line 608 of file OgreSmallVector.h.

setEnd()

void Ogre::SmallVectorTemplateCommon< T >::setEnd ( T * P )

protected

Definition at line 165 of file OgreSmallVector.h.

size()

size_type Ogre::SmallVectorTemplateCommon< T >::size

(

)

const

Definition at line 199 of file OgreSmallVector.h.

size_in_bytes()

size_t Ogre::SmallVectorBase::size_in_bytes ( ) const

protected

size_in_bytes - This returns size()*sizeof(T).

Definition at line 144 of file OgreSmallVector.h.

swap()

void Ogre::SmallVectorImpl< T >::swap

(

SmallVectorImpl &

RHS

)

Definition at line 406 of file OgreSmallVector.h.

uninitialized_copy()

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

static

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

Definition at line 252 of file OgreSmallVector.h.

Member Data Documentation

BeginX

void* Ogre::SmallVectorBase::BeginX

protected

Definition at line 118 of file OgreSmallVector.h.

CapacityX

void * Ogre::SmallVectorBase::CapacityX

protected

Definition at line 118 of file OgreSmallVector.h.

EndX

void * Ogre::SmallVectorBase::EndX

protected

Definition at line 118 of file OgreSmallVector.h.

FirstEl

union Ogre::SmallVectorBase::U Ogre::SmallVectorBase::FirstEl

protected

InlineElts

U Ogre::SmallVector< T, N >::InlineElts[NumInlineEltsElts]

private

Definition at line 737 of file OgreSmallVector.h.

---

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

• OgreSmallVector.h