VectorSet is basically a helper to use a vector as a small set container. More...

#include <OgreVectorSet.h>

Inheritance diagram for Ogre::VectorSet< T, S >:

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 SmallVector< T, S >::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
iterator	add (const T &item)
void	addNotExists (const T &item)
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.
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)
iterator	find (const T &item)
iterator	findExists (const T &item)
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.
bool	has (const T &item)
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
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
bool	remove (const T &item)
void	remove (iterator it)
void	removeExists (const T &item)
reverse_iterator	rend ()
const_reverse_iterator	rend () const
void	replaceExists (const T &oldItem, const T &newItem)
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.

Detailed Description

template<typename T, unsigned S>
struct Ogre::VectorSet< T, S >

VectorSet is basically a helper to use a vector as a small set container.

Also these functions keep the code clean and fast. You can insert in O(1) time, if you know that it doesn't exists. You can remove in O(1) time, if you know the position of the item.

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, unsigned S>

typedef SmallVector<T,S>::iterator Ogre::VectorSet< T, S >::iterator

◆ 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

Member Function Documentation

◆ add()

template<typename T, unsigned S>

VectorSet< T, S >::iterator Ogre::VectorSet< T, S >::add ( const T & item )

References Ogre::SmallVector< T, S >::end(), find(), and Ogre::SmallVector< T, S >::push_back().

◆ addNotExists()

template<typename T, unsigned S>

void Ogre::VectorSet< T, S >::addNotExists ( const T & item )

References Ogre::SmallVector< T, S >::end(), find(), OgreAssert, and Ogre::SmallVector< T, S >::push_back().

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

Referenced by Ogre::SmallVector< T, 0 >::SmallVector(), Ogre::U< T >::insert(), Ogre::U< T >::insert(), and Ogre::iterator< T, S >::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

◆ back() [1/2]

template<typename T>

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

inlineinherited

References end().

◆ back() [2/2]

template<typename T>

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

inlineinherited

References end().

◆ begin() [1/2]

template<typename T>

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

inlineinherited

Referenced by capacity(), data(), data(), front(), front(), Ogre::SmallVectorTemplateBase< T, isPodLike >::grow(), Ogre::U< T >::operator<(), Ogre::SmallVectorImpl< T >::operator=(), Ogre::U< T >::operator==(), operator[](), operator[](), rend(), rend(), size(), and Ogre::SmallVectorImpl< T >::swap().

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

Referenced by Ogre::SmallVectorTemplateBase< T, isPodLike >::grow(), and Ogre::SmallVectorImpl< T >::swap().

◆ clear()

template<typename T>

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

inlineinherited

Referenced by Ogre::U< 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 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 begin().

◆ destroy_range()

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

inlinestaticinherited

Referenced by Ogre::U< T >::~SmallVectorImpl(), Ogre::U< T >::clear(), Ogre::U< T >::erase(), Ogre::SmallVectorImpl< T >::operator=(), Ogre::U< T >::resize(), Ogre::U< T >::resize(), and Ogre::SmallVectorImpl< T >::swap().

◆ empty()

bool Ogre::SmallVectorBase::empty ( ) const

inlineinherited

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

◆ end() [1/2]

template<typename T>

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

inlineinherited

Referenced by back(), back(), Ogre::SmallVectorTemplateBase< T, isPodLike >::grow(), Ogre::U< T >::operator<(), Ogre::SmallVectorImpl< T >::operator=(), operator[](), operator[](), rbegin(), rbegin(), size(), and Ogre::SmallVectorImpl< T >::swap().

◆ 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

◆ erase() [2/2]

template<typename T>

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

inlineinherited

◆ find()

template<typename T, unsigned S>

VectorSet< T, S >::iterator Ogre::VectorSet< T, S >::find ( const T & item )

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

Referenced by add(), addNotExists(), findExists(), has(), remove(), removeExists(), and replaceExists().

◆ findExists()

template<typename T, unsigned S>

