Keyed-access map with key subset map for each client class. More...

#include <ClassKeyMap.hh>

Public Types
typedef K	key_type

typedef T	mapped_type

typedef T &	mapped_reference

typedef T const &	mapped_const_reference

typedef T *	mapped_pointer

typedef T const *	mapped_const_pointer

typedef Vector::value_type	value_type

typedef Vector::reference	reference

typedef Vector::const_reference	const_reference

typedef Vector::pointer	pointer

typedef Vector::const_pointer	const_pointer

typedef Vector::iterator	iterator

typedef Vector::const_iterator	const_iterator

typedef Vector::reverse_iterator	reverse_iterator

typedef Vector::const_reverse_iterator	const_reverse_iterator

typedef Vector::size_type	size_type

typedef Vector::index_type	index_type

typedef Vector::difference_type	difference_type

typedef Vector::allocator_type	allocator_type

typedef C	client_type

typedef K	Key

typedef T	Mapped

typedef T &	MappedReference

typedef T const &	MappedConstReference

typedef T *	MappedPointer

typedef T const *	MappedConstPointer

typedef Vector::Value	Value

typedef Vector::Reference	Reference

typedef Vector::ConstReference	ConstReference

typedef Vector::Pointer	Pointer

typedef Vector::ConstPointer	ConstPointer

typedef Vector::Iterator	Iterator

typedef Vector::ConstIterator	ConstIterator

typedef Vector::ReverseIterator	ReverseIterator

typedef Vector::ConstReverseIterator	ConstReverseIterator

typedef Vector::Size	Size

typedef Vector::Index	Index

typedef Vector::Difference	Difference

typedef Vector::Allocator	Allocator

typedef C	Client

Public Member Functions
	ClassKeyMap ()=default
	Default constructor. More...

	ClassKeyMap (ClassKeyMap const &a)
	Copy constructor. More...

template<typename InputIterator >
	ClassKeyMap (InputIterator const beg, InputIterator const end)
	Iterator range constructor. More...

	~ClassKeyMap ()
	Destructor. More...

ClassKeyMap &	operator= (ClassKeyMap const &a)
	Copy assignment. More...

ClassKeyMap &	operator= (Mapped const &mapped)
	Uniform value assignment to current elements. More...

ClassKeyMap &	assign (Key const &key, Mapped const &mapped)
	Assign a value to an element with a key. More...

ClassKeyMap &	assign (Value const &value)
	Assign a value to an element. More...

template<typename InputIterator >
void	assign (InputIterator const beg, InputIterator const end)
	Iterator assignment. More...

ClassKeyMap &	add (Key const &key)
	Add an element with a key if not present: Activate key if inactive. More...

ClassKeyMap &	insert (Value const &value)
	Insert an element. More...

template<typename InputIterator >
void	insert (InputIterator const beg, InputIterator const end)
	Insert elements from iterator range [beg,end) More...

void	reserve (Size const num)
	Reserve space for a given number of elements. More...

void	shrink ()
	Shrink the vector to remove unused capacity. More...

void	swap (ClassKeyMap &a)
	swap( ClassKeyMap ) More...

void	clear ()
	Clear the vector. More...

Size	size () const
	Size. More...

bool	empty () const
	Empty? More...

Size	max_size () const
	Max size. More...

Size	capacity () const
	Capacity. More...

bool	has (Key const &key) const
	Is an element with a key present? More...

ConstIterator	find (Key const &key) const
	Iterator to element with a key. More...

Iterator	find (Key const &key)
	Iterator to element with a key. More...

MappedReference	operator() (Key const &key)
	ClassKeyMap( key ) More...

MappedConstReference	operator[] (Key const &key) const
	ClassKeyMap[ key ] const. More...

MappedReference	operator[] (Key const &key)
	ClassKeyMap[ key ]. More...

MappedConstReference	operator[] (Index const &i) const
	ClassKeyMap[ index ] const. More...

MappedReference	operator[] (Index const &i)
	ClassKeyMap[ index ]. More...

