/data/git/CMSSW_5_3_11_patch5/src/L1Trigger/GlobalMuonTrigger/src/L1MuGMTLUT.h

Go to the documentation of this file.

//-------------------------------------------------
//
//
//   $Date: 2012/02/10 14:19:28 $
//   $Revision: 1.5 $
//
//   Author :
//   H. Sakulin            HEPHY Vienna
//
//   Migrated to CMSSW:
//   I. Mikulec
//
//--------------------------------------------------
#ifndef L1TriggerGlobalMuonTrigger_L1MuGMTLUT_h
#define L1TriggerGlobalMuonTrigger_L1MuGMTLUT_h

//---------------
// C++ Headers --
//---------------

#include <vector>
#include <iostream>
//#include <sstream>
#include <string>
#include <stdlib.h>
#include "stdio.h"

//----------------------
// Base Class Headers --
//----------------------
class L1MuGMTLUTConverter;

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------
#include <L1Trigger/GlobalMuonTrigger/src/L1MuGMTLUTHelpers.h>


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


//              ---------------------
//              -- Class Interface --
//              ---------------------

class L1MuGMTLUT {

  public:  
    typedef std::pair<std::string, unsigned> port;


    L1MuGMTLUT() : m_initialized(0), m_NLUTS(0), m_UseLookupFunction(true), m_saveFlag(false) {};

    L1MuGMTLUT(const char* name, 
               const std::vector<std::string>&  instances, 
               const std::vector<port>& in_widths, 
               const std::vector<port>& out_widths, 
               unsigned vme_addr_width=0, bool distrRAM=false) : m_initialized(0), m_NLUTS(0), m_UseLookupFunction(true), m_saveFlag(false) {
      Init (name, instances, in_widths, out_widths, vme_addr_width, distrRAM); 
      };

    L1MuGMTLUT(const char* name, 
               const std::string& instances, 
               const std::string& inputs, 
               const std::string& outputs, 
               unsigned vme_addr_width=0, bool distrRAM=false) : m_initialized(0), m_NLUTS(0), m_UseLookupFunction(true), m_saveFlag(false) {
      Init (name, L1MuGMTLUTHelpers::Tokenizer(" ",instances), PortDecoder(inputs), PortDecoder(outputs), 
            vme_addr_width, distrRAM); 
      };

    virtual ~L1MuGMTLUT();

    inline unsigned LookupPacked (int idx, unsigned ) const;

    inline unsigned LookupPacked (int idx, const std::vector<unsigned>& address) const { 
      return LookupPacked (idx, vec2u ( address, m_Inputs ) ); };

    inline std::vector<unsigned> Lookup (int idx, const std::vector<unsigned>& address) const { 
      return Lookup (idx, vec2u ( address, m_Inputs ) ); };

    inline std::vector<unsigned> Lookup (int idx, unsigned address) const {
      return u2vec ( LookupPacked(idx, address), m_Outputs );
    };

    
    
    void Load (const char* path);
    
    void Save (const char* path);    

    virtual unsigned LookupFunctionPacked (int idx, unsigned address) const { return 0; };

    void MakeSubClass (const char* fname = "", const char* template_file_h = "../interface/L1MuGMTLUT_SubClass.h_template",
                       const char* template_file_cc = "../interface/L1MuGMTLUT_SubClass.cc_template");

    std::string Name() {return m_name;};

    friend class L1MuGMTLUTConverter;

    int numberOfInstances() { return m_NLUTS; };

  protected:

    void Init(const char* name, const std::vector<std::string>& instances, 
              const std::vector<port>& in_widths, const std::vector<port>& out_widths, 
              unsigned vme_addr_width=0, bool distrRAM=false);

    inline unsigned vec2u (const std::vector <unsigned>& vec, const std::vector<port>& widths) const;

    inline std::vector<unsigned> u2vec (unsigned value, const std::vector<port>& widths) const;

    void Set (int idx, unsigned address, unsigned value);  

    class PortDecoder : public std::vector<port> { 
      typedef std::vector<port> base;
      public:
      PortDecoder(const std::vector<port> &pt) : base(pt) {};

