utility::keys::KeyVector< K, T > Class Template Reference

Keyed-access vector. More...

#include <KeyVector.hh>

Public Types
typedef K	key_type
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 K	Key
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

Public Member Functions
	KeyVector ()=default
	Default constructor. More...
	KeyVector (Size const num)
	Size constructor. More...
	KeyVector (Size const num, Value const &value)
	Uniform value constructor. More...
template<typename InputIterator >
	KeyVector (InputIterator const beg, InputIterator const end)
	Iterator range constructor. More...
	~KeyVector ()=default
	Destructor. More...
KeyVector &	operator= (KeyVector const &a)
	Copy assignment. More...
KeyVector &	operator= (Value const &value)
	Uniform value assignment to elements. More...
KeyVector &	assign (Key const &key, Value const &value)
	Assign a value to an element with a key. More...
void	assign (Size const num, Value const &value)
	Uniform value assignment. More...
template<typename InputIterator >
void	assign (InputIterator const beg, InputIterator const end)
	Iterator assignment. More...
KeyVector &	add (Key const &key)
	Add an element with a key if not present. More...
Iterator	insert (Iterator const pos, Value const &value)
	Insert an element at an iterator position. More...
void	insert (Iterator const pos, Size const num, Value const &value)
	Insert num copies of an element at an iterator position. More...
template<typename InputIterator >
void	insert (Iterator const pos, InputIterator const beg, InputIterator const end)
	Insert elements from iterator range [beg,end) at an iterator position. More...
void	push_back (Value const &value)
	Appends an element. More...
Iterator	erase (Iterator const pos)
	Erase an element at an iterator position. More...
Iterator	erase (Iterator const beg, Iterator const end)
	Erase elements in the iterator range [beg,end) More...
void	pop_back ()
	Removes the last element. More...
void	resize (Size const num)
	Resize: Default construct new elements. More...
void	resize (Size const num, Value const &value)
	Resize: Assign given value to new elements. 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 (KeyVector &a)
	swap( KeyVector ) 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...
ConstReference	front () const
	Front element. More...
Reference	front ()
	Front element. More...
ConstReference	back () const
	Back element. More...
Reference	back ()
	Back element. More...
bool	has (Key const &key) const
	Is an element with a key present? More...
bool	active (Key const &key) const
	Is a key active? More...
bool	inactive (Key const &key) const
	Is a key inactive? 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...
Reference	operator() (Key const &key)
	KeyVector( key ) More...
ConstReference	operator[] (Key const &key) const
	KeyVector[ key ] const. More...
Reference	operator[] (Key const &key)
	KeyVector[ key ]. More...
ConstReference	at (Key const &key) const
	Element at index key: Bounds checked. More...
Reference	at (Key const &key)
	Element at index key: Bounds checked. 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...

Private Types
typedef vector1< T >	Vector

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

Private Attributes
Vector	v_
	Vector of values indexed by keys. More...

Friends
template<typename UK , typename UT >
void	swap (KeyVector< UK, UT > &a, KeyVector< UK, UT > &b)
	swap( KeyVector, KeyVector ) More...
bool	operator== (KeyVector const &a, KeyVector const &b)
	KeyVector == KeyVector. More...
bool	operator!= (KeyVector const &a, KeyVector const &b)
	KeyVector != KeyVector. More...

Detailed Description

template<typename K, typename T>
class utility::keys::KeyVector< K, T >

Keyed-access vector.

Member Typedef Documentation

Allocator

template<typename K , typename T >

typedef Vector::Allocator utility::keys::KeyVector< K, T >::Allocator

allocator_type

template<typename K , typename T >

typedef Vector::allocator_type utility::keys::KeyVector< K, T >::allocator_type

const_iterator

template<typename K , typename T >

typedef Vector::const_iterator utility::keys::KeyVector< K, T >::const_iterator

const_pointer

template<typename K , typename T >

typedef Vector::const_pointer utility::keys::KeyVector< K, T >::const_pointer

const_reference

template<typename K , typename T >

typedef Vector::const_reference utility::keys::KeyVector< K, T >::const_reference

const_reverse_iterator

template<typename K , typename T >

typedef Vector::const_reverse_iterator utility::keys::KeyVector< K, T >::const_reverse_iterator

ConstIterator

template<typename K , typename T >

typedef Vector::ConstIterator utility::keys::KeyVector< K, T >::ConstIterator

ConstPointer

template<typename K , typename T >

typedef Vector::ConstPointer utility::keys::KeyVector< K, T >::ConstPointer

ConstReference

template<typename K , typename T >

typedef Vector::ConstReference utility::keys::KeyVector< K, T >::ConstReference

ConstReverseIterator

template<typename K , typename T >

