L1MuPacking.h

Go to the documentation of this file.

//-------------------------------------------------
//
/* L1MuPacking
 *
 * define abstract packing and three implementations
 *
*/
//
//   $Date: 2008/04/16 23:25:10 $
//   $Revision: 1.4 $
//
//   Original Author :
//   H. Sakulin            HEPHY Vienna
//
//   Migrated to CMSSW:
//   I. Mikulec
//
//--------------------------------------------------


#ifndef CondFormatsL1TObjects_L1MuPacking_h
#define CondFormatsL1TObjects_L1MuPacking_h

#include "CondFormats/Serialization/interface/Serializable.h"

#include "FWCore/MessageLogger/interface/MessageLogger.h"

#include <cstdlib>
#include <limits>

class L1MuPacking {
 public:
  virtual ~L1MuPacking() {};

  virtual int signFromPacked(unsigned packed) const = 0;
  virtual int idxFromPacked(unsigned packed) const = 0;
  virtual unsigned packedFromIdx(int idx) const = 0;

 COND_SERIALIZABLE;
};

template<unsigned int Bits> 
class L1MuUnsignedPacking : public L1MuPacking{
 public:
  int signFromPacked(unsigned packed) const override { return 0;}; 
  int idxFromPacked(unsigned packed) const override { return (int) packed;};
  unsigned packedFromIdx(int idx) const override { 
    if (idx >= (1 << Bits) ) edm::LogWarning("ScaleRangeViolation") 
                  << "L1MuUnignedPacking::packedFromIdx: warning value " << idx 
          << "exceeds " << Bits << "-bit range !!!";        
    return (unsigned) idx;
  };
};

class L1MuUnsignedPackingGeneric : public L1MuPacking{
 public:
  static int signFromPacked(unsigned packed, unsigned int nbits) { return 0;}; 
  static int idxFromPacked(unsigned packed, unsigned int nbits) { return (int) packed;};
  static unsigned packedFromIdx(int idx, unsigned int nbits) { 
    if (idx >= (1 << nbits) ) edm::LogWarning("ScaleRangeViolation") 
                  << "L1MuUnignedPacking::packedFromIdx: warning value " << idx 
          << "exceeds " << nbits << "-bit range !!!";        
    return (unsigned) idx;
  };
};

template<unsigned int Bits>
class L1MuSignedPacking : public L1MuPacking {
 public:
  int signFromPacked(unsigned packed) const override { return packed & (1 << (Bits-1)) ? 1 : 0;};

  int idxFromPacked(unsigned packed) const override { return packed & (1 << (Bits-1)) ? (packed - (1 << Bits) ) : packed;};
  unsigned packedFromIdx(int idx) const override { 
    unsigned maxabs = 1U << (Bits-1) ;
    if (idx < -(int)maxabs && idx >= (int)maxabs) edm::LogWarning("ScaleRangeViolation") 
                                                       << "L1MuSignedPacking::packedFromIdx: warning value " << idx 
                               << "exceeds " << Bits << "-bit range !!!";    
    return  ~(std::numeric_limits<unsigned>::max() << Bits) & (idx < 0 ? (1U << Bits) + idx : idx);
  };
};

class L1MuSignedPackingGeneric : public L1MuPacking {
 public:
  static int signFromPacked(unsigned packed, unsigned int nbits) { return packed & (1 << (nbits-1)) ? 1 : 0;};

  static int idxFromPacked(unsigned packed, unsigned int nbits) { return packed & (1 << (nbits-1)) ? (packed - (1 << nbits) ) : packed;};
  static unsigned packedFromIdx(int idx, unsigned int nbits) { 
    unsigned maxabs = 1U << (nbits-1) ;
    if (idx < -(int)maxabs && idx >= (int)maxabs) edm::LogWarning("ScaleRangeViolation") 
                                                       << "L1MuSignedPacking::packedFromIdx: warning value " << idx 
                               << "exceeds " << nbits << "-bit range !!!";    
    return  ~(std::numeric_limits<unsigned>::max() << nbits) & (idx < 0 ? (1U << nbits) + idx : idx);
  };
};

class L1MuPseudoSignedPacking : public L1MuPacking {
 public:
      L1MuPseudoSignedPacking() {}
  ~L1MuPseudoSignedPacking() override {};
  L1MuPseudoSignedPacking(unsigned int nbits) : m_nbits(nbits) {};

  int signFromPacked(unsigned packed) const override { return ( packed & (1 << (m_nbits-1)) ) ? 1 : 0;};

  int idxFromPacked(unsigned packed) const override {
    unsigned mask = (1 << (m_nbits-1)) - 1; // for lower bits
    int absidx = (int) ( packed & mask );
    unsigned psmask = (1 << (m_nbits-1) );
    return absidx * ( ( (packed & psmask) == psmask ) ? -1 : 1 ); // pseudo sign==1 is negative
  };  
  unsigned packedFromIdx(int idx) const override {
    unsigned packed = std::abs(idx);
    unsigned maxabs = (1 << (m_nbits-1)) -1;
    if (packed > maxabs) edm::LogWarning("ScaleRangeViolation") 
                              << "L1MuPseudoSignedPacking::packedFromIdx: warning value " << idx 
                  << "exceeds " << m_nbits << "-bit range !!!";
    if (idx < 0) packed |= 1 << (m_nbits-1);
    return  packed;
  }

  virtual unsigned packedFromIdx(int idx, int sig) const {
    unsigned packed = std::abs(idx);
    unsigned maxabs = (1 << (m_nbits-1)) -1;
    if (packed > maxabs) edm::LogWarning("ScaleRangeViolation") 
                              << "L1MuPseudoSignedPacking::packedFromIdx: warning value " << idx 
                  << "exceeds " << m_nbits << "-bit range !!!";
    if (sig==1) packed |= 1 << (m_nbits-1); // sig==1 is negative
    return  packed;
  }

 private:
  unsigned int m_nbits;

 COND_SERIALIZABLE;
};

#endif