OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Ogre::SmallVector< T, N > Class Template Reference

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 (unsigned Size, const T &Value=T())
 
template<typename ItTy >
 SmallVector (ItTy S, ItTy E)
 
 SmallVector (const SmallVector &RHS)
 
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)
 
iterator insert (iterator I, size_type NumToInsert, const T &Elt)
 
template<typename ItTy >
iterator insert (iterator I, ItTy From, ItTy To)
 
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

◆ iterator

template<typename T>
typedef SuperClass::iterator Ogre::SmallVectorImpl< T >::iterator
inherited

◆ size_type

template<typename T>
typedef SuperClass::size_type Ogre::SmallVectorImpl< T >::size_type
inherited

◆ difference_type

template<typename T>
typedef ptrdiff_t Ogre::SmallVectorTemplateCommon< T >::difference_type
inherited

◆ value_type

template<typename T>
typedef T Ogre::SmallVectorTemplateCommon< T >::value_type
inherited

◆ const_iterator

template<typename T>
typedef const T* Ogre::SmallVectorTemplateCommon< T >::const_iterator
inherited

◆ const_reverse_iterator

template<typename T>
typedef std::reverse_iterator<const_iterator> Ogre::SmallVectorTemplateCommon< T >::const_reverse_iterator
inherited

◆ reverse_iterator

template<typename T>
typedef std::reverse_iterator<iterator> Ogre::SmallVectorTemplateCommon< T >::reverse_iterator
inherited

◆ reference

template<typename T>
typedef T& Ogre::SmallVectorTemplateCommon< T >::reference
inherited

◆ const_reference

template<typename T>
typedef const T& Ogre::SmallVectorTemplateCommon< T >::const_reference
inherited

◆ pointer

template<typename T>
typedef T* Ogre::SmallVectorTemplateCommon< T >::pointer
inherited

◆ const_pointer

template<typename T>
typedef const T* Ogre::SmallVectorTemplateCommon< T >::const_pointer
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

◆ SmallVector() [3/4]

template<typename T, unsigned N>
template<typename ItTy >
Ogre::SmallVector< T, N >::SmallVector ( ItTy  S,
ItTy  E 
)
inline

◆ SmallVector() [4/4]

template<typename T, unsigned N>
Ogre::SmallVector< T, N >::SmallVector ( const SmallVector< T, N > &  RHS)
inline

Member Function Documentation

◆ operator=()

template<typename T, unsigned N>
const SmallVector& Ogre::SmallVector< T, N >::operator= ( const SmallVector< T, N > &  RHS)
inline

◆ clear()

template<typename T>
void Ogre::SmallVectorImpl< T >::clear ( void  )
inlineinherited

◆ resize() [1/2]

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

◆ resize() [2/2]

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

◆ reserve()

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

◆ push_back()

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

◆ pop_back()

template<typename T>
void Ogre::SmallVectorImpl< T >::pop_back ( )
inlineinherited

◆ pop_back_val()

template<typename T>
T Ogre::SmallVectorImpl< T >::pop_back_val ( )
inlineinherited

◆ swap()

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

Referenced by std::swap().

◆ 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.

◆ 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.

◆ assign()

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

◆ erase() [1/2]

template<typename T>
iterator Ogre::SmallVectorImpl< T >::erase ( iterator  I)
inlineinherited

◆ erase() [2/2]

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

◆ insert() [1/3]

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

◆ insert() [2/3]

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

◆ insert() [3/3]

template<typename T>
template<typename ItTy >
iterator Ogre::SmallVectorImpl< T >::insert ( iterator  I,
ItTy  From,
ItTy  To 
)
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

◆ operator<()

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

◆ 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.

◆ destroy_range()

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

◆ 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.

◆ 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.

Referenced by Ogre::SmallVectorImpl< Triangle * >::swap().

◆ begin() [1/2]

template<typename T>
iterator Ogre::SmallVectorTemplateCommon< T >::begin ( )
inlineinherited

Referenced by Ogre::SmallVectorImpl< Triangle * >::operator<(), Ogre::SmallVectorImpl< Triangle * >::operator=(), Ogre::SmallVectorImpl< Triangle * >::operator==(), and Ogre::SmallVectorImpl< Triangle * >::swap().

◆ begin() [2/2]

template<typename T>
const_iterator Ogre::SmallVectorTemplateCommon< T >::begin ( ) const
inlineinherited

◆ end() [1/2]

template<typename T>
iterator Ogre::SmallVectorTemplateCommon< T >::end ( void  )
inlineinherited

Referenced by Ogre::SmallVectorImpl< Triangle * >::operator<(), Ogre::SmallVectorImpl< Triangle * >::operator=(), and Ogre::SmallVectorImpl< Triangle * >::swap().

◆ end() [2/2]

template<typename T>
const_iterator Ogre::SmallVectorTemplateCommon< T >::end ( void  ) const
inlineinherited

◆ rbegin() [1/2]

template<typename T>
reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rbegin ( )
inlineinherited

◆ rbegin() [2/2]

template<typename T>
const_reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rbegin ( ) const
inlineinherited

◆ rend() [1/2]

template<typename T>
reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rend ( )
inlineinherited

◆ rend() [2/2]

template<typename T>
const_reverse_iterator Ogre::SmallVectorTemplateCommon< T >::rend ( ) const
inlineinherited

◆ size()

template<typename T>
size_type Ogre::SmallVectorTemplateCommon< T >::size ( void  ) const
inlineinherited

Referenced by Ogre::SmallVectorImpl< Triangle * >::operator=(), Ogre::SmallVectorImpl< Triangle * >::operator==(), and Ogre::SmallVectorImpl< Triangle * >::swap().

◆ max_size()

template<typename T>
size_type Ogre::SmallVectorTemplateCommon< T >::max_size ( ) 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.

Referenced by Ogre::SmallVectorImpl< Triangle * >::swap().

◆ data() [1/2]

template<typename T>
pointer Ogre::SmallVectorTemplateCommon< T >::data ( )
inlineinherited

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

◆ 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().

◆ operator[]() [1/2]

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

◆ operator[]() [2/2]

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

◆ front() [1/2]

template<typename T>
reference Ogre::SmallVectorTemplateCommon< T >::front ( )
inlineinherited

◆ front() [2/2]

template<typename T>
const_reference Ogre::SmallVectorTemplateCommon< T >::front ( ) const
inlineinherited

◆ back() [1/2]

template<typename T>
reference Ogre::SmallVectorTemplateCommon< T >::back ( )
inlineinherited

◆ back() [2/2]

template<typename T>
const_reference Ogre::SmallVectorTemplateCommon< T >::back ( ) const
inlineinherited

◆ empty()

bool Ogre::SmallVectorBase::empty ( ) const
inlineinherited

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

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