L1MuGMTLFMergeRankEtaPhiLUT Class Reference

#include <L1MuGMTLFMergeRankEtaPhiLUT.h>

Inheritance diagram for L1MuGMTLFMergeRankEtaPhiLUT:

Public Types
enum	{ DT, BRPC, CSC, FRPC }
Public Types inherited from L1MuGMTLUT
typedef std::pair< std::string, unsigned >	port

Public Member Functions
	L1MuGMTLFMergeRankEtaPhiLUT ()
	constuctor using function-lookup More...
unsigned	LookupFunctionPacked (int idx, unsigned address) const override
	access to lookup function with packed input and output More...
unsigned	SpecificLookup (int idx, unsigned eta, unsigned phi) const
	specific lookup function for entire output field More...
unsigned	SpecificLookup_rank_etaphi (int idx, unsigned eta, unsigned phi) const
	specific lookup function for rank_etaphi More...
	~L1MuGMTLFMergeRankEtaPhiLUT () override
	destructor More...
Public Member Functions inherited from L1MuGMTLUT
	L1MuGMTLUT ()
	Init and Destruct. More...
	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)
	constructor with init More...
	L1MuGMTLUT (const char *name, const std::string &instances, const std::string &inputs, const std::string &outputs, unsigned vme_addr_width=0, bool distrRAM=false)
void	Load (const char *path)
	I/O functions. More...
std::vector< unsigned >	Lookup (int idx, const std::vector< unsigned > &address) const
	additional lookup function (std::vector -> vector) More...
std::vector< unsigned >	Lookup (int idx, unsigned address) const
	additional lookup function (unsigned -> std::vector) More...
unsigned	LookupPacked (int idx, unsigned) const
unsigned	LookupPacked (int idx, const std::vector< unsigned > &address) const
	additional lookup function (std::vector -> unisgned) More...
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")
	Add Generate SubClass method. More...
std::string	Name ()
int	numberOfInstances ()
	get the number of Instances More...
void	Save (const char *path)
	save to LUT file More...
virtual	~L1MuGMTLUT ()
	destructor More...

Private Member Functions
void	InitParameters ()
	Initialize scales, configuration parameters, alignment constants, ... More...
unsigned	TheLookupFunction (int idx, unsigned eta, unsigned phi) const
	The lookup function - here the functionality of the LUT is implemented. More...

Additional Inherited Members
Protected Member Functions inherited from L1MuGMTLUT
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)
	Initialize the LUT. More...
void	Set (int idx, unsigned address, unsigned value)
	set with single address and value More...
std::vector< unsigned >	u2vec (unsigned value, const std::vector< port > &widths) const
	generate composite address or value from compact unsigned More...
unsigned	vec2u (const std::vector< unsigned > &vec, const std::vector< port > &widths) const
	generate address or value from composite address or value More...
Protected Attributes inherited from L1MuGMTLUT
std::vector< std::vector< unsigned > >	m_Contents
bool	m_distrRAM
unsigned	m_GeneralLUTVersion
bool	m_initialized
std::vector< port >	m_Inputs
std::vector< std::string >	m_InstNames
std::string	m_name
int	m_NLUTS
std::vector< port >	m_Outputs
bool	m_saveFlag
unsigned	m_TotalInWidth
unsigned	m_TotalOutWidth
bool	m_UseLookupFunction
unsigned	m_vme_addr_width

Detailed Description

LFMergeRankEtaPhi look-up table

this class was automatically generated by L1MuGMTLUT::MakeSubClass()

Definition at line 40 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

Member Enumeration Documentation

anonymous enum

Enumerator
DT
BRPC
CSC
FRPC

Definition at line 43 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

{DT, BRPC, CSC, FRPC};

Constructor & Destructor Documentation

L1MuGMTLFMergeRankEtaPhiLUT::L1MuGMTLFMergeRankEtaPhiLUT ( )

inline

constuctor using function-lookup

Definition at line 46 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

References InitParameters().

                                : L1MuGMTLUT("LFMergeRankEtaPhi", 
                       "DT BRPC CSC FRPC",
                       "eta(6) phi(8)",
                       "rank_etaphi(1)", 10, false) {
    InitParameters();
  } ;

L1MuGMTLFMergeRankEtaPhiLUT::~L1MuGMTLFMergeRankEtaPhiLUT ( )

inlineoverride

destructor

Definition at line 54 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

{};

Member Function Documentation

void L1MuGMTLFMergeRankEtaPhiLUT::InitParameters ( )

private

Initialize scales, configuration parameters, alignment constants, ...

Definition at line 32 of file L1MuGMTLFMergeRankEtaPhiLUT.cc.

Referenced by L1MuGMTLFMergeRankEtaPhiLUT(), and LookupFunctionPacked().

                                                 {
}

unsigned L1MuGMTLFMergeRankEtaPhiLUT::LookupFunctionPacked ( int  idx, unsigned  address  ) const

inlineoverridevirtual

access to lookup function with packed input and output

Reimplemented from L1MuGMTLUT.

Definition at line 76 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

References PVValHelper::eta, training_settings::idx, InitParameters(), L1MuGMTLUT::m_Inputs, phi, TheLookupFunction(), and L1MuGMTLUT::u2vec().

                                                                           {
    std::vector<unsigned> addr = u2vec(address, m_Inputs);
    return TheLookupFunction(idx ,addr[0] ,addr[1]);

  };

unsigned L1MuGMTLFMergeRankEtaPhiLUT::SpecificLookup ( int  idx, unsigned  eta, unsigned  phi  ) const

inline

specific lookup function for entire output field

Definition at line 65 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

References PVValHelper::eta, L1MuGMTLUT::LookupPacked(), and phi.

                                                                      {
    std::vector<unsigned> addr(2);
    addr[0] = eta;
    addr[1] = phi;
    return LookupPacked(idx, addr);
  };

unsigned L1MuGMTLFMergeRankEtaPhiLUT::SpecificLookup_rank_etaphi ( int  idx, unsigned  eta, unsigned  phi  ) const

inline

specific lookup function for rank_etaphi

Definition at line 57 of file L1MuGMTLFMergeRankEtaPhiLUT.h.

References PVValHelper::eta, L1MuGMTLUT::Lookup(), and phi.

Referenced by L1MuGMTMerger::merge_rank().

                                                                                  {
    std::vector<unsigned> addr(2);
    addr[0] = eta;
    addr[1] = phi;
    return Lookup(idx, addr) [0];
  };

unsigned L1MuGMTLFMergeRankEtaPhiLUT::TheLookupFunction ( int  idx, unsigned  eta, unsigned  phi  ) const

private

The lookup function - here the functionality of the LUT is implemented.

Definition at line 39 of file L1MuGMTLFMergeRankEtaPhiLUT.cc.

Referenced by LookupFunctionPacked().

                                                                                                  {
  // idx is DT, BRPC, CSC, FRPC
  // INPUTS:  eta(6) phi(8)
  // OUTPUTS: rank_etaphi(1) 

  // return zero to reduce merge rank for a certain region
  return 1;
}