ConstReference	operator() (Index const &i) const
	ClassKeyMap( index ) const. More...

Reference	operator() (Index const &i)
	ClassKeyMap( index ) More...

ConstIterator	begin () const
	Begin iterator. More...

Iterator	begin ()
	Begin iterator. More...

ConstIterator	end () const
	End iterator. More...

Iterator	end ()
	End iterator. More...

ConstReverseIterator	rbegin () const
	Begin reverse iterator. More...

ReverseIterator	rbegin ()
	Begin reverse iterator. More...

ConstReverseIterator	rend () const
	End reverse iterator. More...

ReverseIterator	rend ()
	End reverse iterator. More...

Static Public Member Functions
static Index const &	index (Key const &key)
	Index of a key. More...

static bool	active (Key const &key)
	Is a key active? More...

static bool	inactive (Key const &key)
	Is a key inactive? More...

static void	activate (Key const &key)
	Activate a key if inactive. More...

Private Types
typedef vector1< std::pair< K, T > >	Vector

typedef vector1< typename Vector::Index >	IndexMap

typedef IndexMap::Size	IndexMapSize

typedef IndexMap::Index	IndexMapIndex

Private Member Functions
Index const &	add_key (Key const &key)
	Add an element with a key if not present and return its index: Activate key if inactive. More...

Static Private Member Functions
static IndexMap &	m ()
	Index map from keys into v_: Zero => inactive key. More...

static Index &	u ()
	Upper active index of active keys. More...

static Index &	activated_index (Key const &key)
	Activate a key if inactive and return its index. More...

static void	map_shrink ()
	Shrink the index map to remove unused capacity. More...

Private Attributes
Vector	v_
	Vector of values indexed by a subset of the possible keys. More...

Friends
template<typename UK , typename UT , typename UC >
void	swap (ClassKeyMap< UK, UT, UC > &a, ClassKeyMap< UK, UT, UC > &b)
	swap( ClassKeyMap, ClassKeyMap ) More...

bool	operator== (ClassKeyMap const &a, ClassKeyMap const &b)
	ClassKeyMap == ClassKeyMap. More...

bool	operator!= (ClassKeyMap const &a, ClassKeyMap const &b)
	ClassKeyMap != ClassKeyMap. More...

bool	operator< (ClassKeyMap const &a, ClassKeyMap const &b)
	ClassKeyMap < ClassKeyMap. More...

bool	operator> (ClassKeyMap const &a, ClassKeyMap const &b)
	ClassKeyMap > ClassKeyMap. More...

bool	operator<= (ClassKeyMap const &a, ClassKeyMap const &b)
	ClassKeyMap <= ClassKeyMap. More...

bool	operator>= (ClassKeyMap const &a, ClassKeyMap const &b)
	ClassKeyMap >= ClassKeyMap. More...

Detailed Description

template<typename K, typename T, typename C>
class utility::keys::ClassKeyMap< K, T, C >

Keyed-access map with key subset map for each client class.

Member Typedef Documentation

◆ Allocator

template<typename K , typename T , typename C >

typedef Vector::Allocator utility::keys::ClassKeyMap< K, T, C >::Allocator

◆ allocator_type

template<typename K , typename T , typename C >

typedef Vector::allocator_type utility::keys::ClassKeyMap< K, T, C >::allocator_type

◆ Client

template<typename K , typename T , typename C >

typedef C utility::keys::ClassKeyMap< K, T, C >::Client

◆ client_type

template<typename K , typename T , typename C >

typedef C utility::keys::ClassKeyMap< K, T, C >::client_type

◆ const_iterator

template<typename K , typename T , typename C >

typedef Vector::const_iterator utility::keys::ClassKeyMap< K, T, C >::const_iterator

◆ const_pointer

template<typename K , typename T , typename C >

typedef Vector::const_pointer utility::keys::ClassKeyMap< K, T, C >::const_pointer

◆ const_reference

template<typename K , typename T , typename C >

typedef Vector::const_reference utility::keys::ClassKeyMap< K, T, C >::const_reference

◆ const_reverse_iterator