typedef Vector::ConstReverseIterator utility::keys::KeyVector< K, T >::ConstReverseIterator

Difference

template<typename K , typename T >

typedef Vector::Difference utility::keys::KeyVector< K, T >::Difference

difference_type

template<typename K , typename T >

typedef Vector::difference_type utility::keys::KeyVector< K, T >::difference_type

Index

template<typename K , typename T >

typedef Vector::Index utility::keys::KeyVector< K, T >::Index

index_type

template<typename K , typename T >

typedef Vector::index_type utility::keys::KeyVector< K, T >::index_type

iterator

template<typename K , typename T >

typedef Vector::iterator utility::keys::KeyVector< K, T >::iterator

Iterator

template<typename K , typename T >

typedef Vector::Iterator utility::keys::KeyVector< K, T >::Iterator

Key

template<typename K , typename T >

typedef K utility::keys::KeyVector< K, T >::Key

key_type

template<typename K , typename T >

typedef K utility::keys::KeyVector< K, T >::key_type

pointer

template<typename K , typename T >

typedef Vector::pointer utility::keys::KeyVector< K, T >::pointer

Pointer

template<typename K , typename T >

typedef Vector::Pointer utility::keys::KeyVector< K, T >::Pointer

reference

template<typename K , typename T >

typedef Vector::reference utility::keys::KeyVector< K, T >::reference

Reference

template<typename K , typename T >

typedef Vector::Reference utility::keys::KeyVector< K, T >::Reference

reverse_iterator

template<typename K , typename T >

typedef Vector::reverse_iterator utility::keys::KeyVector< K, T >::reverse_iterator

ReverseIterator

template<typename K , typename T >

typedef Vector::ReverseIterator utility::keys::KeyVector< K, T >::ReverseIterator

Size

template<typename K , typename T >

typedef Vector::Size utility::keys::KeyVector< K, T >::Size

size_type

template<typename K , typename T >

typedef Vector::size_type utility::keys::KeyVector< K, T >::size_type

Value

template<typename K , typename T >

typedef Vector::Value utility::keys::KeyVector< K, T >::Value

value_type

template<typename K , typename T >

typedef Vector::value_type utility::keys::KeyVector< K, T >::value_type

Vector

template<typename K , typename T >

typedef vector1< T > utility::keys::KeyVector< K, T >::Vector

private

Constructor & Destructor Documentation

KeyVector() [1/4]

template<typename K , typename T >

utility::keys::KeyVector< K, T >::KeyVector ( )

inlinedefault

Default constructor.

KeyVector() [2/4]

template<typename K , typename T >

utility::keys::KeyVector< K, T >::KeyVector ( Size const  num )

inlineexplicit

Size constructor.

KeyVector() [3/4]

template<typename K , typename T >

utility::keys::KeyVector< K, T >::KeyVector ( Size const  num, Value const &  value  )

inline

Uniform value constructor.

KeyVector() [4/4]

template<typename K , typename T >

template<typename InputIterator >

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

inline

Iterator range constructor.

~KeyVector()

template<typename K , typename T >

utility::keys::KeyVector< K, T >::~KeyVector ( )

inlinedefault

Destructor.

Member Function Documentation

active()

template<typename K , typename T >

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

inline

Is a key active?

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

Referenced by utility::keys::KeyVector< K, T >::find().

add()

template<typename K , typename T >

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

inline

Add an element with a key if not present.

References utility::keys::KeyVector< K, T >::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 >

Key const& utility::keys::KeyVector< K, T >::add_key ( Key const &  key )

inlineprivate

Add an element with a key if not present and return its key.

References debug_assert, subloop_histogram::key, and utility::keys::KeyVector< K, T >::v_.

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

assign() [1/3]

template<typename K , typename T >

template<typename InputIterator >

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

inline

Iterator assignment.

References utility::keys::KeyVector< K, T >::end(), and utility::keys::KeyVector< K, T >::v_.

assign() [2/3]

template<typename K , typename T >

KeyVector& utility::keys::KeyVector< K, T >::assign ( Key const &  key, Value const &  value  )

inline

Assign a value to an element with a key.

Note

Expands the vector if necessary

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

assign() [3/3]

template<typename K , typename T >

void utility::keys::KeyVector< K, T >::assign ( Size const  num, Value const &  value  )

inline

Uniform value assignment.

References utility::keys::KeyVector< K, T >::v_, and value.

at() [1/2]

template<typename K , typename T >

Reference utility::keys::KeyVector< K, T >::at ( Key const &  key )

inline

Element at index key: Bounds checked.

References utility::vectorL< L, T, A >::at(), subloop_histogram::key, and utility::keys::KeyVector< K, T >::v_.

