Teuchos::StringIndexedOrderedValueObjectContainer< ObjType > Class Template Reference

String indexed ordered value-type object container class. More...

#include <Teuchos_StringIndexedOrderedValueObjectContainer.hpp>

Inheritance diagram for Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >:

List of all members.

Private Types
typedef KeyObjectPair< ObjType >	key_and_obj_t
typedef std::deque< key_and_obj_t >	key_and_obj_array_t
typedef std::map< std::string, OrdinalIndex >	key_to_idx_map_t
Private Member Functions
void	assertOrdinalIndex (const Ordinal idx) const
key_and_obj_t &	getNonconstKeyAndObject (const Ordinal idx)
const key_and_obj_t &	getKeyAndObject (const Ordinal idx) const
void	throwInvalidKeyError (const Ordinal idx, const std::string &key) const
Ordinal	assertKeyGetOrdinal (const std::string &key) const
Private Attributes
key_and_obj_array_t	key_and_obj_array_
	Stories objects contiguously along with key strings.
key_to_idx_map_t	key_to_idx_map_
	Provides lookups of key -> ordinal index into above array.
Public types.
typedef StringIndexedOrderedValueObjectContainerBase::Ordinal	Ordinal
	Ordinal used for the index.
typedef FilteredIterator < typename key_and_obj_array_t::iterator, SelectActive< ObjType > >	Iterator
	The non-const iterator type.
typedef FilteredIterator < typename key_and_obj_array_t::const_iterator, SelectActive< ObjType > >	ConstIterator
	The const iterator type.
Constructors/Destructors/Info
	StringIndexedOrderedValueObjectContainer ()
Ordinal	numObjects () const
Ordinal	numStorage () const
Set, get, and remove functions
Ordinal	setObj (const std::string &key, const ObjType &obj)
	Set (or reset) object by value and return its ordinal index.
Ordinal	getObjOrdinalIndex (const std::string &key) const
	Get the ordinal index given the string key.
Ptr< ObjType >	getNonconstObjPtr (const Ordinal &idx)
	Get a nonconst semi-persisting association with the stored object indexed by ordinal.
Ptr< const ObjType >	getObjPtr (const Ordinal &idx) const
	Get a const semi-persisting association with the stored object indexed by ordinal.
Ptr< ObjType >	getNonconstObjPtr (const std::string &key)
	Get a nonconst semi-persisting association with the stored object indexed by string key.
Ptr< const ObjType >	getObjPtr (const std::string &key) const
	Get a const semi-persisting association with the stored object indexed by string key.
void	removeObj (const Ordinal &idx)
	Remove an object given its ordinal index.
void	removeObj (const std::string &key)
	Remove an object given its string key.
Iterator access
Iterator	nonconstBegin ()
Iterator	nonconstEnd ()
ConstIterator	begin () const
ConstIterator	end () const

---

Detailed Description

template<class ObjType>
class Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >

String indexed ordered value-type object container class.

This class is a simple utility class for managing the storage and retrievel of value-type objects which the following features/properties:

• Objects are held by-value (i.e., like std::vector, std::map, etc.)
• Objects are indexed by a unique string key value.
• Objects can also be indexed by a unique ordering ordinal.
• Iterators are orderded according to insertion order.

The design of this class comes with a few important limitations:

• Storage grows accoding to the number of insertions and removing objects does not decrease it. This is a result of the simple implementation needed to preserve ordering

Todo:

Implement compression of unused entries. This will invalidate the indexes but will allow handling of lots of inserts and deletes of elements.

Definition at line 175 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

---

Member Typedef Documentation

template<class ObjType>

typedef KeyObjectPair<ObjType> Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::key_and_obj_t [private]

Definition at line 181 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

typedef std::deque<key_and_obj_t> Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::key_and_obj_array_t [private]

Definition at line 183 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

typedef std::map<std::string, OrdinalIndex> Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::key_to_idx_map_t [private]