template<typename K , typename T , typename C >

typedef Vector::const_reverse_iterator utility::keys::ClassKeyMap< K, T, C >::const_reverse_iterator

◆ ConstIterator

template<typename K , typename T , typename C >

typedef Vector::ConstIterator utility::keys::ClassKeyMap< K, T, C >::ConstIterator

◆ ConstPointer

template<typename K , typename T , typename C >

typedef Vector::ConstPointer utility::keys::ClassKeyMap< K, T, C >::ConstPointer

◆ ConstReference

template<typename K , typename T , typename C >

typedef Vector::ConstReference utility::keys::ClassKeyMap< K, T, C >::ConstReference

◆ ConstReverseIterator

template<typename K , typename T , typename C >

typedef Vector::ConstReverseIterator utility::keys::ClassKeyMap< K, T, C >::ConstReverseIterator

◆ Difference

template<typename K , typename T , typename C >

typedef Vector::Difference utility::keys::ClassKeyMap< K, T, C >::Difference

◆ difference_type

template<typename K , typename T , typename C >

typedef Vector::difference_type utility::keys::ClassKeyMap< K, T, C >::difference_type

◆ Index

template<typename K , typename T , typename C >

typedef Vector::Index utility::keys::ClassKeyMap< K, T, C >::Index

◆ index_type

template<typename K , typename T , typename C >

typedef Vector::index_type utility::keys::ClassKeyMap< K, T, C >::index_type

◆ IndexMap

template<typename K , typename T , typename C >

typedef vector1< typename Vector::Index > utility::keys::ClassKeyMap< K, T, C >::IndexMap

private

◆ IndexMapIndex

template<typename K , typename T , typename C >

typedef IndexMap::Index utility::keys::ClassKeyMap< K, T, C >::IndexMapIndex

private

◆ IndexMapSize

template<typename K , typename T , typename C >

typedef IndexMap::Size utility::keys::ClassKeyMap< K, T, C >::IndexMapSize

private

◆ iterator

template<typename K , typename T , typename C >

typedef Vector::iterator utility::keys::ClassKeyMap< K, T, C >::iterator

◆ Iterator

template<typename K , typename T , typename C >

typedef Vector::Iterator utility::keys::ClassKeyMap< K, T, C >::Iterator

◆ Key

template<typename K , typename T , typename C >

typedef K utility::keys::ClassKeyMap< K, T, C >::Key

◆ key_type

template<typename K , typename T , typename C >

typedef K utility::keys::ClassKeyMap< K, T, C >::key_type

◆ Mapped

template<typename K , typename T , typename C >

typedef T utility::keys::ClassKeyMap< K, T, C >::Mapped

◆ mapped_const_pointer

template<typename K , typename T , typename C >

typedef T const* utility::keys::ClassKeyMap< K, T, C >::mapped_const_pointer

◆ mapped_const_reference

template<typename K , typename T , typename C >

typedef T const& utility::keys::ClassKeyMap< K, T, C >::mapped_const_reference

◆ mapped_pointer

template<typename K , typename T , typename C >

typedef T* utility::keys::ClassKeyMap< K, T, C >::mapped_pointer

◆ mapped_reference

template<typename K , typename T , typename C >

typedef T& utility::keys::ClassKeyMap< K, T, C >::mapped_reference

◆ mapped_type

template<typename K , typename T , typename C >

typedef T utility::keys::ClassKeyMap< K, T, C >::mapped_type

◆ MappedConstPointer

template<typename K , typename T , typename C >

typedef T const* utility::keys::ClassKeyMap< K, T, C >::MappedConstPointer

◆ MappedConstReference

template<typename K , typename T , typename C >

typedef T const& utility::keys::ClassKeyMap< K, T, C >::MappedConstReference

◆ MappedPointer

template<typename K , typename T , typename C >

typedef T* utility::keys::ClassKeyMap< K, T, C >::MappedPointer

◆ MappedReference

template<typename K , typename T , typename C >

typedef T& utility::keys::ClassKeyMap< K, T, C >::MappedReference