at() [2/2]

template<typename K , typename T >

ConstReference utility::keys::KeyVector< K, T >::at ( Key const &  key ) const

inline

Element at index key: Bounds checked.

References utility::vectorL< L, T, A >::at(), subloop_histogram::key, and utility::keys::KeyVector< K, T >::v_.

back() [1/2]

template<typename K , typename T >

Reference utility::keys::KeyVector< K, T >::back ( )

inline

Back element.

References debug_assert, and utility::keys::KeyVector< K, T >::v_.

back() [2/2]

template<typename K , typename T >

ConstReference utility::keys::KeyVector< K, T >::back ( ) const

inline

Back element.

References debug_assert, and utility::keys::KeyVector< K, T >::v_.

begin() [1/2]

template<typename K , typename T >

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

inline

Begin iterator.

References utility::keys::KeyVector< K, T >::v_.

begin() [2/2]

template<typename K , typename T >

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

inline

Begin iterator.

References utility::keys::KeyVector< K, T >::v_.

capacity()

template<typename K , typename T >

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

inline

Capacity.

References utility::keys::KeyVector< K, T >::v_.

clear()

template<typename K , typename T >

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

inline

Clear the vector.

References utility::keys::KeyVector< K, T >::v_.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

empty()

template<typename K , typename T >

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

inline

Empty?

References utility::keys::KeyVector< K, T >::v_.

end() [1/2]

template<typename K , typename T >

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

inline

End iterator.

References utility::keys::KeyVector< K, T >::v_.

end() [2/2]

template<typename K , typename T >

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

inline

End iterator.

References utility::keys::KeyVector< K, T >::v_.

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

erase() [1/2]

template<typename K , typename T >

Iterator utility::keys::KeyVector< K, T >::erase ( Iterator const  beg, Iterator const  end  )

inline

Erase elements in the iterator range [beg,end)

References utility::keys::KeyVector< K, T >::end(), and utility::keys::KeyVector< K, T >::v_.

erase() [2/2]

template<typename K , typename T >

Iterator utility::keys::KeyVector< K, T >::erase ( Iterator const  pos )

inline

Erase an element at an iterator position.

References make_symmdef_file_denovo::pos, and utility::keys::KeyVector< K, T >::v_.

find() [1/2]

template<typename K , typename T >

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

inline

Iterator to element with a key.

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

find() [2/2]

template<typename K , typename T >

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

inline

Iterator to element with a key.

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

front() [1/2]

template<typename K , typename T >

Reference utility::keys::KeyVector< K, T >::front ( )

inline

Front element.

References debug_assert, and utility::keys::KeyVector< K, T >::v_.

front() [2/2]

template<typename K , typename T >

ConstReference utility::keys::KeyVector< K, T >::front ( ) const

inline

Front element.

References debug_assert, and utility::keys::KeyVector< K, T >::v_.

has()

template<typename K , typename T >

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

inline

Is an element with a key present?

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

inactive()

template<typename K , typename T >

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

inline

Is a key inactive?

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

insert() [1/3]

template<typename K , typename T >

template<typename InputIterator >

void utility::keys::KeyVector< K, T >::insert ( Iterator const  pos, InputIterator const  beg, InputIterator const  end  )

inline

Insert elements from iterator range [beg,end) at an iterator position.

References utility::keys::KeyVector< K, T >::end(), make_symmdef_file_denovo::pos, and utility::keys::KeyVector< K, T >::v_.

insert() [2/3]

template<typename K , typename T >

void utility::keys::KeyVector< K, T >::insert ( Iterator const  pos, Size const  num, Value const &  value  )

inline

Insert num copies of an element at an iterator position.

References make_symmdef_file_denovo::pos, utility::keys::KeyVector< K, T >::v_, and value.

insert() [3/3]

template<typename K , typename T >

Iterator utility::keys::KeyVector< K, T >::insert ( Iterator const  pos, Value const &  value  )

inline

Insert an element at an iterator position.

References make_symmdef_file_denovo::pos, utility::keys::KeyVector< K, T >::v_, and value.

max_size()

template<typename K , typename T >

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

inline

Max size.

References utility::keys::KeyVector< K, T >::v_.

operator()()

template<typename K , typename T >

Reference utility::keys::KeyVector< K, T >::operator() ( Key const &  key )

inline

KeyVector( key )

Note

Expands the vector if necessary

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

operator=() [1/2]

template<typename K , typename T >

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

inline

Copy assignment.

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

operator=() [2/2]

template<typename K , typename T >

KeyVector& utility::keys::KeyVector< K, T >::operator= ( Value const &  value )

inline

Uniform value assignment to elements.

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

operator[]() [1/2]

template<typename K , typename T >

