#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/StringKey.h>

Collaboration diagram for Gaudi::StringKey:

Public Member Functions
	StringKey (const char *key="")
	constructor from plain C-string, perform hashing More...

	StringKey (std::string key)
	constructor from std::string, perform hashing More...

const std::string &	str () const
	the actual string More...

	operator const std::string & () const
	implicit cast to std::string More...

bool	empty () const
	empty key? More...

bool	operator! () const
	empty key? More...

std::size_t	__hash__ () const
	the actual access to the hash More...

const std::string &	__str__ () const
	the representation of the object More...

std::string	__repr__ () const
	the representation of the object More...

bool	__eq__ (const StringKey &right) const
	equality operator for python More...

bool	__eq__ (std::string_view right) const
	equality operators for python More...

bool	__neq__ (const StringKey &right) const
	non-equality operator for python More...

bool	__neq__ (const std::string_view right) const
	non-equality operator for python More...

std::string	toString () const
	string representation (for properties) More...

Private Attributes
std::string	m_str
	the actual string: More...

std::size_t	m_hash
	the hash: More...

Friends
bool	operator== (const StringKey &lhs, const StringKey &rhs)
	equality Key for efficiency reason compare the hash-values first More...

bool	operator== (const StringKey &lhs, const std::string &rhs)
	equality, without hashing string rely on the native string equality More...

bool	operator== (const std::string &lhs, const StringKey &rhs)

bool	operator== (const StringKey &lhs, std::string_view rhs)

bool	operator== (std::string_view lhs, const StringKey &rhs)

bool	operator!= (const StringKey &lhs, const StringKey &rhs)
	non equality Key More...

bool	operator!= (const StringKey &lhs, std::string_view rhs)
	non-equality string More...

bool	operator!= (const StringKey &lhs, const std::string &rhs)

bool	operator!= (std::string_view lhs, const StringKey &rhs)

bool	operator!= (const std::string &lhs, const StringKey &rhs)

bool	operator< (const StringKey &lhs, const StringKey &rhs)
	less key It can be used as a key for std::map, e.g. More...

bool	operator> (const StringKey &lhs, const StringKey &rhs)
	greater key More...

bool	operator<= (const StringKey &lhs, const StringKey &rhs)
	less or equal key More...

bool	operator>= (const StringKey &lhs, const StringKey &rhs)
	greater or equal key More...

Detailed Description

The helper class to represent the efficient "key" for access. Essentially it is a bit modified version ("boost-free") of the original class stringKey by Gerhard Raven, which is heavily used now in HLT

Attention: NEVER use the actual hash value for anything stored in files, as it is not guaranteed that the hashing scheme will remain the same.

Author: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-04-08

Definition at line 35 of file StringKey.h.

Constructor & Destructor Documentation

◆ StringKey() [1/2]

Gaudi::StringKey::StringKey ( const char * key = "" )

inline

constructor from plain C-string, perform hashing

Definition at line 38 of file StringKey.h.

38 : StringKey{ std::string{ key } } {}

◆ StringKey() [2/2]

Gaudi::StringKey::StringKey ( std::string key )

constructor from std::string, perform hashing

Definition at line 22 of file StringKey.cpp.

     : m_str( std::move( key ) )
     , m_hash( std::hash<std::string>()( m_str ) ) // NB! hashing here!!!
 {}

Member Function Documentation

◆ eq() [1/2]

bool Gaudi::StringKey::__eq__ ( const StringKey & right ) const

equality operator for python

Definition at line 29 of file StringKey.cpp.

29 { return *this == right; }

◆ eq() [2/2]

bool Gaudi::StringKey::__eq__ ( std::string_view right ) const

equality operators for python

Definition at line 30 of file StringKey.cpp.

30 { return *this == right; }

◆ hash()

std::size_t Gaudi::StringKey::__hash__ ( ) const

inline

the actual access to the hash

Attention

NEVER use the actual hash value for anything stored in files, as it is not guaranteed that the hashing scheme will remain the same. The two reason for this function are:

transparent usage of this object for hashmap-like containers
Python @reutrn the actual hash value

Definition at line 117 of file StringKey.h.

117 { return m_hash; }

◆ neq() [1/2]

bool Gaudi::StringKey::__neq__ ( const std::string_view right ) const

non-equality operator for python

Definition at line 32 of file StringKey.cpp.

32 { return *this != right; }

◆ neq() [2/2]

bool Gaudi::StringKey::__neq__ ( const StringKey & right ) const

non-equality operator for python

Definition at line 31 of file StringKey.cpp.

31 { return *this != right; }

◆ repr()

std::string Gaudi::StringKey::__repr__ ( ) const

the representation of the object

Definition at line 28 of file StringKey.cpp.

28 { return toString(); }

◆ str()

const std::string & Gaudi::StringKey::__str__ ( ) const

the representation of the object

Definition at line 27 of file StringKey.cpp.

27 { return m_str; }

◆ empty()

bool Gaudi::StringKey::empty ( ) const

inline

empty key?

Definition at line 48 of file StringKey.h.

48 { return m_str.empty(); }

◆ operator const std::string &()

Gaudi::StringKey::operator const std::string & ( ) const

inline

implicit cast to std::string

Definition at line 46 of file StringKey.h.

46 { return str(); }

◆ operator!()

bool Gaudi::StringKey::operator! ( ) const

inline

empty key?

Definition at line 50 of file StringKey.h.

50 { return empty(); }

◆ str()

const std::string& Gaudi::StringKey::str ( ) const