◆ pointer

template<typename K , typename T , typename C >

typedef Vector::pointer utility::keys::ClassKeyMap< K, T, C >::pointer

◆ Pointer

template<typename K , typename T , typename C >

typedef Vector::Pointer utility::keys::ClassKeyMap< K, T, C >::Pointer

◆ reference

template<typename K , typename T , typename C >

typedef Vector::reference utility::keys::ClassKeyMap< K, T, C >::reference

◆ Reference

template<typename K , typename T , typename C >

typedef Vector::Reference utility::keys::ClassKeyMap< K, T, C >::Reference

◆ reverse_iterator

template<typename K , typename T , typename C >

typedef Vector::reverse_iterator utility::keys::ClassKeyMap< K, T, C >::reverse_iterator

◆ ReverseIterator

template<typename K , typename T , typename C >

typedef Vector::ReverseIterator utility::keys::ClassKeyMap< K, T, C >::ReverseIterator

◆ Size

template<typename K , typename T , typename C >

typedef Vector::Size utility::keys::ClassKeyMap< K, T, C >::Size

◆ size_type

template<typename K , typename T , typename C >

typedef Vector::size_type utility::keys::ClassKeyMap< K, T, C >::size_type

◆ Value

template<typename K , typename T , typename C >

typedef Vector::Value utility::keys::ClassKeyMap< K, T, C >::Value

◆ value_type

template<typename K , typename T , typename C >

typedef Vector::value_type utility::keys::ClassKeyMap< K, T, C >::value_type

◆ Vector

template<typename K , typename T , typename C >

typedef vector1< std::pair< K, T > > utility::keys::ClassKeyMap< K, T, C >::Vector

private

Constructor & Destructor Documentation

◆ ClassKeyMap() [1/3]

template<typename K , typename T , typename C >

utility::keys::ClassKeyMap< K, T, C >::ClassKeyMap ( )

inlinedefault

Default constructor.

◆ ClassKeyMap() [2/3]

template<typename K , typename T , typename C >

utility::keys::ClassKeyMap< K, T, C >::ClassKeyMap ( ClassKeyMap< K, T, C > const & a )

inline

Copy constructor.

◆ ClassKeyMap() [3/3]

template<typename K , typename T , typename C >

template<typename InputIterator >

utility::keys::ClassKeyMap< K, T, C >::ClassKeyMap	(	InputIterator const	beg,
		InputIterator const	end
	)

inline

Iterator range constructor.

References utility::keys::ClassKeyMap< K, T, C >::add_key(), test.T009_Exceptions::e, create_a3b_hbs::first, create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ ~ClassKeyMap()

template<typename K , typename T , typename C >

utility::keys::ClassKeyMap< K, T, C >::~ClassKeyMap ( )

inline

Destructor.

Member Function Documentation

◆ activate()

template<typename K , typename T , typename C >

static void utility::keys::ClassKeyMap< K, T, C >::activate ( Key const & key )

inlinestatic

Activate a key if inactive.

References debug_assert, utility::vectorL< L, T, A >::has(), subloop_histogram::key, utility::keys::ClassKeyMap< K, T, C >::m(), and utility::keys::ClassKeyMap< K, T, C >::u().

Referenced by utility::keys::ClassKeyMap< K, T, C >::activated_index().

◆ activated_index()

template<typename K , typename T , typename C >

static Index& utility::keys::ClassKeyMap< K, T, C >::activated_index ( Key const & key )

inlinestaticprivate

Activate a key if inactive and return its index.

References utility::keys::ClassKeyMap< K, T, C >::activate(), subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::m().

Referenced by utility::keys::ClassKeyMap< K, T, C >::add_key().

◆ active()

template<typename K , typename T , typename C >

static bool utility::keys::ClassKeyMap< K, T, C >::active ( Key const & key )

inlinestatic

Is a key active?

References utility::keys::ClassKeyMap< K, T, C >::has(), subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::m().

