GaudiHistoID.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIALG_GAUDIHISTOID_H
#define GAUDIALG_GAUDIHISTOID_H 1
// ============================================================================
// Include files
// ============================================================================
// STD&STL
// ============================================================================
#include <string>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/Hash.h"
#include "GaudiKernel/Kernel.h"
// ============================================================================
/*  @file
 *
 *  Header file for class GaudiAlg::ID
 *
 *  @author Chris Jones   Christopher.Rob.Jones@cern.ch
 *  @author Vanya BELYAEV Ivan.Belyaev@itep.ru
 *  @date   2004-01-23
 */
// ============================================================================
// ============================================================================
namespace GaudiAlg {
  // ==========================================================================
  class GAUDI_API ID {
  public:
    // ========================================================================
    typedef int NumericID;
    typedef std::string LiteralID;
    // ========================================================================
  public:
    // ========================================================================
    ID( const NumericID id = -1 ) : m_nID( id ), m_hash( boost::hash_value( id ) ) {}
    ID( LiteralID&& id ) : m_aID( std::move( id ) ), m_hash( boost::hash_value( m_aID ) ) {}
    ID( const LiteralID& id ) : m_aID( id ), m_hash( boost::hash_value( m_aID ) ) {}
    ID( const char* id ) : m_aID( id ), m_hash( boost::hash_value( m_aID ) ) {}
    ~ID() = default;
    inline bool numeric() const noexcept { return -1 != m_nID; }
    inline bool literal() const noexcept { return !m_aID.empty(); }
    inline bool undefined() const noexcept { return !numeric() && !literal(); }
    inline const LiteralID& literalID() const noexcept { return m_aID; }
    inline NumericID numericID() const noexcept { return m_nID; }
    GAUDI_API LiteralID idAsString() const;
    operator std::string() const { return idAsString(); }
    inline bool operator==( const ID& id ) const noexcept {
      return hash() != id.hash()         ? false
             : numeric() && id.numeric() ? id.numericID() == numericID()
             : literal() && id.literal() ? id.literalID() == literalID()
                                         : idAsString() == id.idAsString();
    }
    inline bool operator!=( const ID& id ) const { return !( *this == id ); }
    inline bool operator<( const ID& id ) const noexcept {
      return
          // hash () < id.hash () ? true  :
          // hash () > id.hash () ? false :
          numeric() && id.numeric()   ? numericID() < id.numericID()
          : literal() && id.literal() ? literalID() < id.literalID()
                                      : idAsString() < id.idAsString();
    }
    // ========================================================================
    GAUDI_API std::ostream& fillStream( std::ostream& s ) const;
    // ========================================================================
  public:
    // ========================================================================
    bool operator!() const noexcept { return undefined(); }
    // ========================================================================
  public:
    // ========================================================================
    inline size_t hash() const noexcept { return m_hash; }
    inline size_t __hash__() const noexcept { return hash(); }
    // ========================================================================
  private:
    // ========================================================================
    NumericID m_nID{ -1 }; //       Internal numeric ID
    LiteralID m_aID; // Internal alpha-numeric ID
    // ========================================================================
  private:
    // ========================================================================
    size_t m_hash{ 0 }; // the hash value of ID
    // ========================================================================
  };
  // ==========================================================================
  inline std::ostream& operator<<( std::ostream& str, const GaudiAlg::ID& id ) { return id.fillStream( str ); }
  // ==========================================================================
} //                                                  end of namespace GaudiAlg
// ============================================================================
namespace GaudiUtils {
  // ==========================================================================
  template <>
  inline size_t Hash<GaudiAlg::ID>::operator()( const GaudiAlg::ID& key ) const {
    return key.hash();
  }
  // ==========================================================================
} //                                                end of namespace GaudiUtils
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIALG_GAUDIHISTOID_H