StableArray Class Template Reference

#include <StableArray.h>

List of all members.

---

Detailed Description

template<class T>
class SimTK::StableArray< T >

StableArray<T> is like std::vector<T> but more stable in two ways:

• the addresses of the inserted items never change, even if the array has to be resized, and
• the index of an inserted item never changes either.

The above means that once you insert an item (meaning that a copy of it resides in the StableArray), you can save the address of that copy and/or its index and be certain that adding or deleting other items will leave those unaffected. Once an item has been erased, however, we will feel free to reuse both the heap it once consumed and its index.

As your punishment for the crime of enjoying this stability guarantee, consecutive elements of a StableArray are not consecutive in memory.

CAUTION: this is not suited for use across binary interfaces because the implementation is fully exposed.

Public Member Functions
	StableArray ()
	StableArray (size_t z, const T &ival=T())
	StableArray (const StableArray &s)
StableArray &	operator= (const StableArray &s)
	~StableArray ()
bool	empty () const
bool	empty (size_t i) const
size_t	size () const
size_t	nItems () const
void	resize (size_t newz, const T &ival=T())
void	clear ()
void	push_back (const T &t)
void	pop_back ()
void	insertAt (size_t i, const T &t)
size_t	findFreeSlot () const
size_t	findNextItem (size_t i)
size_t	insert (const T &t)
void	erase (size_t i)
const T &	front () const
T &	front ()
const T &	back () const
T &	back ()
const T &	operator[] (size_t i) const
T &	operator[] (size_t i)

---

Constructor & Destructor Documentation

StableArray

(

)

[inline]

StableArray	(	size_t	z,
		const T &	ival = T()
	)			[inline, explicit]

References fkinkryx::i, and C::T.

StableArray

(

const StableArray< T > &

s

)

[inline]

References StableArray::empty(), fkinkryx::i, StableArray::nItems(), and StableArray::size().

~StableArray

(

)

[inline]

References StableArray::clear().

---

Member Function Documentation

StableArray& operator=

(

const StableArray< T > &

s

)

[inline]

References StableArray::clear(), StableArray::empty(), fkinkryx::i, StableArray::nItems(), and StableArray::size().

bool empty

(

)

const [inline]

Referenced by StableArray::back(), StableArray::findFreeSlot(), StableArray::operator=(), StableArray::pop_back(), and StableArray::StableArray().

bool empty

(

size_t

i

)

const [inline]

size_t size

(

)

const [inline]

Referenced by StableArray::findFreeSlot(), StableArray::insertAt(), StableArray::operator=(), and StableArray::StableArray().

size_t nItems

(

)

const [inline]

Referenced by StableArray::clear(), StableArray::findFreeSlot(), StableArray::operator=(), StableArray::resize(), and StableArray::StableArray().

void resize	(	size_t	newz,
		const T &	ival = T()
	)			[inline]

References fkinkryx::i, and StableArray::nItems().

void clear

(

)

[inline]

References fkinkryx::i, and StableArray::nItems().

Referenced by StableArray::operator=(), and StableArray::~StableArray().

void push_back

(

const T &

t

)

[inline]

References C::T.

Referenced by StableArray::insertAt().

void pop_back

(

)

[inline]

References StableArray::empty().

Referenced by StableArray::erase().

void insertAt	(	size_t	i,
		const T &	t
	)			[inline]

References StableArray::push_back(), and StableArray::size().

Referenced by StableArray::insert().

size_t findFreeSlot

(

)

const [inline]

References StableArray::empty(), fkinkryx::i, StableArray::nItems(), and StableArray::size().

Referenced by StableArray::insert().

size_t findNextItem

(

size_t

i

)

[inline]

Referenced by StableArray::front().

size_t insert

(

const T &

t

)

[inline]

References StableArray::findFreeSlot(), and StableArray::insertAt().

void erase

(

size_t

i

)

[inline]

References StableArray::pop_back().

const T& front

(

)

const [inline]

References StableArray::findNextItem().

T& front

(

)

[inline]

References StableArray::findNextItem().

const T& back

(

)

const [inline]

References StableArray::empty().

T& back

(

)

[inline]

References StableArray::empty().

const T& operator[]

(

size_t

i

)

const [inline]

T& operator[]

(

size_t

i

)

[inline]

---

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

• StableArray.h