Referenced by utility::keys::ClassKeyMap< K, T, C >::find(), utility::keys::ClassKeyMap< K, T, C >::index(), and utility::keys::ClassKeyMap< K, T, C >::operator[]().

◆ add()

template<typename K , typename T , typename C >

ClassKeyMap& utility::keys::ClassKeyMap< K, T, C >::add ( Key const & key )

inline

Add an element with a key if not present: Activate key if inactive.

References utility::keys::ClassKeyMap< K, T, C >::add_key(), and subloop_histogram::key.

Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ add_key()

template<typename K , typename T , typename C >

Index const& utility::keys::ClassKeyMap< K, T, C >::add_key ( Key const & key )

inlineprivate

Add an element with a key if not present and return its index: Activate key if inactive.

References utility::keys::ClassKeyMap< K, T, C >::activated_index(), debug_assert, create_a3b_hbs::i, subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::v_.

Referenced by utility::keys::ClassKeyMap< K, T, C >::add(), utility::keys::ClassKeyMap< K, T, C >::assign(), utility::keys::ClassKeyMap< K, T, C >::ClassKeyMap(), utility::keys::ClassKeyMap< K, T, C >::insert(), and utility::keys::ClassKeyMap< K, T, C >::operator()().

◆ assign() [1/3]

template<typename K , typename T , typename C >

template<typename InputIterator >

void utility::keys::ClassKeyMap< K, T, C >::assign	(	InputIterator const	beg,
		InputIterator const	end
	)

inline

Iterator assignment.

References utility::keys::ClassKeyMap< K, T, C >::add_key(), utility::keys::ClassKeyMap< K, T, C >::clear(), test.T009_Exceptions::e, utility::keys::ClassKeyMap< K, T, C >::end(), create_a3b_hbs::first, create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ assign() [2/3]

template<typename K , typename T , typename C >

ClassKeyMap& utility::keys::ClassKeyMap< K, T, C >::assign	(	Key const &	key,
		Mapped const &	mapped
	)

inline

Assign a value to an element with a key.

Note: Adds the key to the map if not present; Expands the vector if necessary

References utility::keys::ClassKeyMap< K, T, C >::add_key(), subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ assign() [3/3]

template<typename K , typename T , typename C >

ClassKeyMap& utility::keys::ClassKeyMap< K, T, C >::assign ( Value const & value )

inline

Assign a value to an element.

Note: Adds the key to the map if not present; Expands the vector if necessary

References utility::keys::ClassKeyMap< K, T, C >::add_key(), utility::keys::ClassKeyMap< K, T, C >::v_, and value.

◆ begin() [1/2]

template<typename K , typename T , typename C >

Iterator utility::keys::ClassKeyMap< K, T, C >::begin ( )

inline

Begin iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ begin() [2/2]

template<typename K , typename T , typename C >

ConstIterator utility::keys::ClassKeyMap< K, T, C >::begin ( ) const

inline

Begin iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ capacity()

template<typename K , typename T , typename C >

Size utility::keys::ClassKeyMap< K, T, C >::capacity ( ) const

inline

Capacity.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ clear()

template<typename K , typename T , typename C >

void utility::keys::ClassKeyMap< K, T, C >::clear ( )

inline

Clear the vector.

References utility::keys::ClassKeyMap< K, T, C >::v_.