Reference utility::keys::KeyVector< K, T >::operator[] ( Key const &  key )

inline

KeyVector[ key ].

References subloop_histogram::key, and utility::keys::KeyVector< K, T >::v_.

operator[]() [2/2]

template<typename K , typename T >

ConstReference utility::keys::KeyVector< K, T >::operator[] ( Key const &  key ) const

inline

KeyVector[ key ] const.

References subloop_histogram::key, and utility::keys::KeyVector< K, T >::v_.

pop_back()

template<typename K , typename T >

void utility::keys::KeyVector< K, T >::pop_back ( )

inline

Removes the last element.

References debug_assert, and utility::keys::KeyVector< K, T >::v_.

push_back()

template<typename K , typename T >

void utility::keys::KeyVector< K, T >::push_back ( Value const &  value )

inline

Appends an element.

References utility::keys::KeyVector< K, T >::v_, and value.

rbegin() [1/2]

template<typename K , typename T >

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

inline

Begin reverse iterator.

References utility::keys::KeyVector< K, T >::v_.

rbegin() [2/2]

template<typename K , typename T >

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

inline

Begin reverse iterator.

References utility::keys::KeyVector< K, T >::v_.

rend() [1/2]

template<typename K , typename T >

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

inline

End reverse iterator.

References utility::keys::KeyVector< K, T >::v_.

rend() [2/2]

template<typename K , typename T >

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

inline

End reverse iterator.

References utility::keys::KeyVector< K, T >::v_.

reserve()

template<typename K , typename T >

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

inline

Reserve space for a given number of elements.

References utility::keys::KeyVector< K, T >::v_.

resize() [1/2]

template<typename K , typename T >

void utility::keys::KeyVector< K, T >::resize ( Size const  num )

inline

Resize: Default construct new elements.

References utility::keys::KeyVector< K, T >::v_.

Referenced by PyMOL-Rosetta-relay-client.SecretInputDialog::__init__().

resize() [2/2]

template<typename K , typename T >

void utility::keys::KeyVector< K, T >::resize ( Size const  num, Value const &  value  )

inline

Resize: Assign given value to new elements.

References utility::keys::KeyVector< K, T >::v_, and value.

Referenced by PyMOL-Rosetta-relay-client.SecretInputDialog::__init__().

shrink()

template<typename K , typename T >

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

inline

Shrink the vector to remove unused capacity.

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

size()

template<typename K , typename T >

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

inline

Size.

References utility::keys::KeyVector< K, T >::v_.

swap()

template<typename K , typename T >

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

inline

swap( KeyVector )

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

Friends And Related Function Documentation

operator!=

template<typename K , typename T >

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

friend

KeyVector != KeyVector.

operator==

template<typename K , typename T >

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

friend

KeyVector == KeyVector.

swap

template<typename K , typename T >

template<typename UK , typename UT >

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

friend

swap( KeyVector, KeyVector )

Member Data Documentation

v_

template<typename K , typename T >

Vector utility::keys::KeyVector< K, T >::v_

private

Vector of values indexed by keys.

Referenced by utility::keys::KeyVector< K, T >::active(), utility::keys::KeyVector< K, T >::add_key(), utility::keys::KeyVector< K, T >::assign(), utility::keys::KeyVector< K, T >::at(), utility::keys::KeyVector< K, T >::back(), utility::keys::KeyVector< K, T >::begin(), utility::keys::KeyVector< K, T >::capacity(), utility::keys::KeyVector< K, T >::clear(), utility::keys::KeyVector< K, T >::empty(), utility::keys::KeyVector< K, T >::end(), utility::keys::KeyVector< K, T >::erase(), utility::keys::KeyVector< K, T >::find(), utility::keys::KeyVector< K, T >::front(), utility::keys::KeyVector< K, T >::has(), utility::keys::KeyVector< K, T >::inactive(), utility::keys::KeyVector< K, T >::insert(), utility::keys::KeyVector< K, T >::max_size(), utility::keys::KeyVector< K, T >::operator()(), utility::keys::KeyVector< K, T >::operator=(), utility::keys::KeyVector< K, T >::operator[](), utility::keys::KeyVector< K, T >::pop_back(), utility::keys::KeyVector< K, T >::push_back(), utility::keys::KeyVector< K, T >::rbegin(), utility::keys::KeyVector< K, T >::rend(), utility::keys::KeyVector< K, T >::reserve(), utility::keys::KeyVector< K, T >::resize(), utility::keys::KeyVector< K, T >::shrink(), utility::keys::KeyVector< K, T >::size(), and utility::keys::KeyVector< K, T >::swap().

---

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

• src/utility/keys/KeyVector.fwd.hh
• src/utility/keys/KeyVector.hh