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

Specialize SmallVector at N=0. More...

`#include <OgreSmallVector.h>`

Inheritance diagram for Ogre::SmallVector< T, 0 >:
[legend]

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

## Protected Member Functions

size_t | capacity_in_bytes () const
| capacity_in_bytes - This returns capacity()*sizeof(T). More...
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 More...
bool | isSmall () const
| isSmall - Return true if this is a smallvector which has not had dynamic memory allocated for it. More...
void | setEnd (T *P)
size_t | size_in_bytes () const
| size_in_bytes - This returns size()*sizeof(T). More...

## Protected Attributes

void * | BeginX
void * | CapacityX
void * | EndX
union Ogre::SmallVectorBase::U | FirstEl

## 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

template<typename T>

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

inherited

Definition at line 173 of file OgreSmallVector.h.

## const_pointer

template<typename T>

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

inherited

Definition at line 181 of file OgreSmallVector.h.

## const_reference

template<typename T>

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

inherited

Definition at line 179 of file OgreSmallVector.h.

## const_reverse_iterator

template<typename T>

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

inherited

Definition at line 175 of file OgreSmallVector.h.

## difference_type

template<typename T>

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

inherited

Definition at line 170 of file OgreSmallVector.h.

## iterator

template<typename T>

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

inherited

Definition at line 332 of file OgreSmallVector.h.

## pointer

template<typename T>

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

inherited

Definition at line 180 of file OgreSmallVector.h.

## reference

template<typename T>

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

inherited

Definition at line 178 of file OgreSmallVector.h.

## reverse_iterator

template<typename T>

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

inherited

Definition at line 176 of file OgreSmallVector.h.

## size_type

template<typename T>

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

inherited

Definition at line 333 of file OgreSmallVector.h.

## value_type

template<typename T>

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

inherited

Definition at line 171 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.

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

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

## SmallVector() [4/4]

template<typename T >

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

Definition at line 786 of file OgreSmallVector.h.

## 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
| ) |  |

inherited

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

Definition at line 411 of file OgreSmallVector.h.

## append() [2/2]

template<typename T>

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

inherited

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

Definition at line 426 of file OgreSmallVector.h.

## assign()

template<typename T>

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

inherited

Definition at line 436 of file OgreSmallVector.h.

## back() [1/2]

template<typename T>

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

inherited

Definition at line 227 of file OgreSmallVector.h.

## back() [2/2]

template<typename T>

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

inherited

Definition at line 230 of file OgreSmallVector.h.

## begin() [1/2]

template<typename T>

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

inherited

Definition at line 184 of file OgreSmallVector.h.

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

## begin() [2/2]

template<typename T>

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

inherited

Definition at line 185 of file OgreSmallVector.h.

## capacity()

template<typename T>

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

inherited

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

Definition at line 204 of file OgreSmallVector.h.

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

## capacity_in_bytes()

size_t Ogre::SmallVectorBase::capacity_in_bytes | ( |  | ) | const

protected inherited

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

Definition at line 149 of file OgreSmallVector.h.

## capacity_ptr() [1/2]

template<typename T>

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

protected inherited

Definition at line 189 of file OgreSmallVector.h.

## capacity_ptr() [2/2]

template<typename T>

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

protected inherited

Definition at line 190 of file OgreSmallVector.h.

## clear()

template<typename T>

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

inherited

Definition at line 350 of file OgreSmallVector.h.

## data() [1/2]

template<typename T>

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

inherited

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

Definition at line 207 of file OgreSmallVector.h.

## data() [2/2]

template<typename T>

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

inherited

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

Definition at line 209 of file OgreSmallVector.h.

## destroy_range()

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

static inherited

Definition at line 242 of file OgreSmallVector.h.

## empty()

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

inherited

Definition at line 158 of file OgreSmallVector.h.

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

## end() [1/2]

template<typename T>

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

inherited

Definition at line 186 of file OgreSmallVector.h.

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