      PortDecoder(const std::string& input){
        // decode std::string of style "phi(2) eta(4)"
        L1MuGMTLUTHelpers::Tokenizer tok(" ", input);
        for (unsigned int i=0;i<tok.size(); i++) {
          size_type obrace=tok[i].find("("), cbrace=tok[i].find(")");
          if (obrace != std::string::npos && cbrace != std::string::npos) 
            push_back( port ( tok[i].substr(0,obrace), (unsigned) atoi (tok[i].substr(obrace+1,cbrace-obrace-1).c_str() ) ) );
          else 
            edm::LogWarning("LUTMismatch") << "L1MuGMTLUT::PortDecoder: error decoding port " << tok[i]; 
        }
      };
      std::string str() {
        std::string temp;
        for  (unsigned int i=0; i<size();i++) {
          // ostd::stringstream os; os << (*this)[i].second << ends;
          //      temp += (*this)[i].first + "(" + std::string( os.str() ) + ")";
          
          char buf[100]; sprintf(buf,"(%d)",(*this)[i].second);
          temp += (*this)[i].first + std::string(buf);

          if (i!=size()-1) temp += " ";
        }
        return temp;
      };
      
    private:
    };

    bool m_initialized;
    int m_NLUTS; 
    bool m_UseLookupFunction;
    std::vector <std::string> m_InstNames;
    std::vector <std::vector <unsigned> > m_Contents;
    std::vector <port> m_Inputs;                  // first port in vector is most significant bits
    std::vector <port> m_Outputs;
    unsigned m_TotalInWidth;
    unsigned m_TotalOutWidth;
    unsigned m_vme_addr_width;
    bool m_distrRAM;
    std::string m_name;
    bool m_saveFlag;
    unsigned m_GeneralLUTVersion;
};

//--------------------------------------------------------------------------------

unsigned L1MuGMTLUT::vec2u (const std::vector <unsigned>& vec, const std::vector<port>& widths) const{
  if (vec.size() != widths.size()) {
    edm::LogWarning("LUTMismatch") << "Error in L1MuGMTLUT::vec2u: number of LUT inputs/outputs does not match definition";
    return (0);
  }
  
  unsigned value = 0;
  unsigned start_ofs=0;

  for (int i=vec.size()-1; i>=0; i--) {
    if ( vec[i] >= (unsigned) (1 << widths[i].second) ) {
      edm::LogWarning("LUTMismatch") << "Error in L1MuGMTLUT::vec2u: LUT input/output number " << i 
           << " exceeds range (0 to " << ( (1 << widths[i].second) -1 ) << ")." 
          ;
    }
    else
      value |= vec[i] << start_ofs;
    start_ofs += widths[i].second;
  }
  
  return (value);
}

//--------------------------------------------------------------------------------

std::vector <unsigned> L1MuGMTLUT::u2vec (unsigned value, const std::vector<port>& widths) const {
  std::vector<unsigned> output( widths.size(), 0);
 
  unsigned start_ofs=0;

  for (int i=widths.size()-1; i>=0; i--) {
    int mask = ( (1 << widths[i].second) - 1 ) << start_ofs;
    output[i] = ( value & mask ) >> start_ofs;
    start_ofs += widths[i].second;
  }

  return output;
}

//--------------------------------------------------------------------------------

//
// the main lookup function
// looks up either from the function or the table
// checks the input and result ranges
//
unsigned L1MuGMTLUT::LookupPacked (int idx, unsigned address) const {
  if (! m_initialized) {
    edm::LogWarning("LUTMismatch")  << "Error in L1MuGMTLUT::LookupPacked: LUT not initialized. ";
    return 0;
  }
  if ( idx >= m_NLUTS ) {
    edm::LogWarning("LUTMismatch")  << "Error in L1MuGMTLUT::LookupPacked: LUT index exceeds range (0 to " << ( m_NLUTS -1 ) << ")." 
        ;
    return 0;
  }
  if ( address >= (unsigned) (1 << m_TotalInWidth) ) {
    edm::LogWarning("LUTMismatch")  << "Error in L1MuGMTLUT::LookupPacked: LUT input exceeds range (0 to " << ( (1 << m_TotalInWidth) -1 ) << ")." 
        ;
    return 0;
  }

  unsigned value = 0;
  if (m_UseLookupFunction) {
    value = LookupFunctionPacked (idx, address);
  } else {
    value = m_Contents[idx][address];
  }

  // check range of output
  if ( value >= (unsigned) (1 << m_TotalOutWidth) ) {
    edm::LogWarning("LUTMismatch")  << "Error in L1MuGMTLUT::LookupPacked(): LUT output value " << value
         << " exceeds range (0 to " << ( (1 << m_TotalOutWidth) -1 ) << ")." 
        ;
    edm::LogWarning("LUTMismatch")  << "  LUT name: " << m_name;
    if (m_UseLookupFunction) 
      edm::LogWarning("LUTMismatch")  << "  Lookup Function has to be corrected!!!";
    else
      edm::LogWarning("LUTMismatch")  << "  LUT File has to be corrected!!!";
    return (1 << m_TotalOutWidth) - 1;
  }
  return value;
}
 
#endif