Rosetta: utility::keys::Key3Vector< K > Class Template Reference

Rosetta

3-key meta-key More...

#include <Key3Vector.hh>

Public Types
typedef K	Key

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

	Key3Vector (Key const &key1_a, Key const &key2_a, Key const &key3_a)
	Key constructor. More...

	~Key3Vector ()=default
	Destructor. More...

Key const &	key1 () const
	Key 1. More...

Key &	key1 ()
	Key 1. More...

Key const &	key2 () const
	Key 2. More...

Key &	key2 ()
	Key 2. More...

Key const &	key3 () const
	Key 3. More...

Key &	key3 ()
	Key 3. More...

Key const &	operator[] (int const i) const
	Key3Vector[ i ] const: 0-based index. More...

Key &	operator[] (int const i)
	Key3Vector[ i ]: 0-based index. More...

Key const &	operator() (int const i) const
	Key3Vector( i ) const: 1-based index. More...

Key &	operator() (int const i)
	Key3Vector( i ): 1-based index. More...

Private Attributes
Key	key1_
	Keys. More...

Key	key2_

Key	key3_

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

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

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

Detailed Description

template<typename K>
class utility::keys::Key3Vector< K >

3-key meta-key

Member Typedef Documentation

◆ Key

template<typename K >

typedef K utility::keys::Key3Vector< K >::Key

Constructor & Destructor Documentation

◆ Key3Vector() [1/2]

template<typename K >

utility::keys::Key3Vector< K >::Key3Vector ( )

inlinedefault

Default constructor.

Note: Only works if Key has default constructor

◆ Key3Vector() [2/2]

template<typename K >

utility::keys::Key3Vector< K >::Key3Vector	(	Key const &	key1_a,
		Key const &	key2_a,
		Key const &	key3_a
	)

inline

Key constructor.

◆ ~Key3Vector()

template<typename K >

utility::keys::Key3Vector< K >::~Key3Vector ( )

inlinedefault

Destructor.

Member Function Documentation

◆ key1() [1/2]

template<typename K >

Key& utility::keys::Key3Vector< K >::key1 ( )

inline

Key 1.

References utility::keys::Key3Vector< K >::key1_.

◆ key1() [2/2]

template<typename K >

Key const& utility::keys::Key3Vector< K >::key1 ( ) const

inline

Key 1.

References utility::keys::Key3Vector< K >::key1_.

◆ key2() [1/2]

template<typename K >

Key& utility::keys::Key3Vector< K >::key2 ( )

inline

Key 2.

References utility::keys::Key3Vector< K >::key2_.

◆ key2() [2/2]

template<typename K >

Key const& utility::keys::Key3Vector< K >::key2 ( ) const

inline

Key 2.

References utility::keys::Key3Vector< K >::key2_.

◆ key3() [1/2]

template<typename K >

Key& utility::keys::Key3Vector< K >::key3 ( )

inline

Key 3.

References utility::keys::Key3Vector< K >::key3_.

◆ key3() [2/2]

template<typename K >

Key const& utility::keys::Key3Vector< K >::key3 ( ) const

inline

Key 3.

References utility::keys::Key3Vector< K >::key3_.

◆ operator()() [1/2]

template<typename K >

Key& utility::keys::Key3Vector< K >::operator() ( int const i )

inline

Key3Vector( i ): 1-based index.

References debug_assert, create_a3b_hbs::i, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

◆ operator()() [2/2]

template<typename K >

Key const& utility::keys::Key3Vector< K >::operator() ( int const i ) const

inline

Key3Vector( i ) const: 1-based index.

References debug_assert, create_a3b_hbs::i, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

◆ operator[]() [1/2]

template<typename K >

Key& utility::keys::Key3Vector< K >::operator[] ( int const i )

inline

Key3Vector[ i ]: 0-based index.

References debug_assert, create_a3b_hbs::i, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

◆ operator[]() [2/2]

template<typename K >

Key const& utility::keys::Key3Vector< K >::operator[] ( int const i ) const

inline

Key3Vector[ i ] const: 0-based index.

References debug_assert, create_a3b_hbs::i, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

Friends And Related Function Documentation

◆ operator!=

template<typename K >

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

friend

Key3Vector != Key3Vector.

◆ operator<

template<typename K >

bool operator<	(	Key3Vector< K > const &	a,
		Key3Vector< K > const &	b
	)

friend

Key3Vector < Key3Vector.

Note: Lexicographic (full) ordering => Key3Vector is suitable for use as a map key or set element

◆ operator==

template<typename K >

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

friend

Key3Vector == Key3Vector.

Member Data Documentation

◆ key1_

template<typename K >

Key utility::keys::Key3Vector< K >::key1_

private

Keys.

Referenced by utility::keys::Key3Vector< K >::key1(), utility::keys::Key3Vector< K >::operator()(), and utility::keys::Key3Vector< K >::operator[]().

◆ key2_

template<typename K >

Key utility::keys::Key3Vector< K >::key2_

private

Referenced by utility::keys::Key3Vector< K >::key2(), utility::keys::Key3Vector< K >::operator()(), and utility::keys::Key3Vector< K >::operator[]().

◆ key3_

template<typename K >

Key utility::keys::Key3Vector< K >::key3_

private

Referenced by utility::keys::Key3Vector< K >::key3(), utility::keys::Key3Vector< K >::operator()(), and utility::keys::Key3Vector< K >::operator[]().

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

src/utility/keys/Key3Vector.fwd.hh
src/utility/keys/Key3Vector.hh