IdentifierHashTable.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONCALIBIDENTIFIER_IDENTIFIERHASHTABLE_H
#define MUONCALIBIDENTIFIER_IDENTIFIERHASHTABLE_H
 
/***************************************************************************
 * Identifier utility
 * -----------------------------------------
 *
 * Author       : Martin Woudstra
 * Creation Date: 28 April 2004
 * Last Update  : 07 May 2004
 ***************************************************************************/
 
#include "MuonCalibIdentifier/IdentifierToHash.h"
#include "GaudiKernel/MsgStream.h"
#include "AthenaKernel/getMessageSvc.h"
 
#include <iostream>
#include <sstream>
#include <limits.h>
 
template <class T>
class IdentifierHashTable {
public:
   //
   // nested types
   //
   typedef typename T::IdentifierType IdType;
   typedef typename T::HashType HashType;
   static HashType defaultHashValue() {
      return IdentifierToHash<T>::defaultHashValue();
   }
   //
   // Member functions
   //
   IdentifierHashTable();
   explicit IdentifierHashTable( const T& idFields );
   void clear();
   unsigned int size() const;
   bool checkValidity() const;
   HashType addEntry( const IdType& id );
   HashType getHash( const IdType& id ) const;
   IdType getIdentifier( const HashType& hash ) const;
   void dump( std::ostream& os = std::cout ) const;
   std::string dumpToString() const;
private:
   IdentifierToHash<T> m_idToHash;
   std::vector<IdType> m_hashToId;
};
 
template <class T>
inline IdentifierHashTable<T>::IdentifierHashTable()
{}
 
template <class T>
inline IdentifierHashTable<T>::IdentifierHashTable( const T& idFields )
   : m_idToHash(idFields)
{}
 
template <class T>
typename IdentifierHashTable<T>::HashType
IdentifierHashTable<T>::addEntry( const typename IdentifierHashTable<T>::IdType& id ) {
#ifdef IDENTIFIERHASHTABLE_DEBUG
   MsgStream log(Athena::getMessageSvc(),"IdentifierHashTable");
   log<<MSG::DEBUG<<"IdentifierHashTable<T>::addEntry(0x" << std::hex << id << std::dec << ")"<<endmsg;
#endif
   if ( !T::isValid( id ) ) {
#ifdef IDENTIFIERHASHTABLE_DEBUG
   log<<MSG::DEBUG<<": id is invalid. Nothing added."<<endmsg;
#endif
      return defaultHashValue();
   }
#ifdef IDENTIFIERHASHTABLE_DEBUG
   log<<MSG::DEBUG<<"::IdToHashTable"<<endmsg;
#endif
   HashType theHash( m_hashToId.size() );
   if ( !m_idToHash.addEntry( id, theHash ) ) {
#ifdef IDENTIFIERHASHTABLE_DEBUG
   log<<MSG::DEBUG<<" WARNING: could not add to table"<<endmsg;
#endif
      return defaultHashValue();
   } else {
      m_hashToId.push_back( id );
#ifdef IDENTIFIERHASHTABLE_DEBUG
   log<<MSG::DEBUG<<" ADDED at hash=" << theHash<<endmsg;
#endif
   }
   
   return theHash;
}
 
template <class T>
inline typename IdentifierHashTable<T>::HashType
IdentifierHashTable<T>::getHash( const typename IdentifierHashTable<T>::IdType& id ) const {
   return m_idToHash.getHash( id );
}
 
template <class T>
inline typename IdentifierHashTable<T>::IdType
IdentifierHashTable<T>::getIdentifier( const typename IdentifierHashTable<T>::HashType& hash ) const {
   unsigned int idx = hash;
   if ( idx >= m_hashToId.size() ) return IdType();
   return m_hashToId[ idx ];
}
 
template <class T>
inline void IdentifierHashTable<T>::clear() {
   m_idToHash.clear();
   m_hashToId.clear();
}
 
template <class T>
inline unsigned int IdentifierHashTable<T>::size() const {
   return m_hashToId.size();
}
 
template <class T>
bool IdentifierHashTable<T>::checkValidity() const {
   // check that both tables are same size
   unsigned int idToHashSize = m_idToHash.size();
   if ( idToHashSize != m_hashToId.size() ) {
      MsgStream log(Athena::getMessageSvc(),"IdentifierHashTable");
      log<<MSG::WARNING<<"IdentifierHashTable<T>::checkValidity() idToHash size (" << idToHashSize << ") not equal to hashToId size (" << m_hashToId.size() << ")"<<endmsg;
      return false;
   }
   // check that table is non-empty
   if ( !m_hashToId.size() ) {
      MsgStream log(Athena::getMessageSvc(),"IdentifierHashTable");
      log<<MSG::WARNING<<"IdentifierHashTable<T>::checkValidity() Table is empty."<<endmsg;
      return false;
   }
#ifdef IDENTIFIERHASHTABLE_DEBUG
   MsgStream log(Athena::getMessageSvc(),"IdentifierHashTable");
#endif
   // check that tables are each other's inverse
   unsigned int nErrors = 0;
   for ( unsigned int i = 0; i < m_hashToId.size(); ++i ) {
      HashType tryHash(i);
      IdType id = getIdentifier( tryHash );
      HashType gotHash = getHash( id );
      if ( gotHash != tryHash ) {
#ifndef IDENTIFIERHASHTABLE_DEBUG
         MsgStream log(Athena::getMessageSvc(),"IdentifierHashTable");
#endif
         log<<MSG::WARNING<<"IdentifierHashTable<T>::checkValidity() getIdentifier(" << tryHash << ")=0x" << std::hex << id << std::dec << " whereas getHash(" << std::hex << id << std::dec << ")=" << gotHash<<endmsg;
     ++nErrors;
      } else {
#ifdef IDENTIFIERHASHTABLE_DEBUG
      log<<MSG::DEBUG<<"hash=" << i << " <--> id=0x" << std::hex << id << std::dec << ": OK" <<endmsg;
#endif
      }
   }
#ifdef IDENTIFIERHASHTABLE_DEBUG
   if ( nErrors ) {
      log<<MSG::WARNING<<"IdentifierHashTable<T>::checkValidity() table contains " << nErrors << " errors." << endmsg;
   } else {
      log<<MSG::DEBUG<<"IdentifierHashTable<T>::checkValidity(): table OK" << endmsg;
   }
#endif
   
   if ( nErrors ) return false;
   
   // if we get here, everything is OK!
   return true;
}
 
template <class T>
void IdentifierHashTable<T>::dump( std::ostream& os ) const {
   int n = size();
   for ( int i = 0; i < n; ++i ) {
      HashType iHash(i);
      IdType id = getIdentifier( iHash );
      os << "ID=0x" << std::hex << id << std::dec << " fields";
      os << m_idToHash.dumpOneEntryToString( id ) << "\n";
   }
   int nTotal = m_idToHash.totalSize();
   os << "IdentifierHashTable has " << n << " valid entries and "
      << nTotal - n << " wasted entries" << std::endl;
}
 
template <class T>
inline std::string IdentifierHashTable<T>::dumpToString() const {
   std::ostringstream oss;
   dump( oss );
   return oss.str();
}
 
#endif // MUONCALIBIDENTIFIER_IDENTIFIERHASHTABLE_H