## end() [2/2]

template<typename T>

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

inherited

Definition at line 187 of file OgreSmallVector.h.

## erase() [1/2]

template<typename T>

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

inherited

Definition at line 444 of file OgreSmallVector.h.

## erase() [2/2]

template<typename T>

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

inherited

Definition at line 453 of file OgreSmallVector.h.

## front() [1/2]

template<typename T>

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

inherited

Definition at line 220 of file OgreSmallVector.h.

## front() [2/2]

template<typename T>

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

inherited

Definition at line 223 of file OgreSmallVector.h.

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

Definition at line 263 of file OgreSmallVector.h.

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

## grow_pod()

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

protected inherited

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]

template<typename T>

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

inherited

Definition at line 463 of file OgreSmallVector.h.

## insert() [2/3]

template<typename T>

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

inherited

Definition at line 484 of file OgreSmallVector.h.

## insert() [3/3]

template<typename T>
template<typename ItTy >

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

inherited

Definition at line 532 of file OgreSmallVector.h.

## isSmall()

bool Ogre::SmallVectorBase::isSmall | ( |  | ) | const

protected inherited

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.

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

## max_size()

template<typename T>

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

inherited

Definition at line 200 of file OgreSmallVector.h.

## operator!=()

template<typename T>

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

inherited

Definition at line 590 of file OgreSmallVector.h.

## operator<()

template<typename T>

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

inherited

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.

## operator==()

template<typename T>

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

inherited

Definition at line 586 of file OgreSmallVector.h.

## operator[]() [1/2]

template<typename T>

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

inherited

Definition at line 211 of file OgreSmallVector.h.

## operator[]() [2/2]

template<typename T>

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

inherited

Definition at line 215 of file OgreSmallVector.h.

## pop_back()

template<typename T>

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

inherited

Definition at line 395 of file OgreSmallVector.h.

## pop_back_val()

template<typename T>

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

inherited

Definition at line 400 of file OgreSmallVector.h.

## push_back()

template<typename T>

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

inherited

Definition at line 384 of file OgreSmallVector.h.

## rbegin() [1/2]

template<typename T>

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

inherited

Definition at line 194 of file OgreSmallVector.h.

## rbegin() [2/2]

template<typename T>

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

inherited

Definition at line 195 of file OgreSmallVector.h.

## rend() [1/2]

template<typename T>

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

inherited

Definition at line 196 of file OgreSmallVector.h.

## rend() [2/2]

template<typename T>

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

inherited

Definition at line 197 of file OgreSmallVector.h.

## reserve()

template<typename T>

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

inherited

Definition at line 379 of file OgreSmallVector.h.

## resize() [1/2]

template<typename T>

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

inherited

Definition at line 355 of file OgreSmallVector.h.

## resize() [2/2]

template<typename T>

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

inherited

Definition at line 367 of file OgreSmallVector.h.

## set_size()

template<typename T>

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

inherited

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

template<typename T>

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

protected inherited

Definition at line 165 of file OgreSmallVector.h.

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

## size()

template<typename T>

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

inherited

Definition at line 199 of file OgreSmallVector.h.

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

## size_in_bytes()

size_t Ogre::SmallVectorBase::size_in_bytes | ( |  | ) | const

protected inherited

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

Definition at line 144 of file OgreSmallVector.h.

## swap()

template<typename T >

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

inherited

Definition at line 622 of file OgreSmallVector.h.

Referenced by std::swap().

## uninitialized_copy()

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

static inherited

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 inherited

Definition at line 118 of file OgreSmallVector.h.

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

## CapacityX

void * Ogre::SmallVectorBase::CapacityX

protected inherited

Definition at line 118 of file OgreSmallVector.h.

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

## EndX

void * Ogre::SmallVectorBase::EndX

protected inherited

Definition at line 118 of file OgreSmallVector.h.

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

## FirstEl

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

protected inherited

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

- OgreSmallVector.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.