Referenced by utility::keys::ClassKeyMap< K, T, C >::assign(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ empty()

template<typename K , typename T , typename C >

bool utility::keys::ClassKeyMap< K, T, C >::empty ( ) const

inline

Empty?

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ end() [1/2]

template<typename K , typename T , typename C >

Iterator utility::keys::ClassKeyMap< K, T, C >::end ( )

inline

End iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ end() [2/2]

template<typename K , typename T , typename C >

ConstIterator utility::keys::ClassKeyMap< K, T, C >::end ( ) const

inline

End iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

Referenced by utility::keys::ClassKeyMap< K, T, C >::assign(), and utility::keys::ClassKeyMap< K, T, C >::insert().

◆ find() [1/2]

template<typename K , typename T , typename C >

Iterator utility::keys::ClassKeyMap< K, T, C >::find ( Key const & key )

inline

Iterator to element with a key.

References utility::keys::ClassKeyMap< K, T, C >::active(), subloop_histogram::key, utility::keys::ClassKeyMap< K, T, C >::m(), and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ find() [2/2]

template<typename K , typename T , typename C >

ConstIterator utility::keys::ClassKeyMap< K, T, C >::find ( Key const & key ) const

inline

Iterator to element with a key.

References utility::keys::ClassKeyMap< K, T, C >::active(), subloop_histogram::key, utility::keys::ClassKeyMap< K, T, C >::m(), and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ has()

template<typename K , typename T , typename C >

bool utility::keys::ClassKeyMap< K, T, C >::has ( Key const & key ) const

inline

Is an element with a key present?

References utility::vectorL< L, T, A >::has(), subloop_histogram::key, utility::keys::ClassKeyMap< K, T, C >::m(), and utility::keys::ClassKeyMap< K, T, C >::v_.

Referenced by utility::keys::ClassKeyMap< K, T, C >::active(), and utility::keys::ClassKeyMap< K, T, C >::inactive().

◆ inactive()

template<typename K , typename T , typename C >

static bool utility::keys::ClassKeyMap< K, T, C >::inactive ( Key const & key )

inlinestatic

Is a key inactive?

References utility::keys::ClassKeyMap< K, T, C >::has(), subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::m().

◆ index()

template<typename K , typename T , typename C >

static Index const& utility::keys::ClassKeyMap< K, T, C >::index ( Key const & key )

inlinestatic

Index of a key.

References utility::keys::ClassKeyMap< K, T, C >::active(), debug_assert, subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::m().

◆ insert() [1/2]

template<typename K , typename T , typename C >

template<typename InputIterator >

void utility::keys::ClassKeyMap< K, T, C >::insert	(	InputIterator const	beg,
		InputIterator const	end
	)

inline

Insert elements from iterator range [beg,end)

References utility::keys::ClassKeyMap< K, T, C >::end(), create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::insert().

◆ insert() [2/2]

template<typename K , typename T , typename C >

ClassKeyMap& utility::keys::ClassKeyMap< K, T, C >::insert ( Value const & value )

inline

Insert an element.

Note: Adds the key to the map if not present; Expands the vector if necessary

References utility::keys::ClassKeyMap< K, T, C >::add_key(), utility::keys::ClassKeyMap< K, T, C >::v_, and value.

Referenced by utility::keys::ClassKeyMap< K, T, C >::insert().

◆ m()

template<typename K , typename T , typename C >

static IndexMap& utility::keys::ClassKeyMap< K, T, C >::m ( )

inlinestaticprivate

Index map from keys into v_: Zero => inactive key.

Referenced by utility::keys::ClassKeyMap< K, T, C >::activate(), utility::keys::ClassKeyMap< K, T, C >::activated_index(), utility::keys::ClassKeyMap< K, T, C >::active(), utility::keys::ClassKeyMap< K, T, C >::find(), utility::keys::ClassKeyMap< K, T, C >::has(), utility::keys::ClassKeyMap< K, T, C >::inactive(), utility::keys::ClassKeyMap< K, T, C >::index(), utility::keys::ClassKeyMap< K, T, C >::map_shrink(), and utility::keys::ClassKeyMap< K, T, C >::operator[]().

◆ map_shrink()

template<typename K , typename T , typename C >

static void utility::keys::ClassKeyMap< K, T, C >::map_shrink ( )

inlinestaticprivate

Shrink the index map to remove unused capacity.

References utility::keys::ClassKeyMap< K, T, C >::m(), and utility::vectorL< L, T, A >::shrink().

◆ max_size()

template<typename K , typename T , typename C >

Size utility::keys::ClassKeyMap< K, T, C >::max_size ( ) const

inline

Max size.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator()() [1/3]

template<typename K , typename T , typename C >

Reference utility::keys::ClassKeyMap< K, T, C >::operator() ( Index const & i )

inline

ClassKeyMap( index )

References create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator()() [2/3]

template<typename K , typename T , typename C >

ConstReference utility::keys::ClassKeyMap< K, T, C >::operator() ( Index const & i ) const

inline

ClassKeyMap( index ) const.

References create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator()() [3/3]

template<typename K , typename T , typename C >

MappedReference utility::keys::ClassKeyMap< K, T, C >::operator() ( Key const & key )

inline

ClassKeyMap( key )

Note: Activates the key if inactive; Expands the vector if necessary

References utility::keys::ClassKeyMap< K, T, C >::add_key(), subloop_histogram::key, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator=() [1/2]

template<typename K , typename T , typename C >

ClassKeyMap& utility::keys::ClassKeyMap< K, T, C >::operator= ( ClassKeyMap< K, T, C > const & a )

inline

Copy assignment.

References a, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator=() [2/2]

template<typename K , typename T , typename C >

ClassKeyMap& utility::keys::ClassKeyMap< K, T, C >::operator= ( Mapped const & mapped )

inline

Uniform value assignment to current elements.

References test.T009_Exceptions::e, create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator[]() [1/4]

template<typename K , typename T , typename C >

MappedReference utility::keys::ClassKeyMap< K, T, C >::operator[] ( Index const & i )

inline

ClassKeyMap[ index ].

References create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator[]() [2/4]

template<typename K , typename T , typename C >

MappedConstReference utility::keys::ClassKeyMap< K, T, C >::operator[] ( Index const & i ) const

inline

ClassKeyMap[ index ] const.

References create_a3b_hbs::i, and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator[]() [3/4]

template<typename K , typename T , typename C >

MappedReference utility::keys::ClassKeyMap< K, T, C >::operator[] ( Key const & key )

inline

ClassKeyMap[ key ].

References utility::keys::ClassKeyMap< K, T, C >::active(), debug_assert, subloop_histogram::key, utility::keys::ClassKeyMap< K, T, C >::m(), and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ operator[]() [4/4]

template<typename K , typename T , typename C >

MappedConstReference utility::keys::ClassKeyMap< K, T, C >::operator[] ( Key const & key ) const

inline

ClassKeyMap[ key ] const.

References utility::keys::ClassKeyMap< K, T, C >::active(), debug_assert, subloop_histogram::key, utility::keys::ClassKeyMap< K, T, C >::m(), and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ rbegin() [1/2]

template<typename K , typename T , typename C >

ReverseIterator utility::keys::ClassKeyMap< K, T, C >::rbegin ( )

inline

Begin reverse iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ rbegin() [2/2]

template<typename K , typename T , typename C >

ConstReverseIterator utility::keys::ClassKeyMap< K, T, C >::rbegin ( ) const

inline

Begin reverse iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ rend() [1/2]

template<typename K , typename T , typename C >

ReverseIterator utility::keys::ClassKeyMap< K, T, C >::rend ( )

inline

End reverse iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ rend() [2/2]

template<typename K , typename T , typename C >

ConstReverseIterator utility::keys::ClassKeyMap< K, T, C >::rend ( ) const

inline

End reverse iterator.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ reserve()

template<typename K , typename T , typename C >

void utility::keys::ClassKeyMap< K, T, C >::reserve ( Size const num )

inline

Reserve space for a given number of elements.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ shrink()

template<typename K , typename T , typename C >

void utility::keys::ClassKeyMap< K, T, C >::shrink ( )

inline

Shrink the vector to remove unused capacity.

References utility::vectorL< L, T, A >::shrink(), and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ size()

template<typename K , typename T , typename C >

Size utility::keys::ClassKeyMap< K, T, C >::size ( ) const

inline

Size.

References utility::keys::ClassKeyMap< K, T, C >::v_.

◆ swap()

template<typename K , typename T , typename C >

void utility::keys::ClassKeyMap< K, T, C >::swap ( ClassKeyMap< K, T, C > & a )

inline

swap( ClassKeyMap )

References a, utility::vectorL< L, T, A >::swap(), and utility::keys::ClassKeyMap< K, T, C >::v_.

◆ u()

template<typename K , typename T , typename C >

static Index& utility::keys::ClassKeyMap< K, T, C >::u ( )

inlinestaticprivate

Upper active index of active keys.

Referenced by utility::keys::ClassKeyMap< K, T, C >::activate().

Friends And Related Function Documentation

◆ operator!=

template<typename K , typename T , typename C >

bool operator!=	(	ClassKeyMap< K, T, C > const &	a,
		ClassKeyMap< K, T, C > const &	b
	)

friend

ClassKeyMap != ClassKeyMap.

◆ operator<

template<typename K , typename T , typename C >

bool operator<	(	ClassKeyMap< K, T, C > const &	a,
		ClassKeyMap< K, T, C > const &	b
	)

friend

ClassKeyMap < ClassKeyMap.

◆ operator<=

template<typename K , typename T , typename C >

bool operator<=	(	ClassKeyMap< K, T, C > const &	a,
		ClassKeyMap< K, T, C > const &	b
	)

friend

ClassKeyMap <= ClassKeyMap.

◆ operator==

template<typename K , typename T , typename C >

bool operator==	(	ClassKeyMap< K, T, C > const &	a,
		ClassKeyMap< K, T, C > const &	b
	)

friend

ClassKeyMap == ClassKeyMap.

◆ operator>

template<typename K , typename T , typename C >

bool operator>	(	ClassKeyMap< K, T, C > const &	a,
		ClassKeyMap< K, T, C > const &	b
	)

friend

ClassKeyMap > ClassKeyMap.

◆ operator>=

template<typename K , typename T , typename C >

bool operator>=	(	ClassKeyMap< K, T, C > const &	a,
		ClassKeyMap< K, T, C > const &	b
	)

friend

ClassKeyMap >= ClassKeyMap.

◆ swap

template<typename K , typename T , typename C >

template<typename UK , typename UT , typename UC >

void swap	(	ClassKeyMap< UK, UT, UC > &	a,
		ClassKeyMap< UK, UT, UC > &	b
	)

friend

swap( ClassKeyMap, ClassKeyMap )

Member Data Documentation

◆ v_

template<typename K , typename T , typename C >

Vector utility::keys::ClassKeyMap< K, T, C >::v_

private

Vector of values indexed by a subset of the possible keys.

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

src/utility/keys/ClassKeyMap.fwd.hh
src/utility/keys/ClassKeyMap.hh

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

template<typename K, typename T, typename C> class utility::keys::ClassKeyMap< K, T, C >

Member Typedef Documentation

◆ Allocator

◆ allocator_type

◆ Client

◆ client_type

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ ConstIterator

◆ ConstPointer

◆ ConstReference

◆ ConstReverseIterator

◆ Difference

◆ difference_type

◆ Index

◆ index_type

◆ IndexMap

◆ IndexMapIndex

◆ IndexMapSize

◆ iterator

◆ Iterator

◆ Key

◆ key_type

◆ Mapped

◆ mapped_const_pointer

◆ mapped_const_reference

◆ mapped_pointer

◆ mapped_reference

◆ mapped_type

◆ MappedConstPointer

◆ MappedConstReference

◆ MappedPointer

◆ MappedReference

◆ pointer

◆ Pointer

◆ reference

◆ Reference

◆ reverse_iterator

◆ ReverseIterator

◆ Size

◆ size_type

◆ Value

◆ value_type

◆ Vector

Constructor & Destructor Documentation

◆ ClassKeyMap() [1/3]

◆ ClassKeyMap() [2/3]

◆ ClassKeyMap() [3/3]

◆ ~ClassKeyMap()

Member Function Documentation

◆ activate()

◆ activated_index()

◆ active()

◆ add()

◆ add_key()

◆ assign() [1/3]

◆ assign() [2/3]

◆ assign() [3/3]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ clear()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ find() [1/2]

◆ find() [2/2]

◆ has()

◆ inactive()

template<typename K, typename T, typename C>
class utility::keys::ClassKeyMap< K, T, C >