VectorSet< T, S >::iterator Ogre::VectorSet< T, S >::findExists ( const T & item )

References Ogre::SmallVector< T, S >::end(), find(), and OgreAssert.

◆ front() [1/2]

template<typename T>

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

inlineinherited

References begin().

◆ front() [2/2]

template<typename T>

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

inlineinherited

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

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

◆ has()

template<typename T, unsigned S>

bool Ogre::VectorSet< T, S >::has ( const T & item )

References Ogre::SmallVector< T, S >::end(), and find().

◆ insert() [1/3]

template<typename T>

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

inlineinherited

◆ insert() [2/3]

template<typename T>

template<typename ItTy>

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

inlineinherited

◆ insert() [3/3]

template<typename T>

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

inlineinherited

◆ 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

◆ operator==()

template<typename T>

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

inlineinherited

◆ operator[]() [1/2]

template<typename T>

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

inlineinherited

References begin(), and end().

◆ operator[]() [2/2]

template<typename T>

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

inlineinherited

References begin(), and end().

◆ pop_back()

template<typename T>

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

inlineinherited

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

◆ pop_back_val()

template<typename T>

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

inlineinherited

◆ push_back()

template<typename T>

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

inlineinherited

Referenced by Ogre::SmallVector< T, 0 >::SmallVector(), Ogre::U< T >::insert(), and Ogre::iterator< T, S >::SmallVector().

◆ rbegin() [1/2]

template<typename T>

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

inlineinherited

References end().

◆ rbegin() [2/2]

template<typename T>

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

inlineinherited

References end().

◆ remove() [1/2]

template<typename T, unsigned S>

bool Ogre::VectorSet< T, S >::remove ( const T & item )

References Ogre::SmallVector< T, S >::end(), find(), and remove().

◆ remove() [2/2]

template<typename T, unsigned S>

void Ogre::VectorSet< T, S >::remove ( iterator it )

References Ogre::SmallVector< T, S >::back(), and Ogre::SmallVector< T, S >::pop_back().

Referenced by remove(), and removeExists().

◆ removeExists()

template<typename T, unsigned S>

void Ogre::VectorSet< T, S >::removeExists ( const T & item )

References Ogre::SmallVector< T, S >::end(), find(), OgreAssert, and remove().

◆ rend() [1/2]

template<typename T>

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

inlineinherited

References begin().

◆ rend() [2/2]

template<typename T>

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

inlineinherited

References begin().

◆ replaceExists()

template<typename T, unsigned S>

void Ogre::VectorSet< T, S >::replaceExists	(	const T &	oldItem,
		const T &	newItem )

References Ogre::SmallVector< T, S >::end(), find(), and OgreAssert.

◆ reserve()

template<typename T>

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

inlineinherited

Referenced by Ogre::SmallVector< T, 0 >::SmallVector(), Ogre::U< T >::insert(), Ogre::U< T >::insert(), and Ogre::iterator< T, S >::SmallVector().

◆ 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

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

◆ size()

template<typename T>

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

inlineinherited

References begin(), and end().

Referenced by Ogre::SmallVectorTemplateBase< T, isPodLike >::grow(), Ogre::SmallVectorImpl< T >::operator=(), Ogre::U< T >::operator==(), and Ogre::SmallVectorImpl< T >::swap().

◆ swap()

template<typename T>

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

inherited

Referenced by std::swap(), and std::swap().

◆ uninitialized_copy()

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.

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

The documentation for this struct was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Member Function Documentation

◆ add()

◆ addNotExists()

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

◆ find()

◆ findExists()

◆ front() [1/2]

◆ front() [2/2]

◆ grow()

◆ has()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ max_size()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ pop_back_val()

◆ push_back()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeExists()

◆ rend() [1/2]

◆ rend() [2/2]

◆ replaceExists()

◆ reserve()

◆ resize() [1/2]

◆ resize() [2/2]

◆ set_size()

◆ size()

◆ swap()

◆ uninitialized_copy()