inline

the actual string

Definition at line 44 of file StringKey.h.

44 { return m_str; }

◆ toString()

std::string Gaudi::StringKey::toString ( ) const

string representation (for properties)

Definition at line 26 of file StringKey.cpp.

26 { return Gaudi::Utils::toString( m_str ); }

Friends And Related Function Documentation

◆ operator!= [1/5]

bool operator!=	(	const std::string &	lhs,
		const StringKey &	rhs
	)

friend

Definition at line 74 of file StringKey.h.

74 { return !( lhs == rhs ); }

◆ operator!= [2/5]

bool operator!=	(	const StringKey &	lhs,
		const std::string &	rhs
	)

friend

Definition at line 72 of file StringKey.h.

72 { return !( lhs == rhs ); }

◆ operator!= [3/5]

bool operator!=	(	const StringKey &	lhs,
		const StringKey &	rhs
	)

friend

non equality Key

Definition at line 69 of file StringKey.h.

69 { return !( lhs == rhs ); }

◆ operator!= [4/5]

bool operator!=	(	const StringKey &	lhs,
		std::string_view	rhs
	)

friend

non-equality string

Definition at line 71 of file StringKey.h.

71 { return !( lhs == rhs ); }

◆ operator!= [5/5]

bool operator!=	(	std::string_view	lhs,
		const StringKey &	rhs
	)

friend

Definition at line 73 of file StringKey.h.

73 { return !( lhs == rhs ); }

◆ operator<

bool operator<	(	const StringKey &	lhs,
		const StringKey &	rhs
	)

friend

less key It can be used as a key for std::map, e.g.

std::map<StringKey,double> Note that with such maps one can gain if using prehashed key:

 typedef std::map<StringKey,double> MAP ;
 
 const StringKey& key = ...  ;
 
 const MAP& m = ... ;
 
 // EFFICIENT:
MAP::const_iterator i1 = m.find ( key ) ;
 
// CAN BE VERY INEFICIENT:
MAP::const_iterator i2 = m_find( "SomeLongKey,_e.g._TES_Locaiton" );

Definition at line 97 of file StringKey.h.

                                                                         {
       return lhs.m_hash == rhs.m_hash ? lhs.m_str < rhs.m_str : lhs.m_hash < rhs.m_hash;
     }

◆ operator<=

bool operator<=	(	const StringKey &	lhs,
		const StringKey &	rhs
	)

friend

less or equal key

Definition at line 103 of file StringKey.h.

103 { return !( lhs > rhs ); }

◆ operator== [1/5]

bool operator==	(	const std::string &	lhs,
		const StringKey &	rhs
	)

friend

Definition at line 63 of file StringKey.h.

63 { return rhs == lhs; }

◆ operator== [2/5]

bool operator==	(	const StringKey &	lhs,
		const std::string &	rhs
	)

friend

equality, without hashing string rely on the native string equality

Definition at line 62 of file StringKey.h.

62 { return lhs.m_str == rhs; }

◆ operator== [3/5]

bool operator==	(	const StringKey &	lhs,
		const StringKey &	rhs
	)

friend

equality Key for efficiency reason compare the hash-values first

Definition at line 56 of file StringKey.h.

                                                                          {
       return lhs.m_hash == rhs.m_hash && lhs.m_str == rhs.m_str;
     }

◆ operator== [4/5]

bool operator==	(	const StringKey &	lhs,
		std::string_view	rhs
	)

friend

Definition at line 64 of file StringKey.h.

64 { return lhs.m_str == rhs; }

◆ operator== [5/5]

bool operator==	(	std::string_view	lhs,
		const StringKey &	rhs
	)

friend

Definition at line 65 of file StringKey.h.

65 { return rhs == lhs; }

◆ operator>

bool operator>	(	const StringKey &	lhs,
		const StringKey &	rhs
	)

friend

greater key

Definition at line 101 of file StringKey.h.

101 { return rhs < lhs; }

◆ operator>=

bool operator>=	(	const StringKey &	lhs,
		const StringKey &	rhs
	)

friend

greater or equal key

Definition at line 105 of file StringKey.h.

105 { return !( lhs < rhs ); }

Member Data Documentation

◆ m_hash

std::size_t Gaudi::StringKey::m_hash

private

the hash:

Definition at line 138 of file StringKey.h.

◆ m_str

std::string Gaudi::StringKey::m_str

private

the actual string:

Definition at line 136 of file StringKey.h.

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

GaudiKernel/include/GaudiKernel/StringKey.h
GaudiKernel/src/Lib/StringKey.cpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ StringKey() [1/2]

◆ StringKey() [2/2]

Member Function Documentation

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __hash__()

◆ __neq__() [1/2]

◆ __neq__() [2/2]

◆ __repr__()

◆ __str__()

◆ empty()

◆ operator const std::string &()

◆ operator!()

◆ str()

◆ toString()

Friends And Related Function Documentation

◆ operator!= [1/5]

◆ operator!= [2/5]

◆ operator!= [3/5]

◆ operator!= [4/5]

◆ operator!= [5/5]

◆ operator<

◆ operator<=

◆ operator== [1/5]

◆ operator== [2/5]

◆ operator== [3/5]

◆ operator== [4/5]

◆ operator== [5/5]

◆ operator>

◆ operator>=

Member Data Documentation

◆ m_hash

◆ m_str

◆ eq() [1/2]

◆ eq() [2/2]

◆ hash()

◆ neq() [1/2]

◆ neq() [2/2]

◆ repr()

◆ str()