Definition at line 185 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

typedef StringIndexedOrderedValueObjectContainerBase::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal

Ordinal used for the index.

Reimplemented from Teuchos::StringIndexedOrderedValueObjectContainerBase.

Definition at line 193 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

typedef FilteredIterator<typename key_and_obj_array_t::iterator, SelectActive<ObjType> > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::Iterator

The non-const iterator type.

Definition at line 197 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

typedef FilteredIterator<typename key_and_obj_array_t::const_iterator, SelectActive<ObjType> > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::ConstIterator

The const iterator type.

Definition at line 201 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

---

Constructor & Destructor Documentation

template<class ObjType >

Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::StringIndexedOrderedValueObjectContainer

(

)

Definition at line 433 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

---

Member Function Documentation

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::numObjects

(

)

const

Definition at line 439 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::numStorage

(

)

const

Definition at line 447 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::setObj	(	const std::string &	key,
		const ObjType &	obj
	)

Set (or reset) object by value and return its ordinal index.

If the object with the given key index does not exist, it will be added. If an object with the given key does not exist, it will be created.

Returns:

Returns the ordinal index by which the object can be looked up with.

Definition at line 471 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getObjOrdinalIndex

(

const std::string &

key

)

const [inline]

Get the ordinal index given the string key.

If the key does not exist, then getInvalidOrdinal() is returned.

Definition at line 459 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

Ptr< ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getNonconstObjPtr

(

const Ordinal &

idx

)

[inline]

Get a nonconst semi-persisting association with the stored object indexed by ordinal.

Definition at line 348 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

Ptr< const ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getObjPtr

(

const Ordinal &

idx

)

const [inline]

Get a const semi-persisting association with the stored object indexed by ordinal.

Definition at line 357 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

Ptr< ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getNonconstObjPtr

(

const std::string &

key

)

[inline]

Get a nonconst semi-persisting association with the stored object indexed by string key.

Definition at line 366 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

Ptr< const ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getObjPtr

(

const std::string &

key

)

const [inline]

Get a const semi-persisting association with the stored object indexed by string key.

Definition at line 375 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

void Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::removeObj

(

const Ordinal &

idx

)

Remove an object given its ordinal index.

Each object is errased by assigning to a default-constructed ObjType(). This, for example, will wipe out the reference count for a smart pointer class or will unsize an array, etc..

Definition at line 490 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

void Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::removeObj

(

const std::string &

key

)

Remove an object given its string key.

Definition at line 499 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::Iterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::nonconstBegin

(

)

[inline]

Definition at line 387 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::Iterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::nonconstEnd

(

)

[inline]

Definition at line 397 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::ConstIterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::begin

(

)

const [inline]

Definition at line 407 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::ConstIterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::end

(

)

const [inline]

Definition at line 417 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

void Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::assertOrdinalIndex

(

const Ordinal

idx

)

const [private]

Definition at line 515 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::key_and_obj_t & Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getNonconstKeyAndObject

(

const Ordinal

idx

)

[private]

Definition at line 527 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

const StringIndexedOrderedValueObjectContainer< ObjType >::key_and_obj_t & Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getKeyAndObject

(

const Ordinal

idx

)

const [private]

Definition at line 541 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

void Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::throwInvalidKeyError	(	const Ordinal	idx,
		const std::string &	key
	)		const [private]

Definition at line 555 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >

StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::assertKeyGetOrdinal

(

const std::string &

key

)

const [private]

Definition at line 565 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

---

Member Data Documentation

template<class ObjType>

key_and_obj_array_t Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::key_and_obj_array_ [private]

Stories objects contiguously along with key strings.

Definition at line 291 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>

key_to_idx_map_t Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::key_to_idx_map_ [private]

Provides lookups of key -> ordinal index into above array.

Definition at line 293 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

---

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

• Teuchos_StringIndexedOrderedValueObjectContainer.hpp