l1t::LUT Class Reference

#include <LUT.h>

Inheritance diagram for l1t::LUT:

Public Types
enum	ReadCodes {   SUCCESS = 0, NO_ENTRIES = 1, DUP_ENTRIES = 2, MISS_ENTRIES = 3,   MAX_ADDRESS_OUTOFRANGE = 4, NO_HEADER = 5 }

Public Member Functions
int	data (unsigned int address) const
bool	empty () const
	LUT ()
	LUT (std::istream &stream)
unsigned int	maxSize () const
unsigned int	nrBitsAddress () const
unsigned int	nrBitsData () const
int	read (std::istream &stream)
void	write (std::ostream &stream) const
	~LUT ()

Private Member Functions
int	readHeader_ (std::istream &)
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
unsigned int	addressMask_
std::vector< int >	data_
unsigned int	dataMask_
unsigned int	nrBitsAddress_
unsigned int	nrBitsData_

Friends
class	boost::serialization::access
template<typename CondSerializationT , typename Enabled >
struct	cond::serialization::access

Detailed Description

Description: A class implimentating a look up table

Implementation: Internally stores data in vector filled with 32 bit ints address and output is masked to specifed number of bits vector only allocates as necessary, eg we may have a 32 bit address but we obviously dont want to allocate a 4gb vector

Error handling: currently waiting guidance on how to deal with this Exceptions are currently forbiden, emulator fails should not impact on the rest of the software chain. As such, everything silently fails gracefully

Author

: Sam Harper - RAL, Jim Brooke - Bristol

Definition at line 29 of file LUT.h.

Member Enumeration Documentation

enum l1t::LUT::ReadCodes

Enumerator
SUCCESS
NO_ENTRIES
DUP_ENTRIES
MISS_ENTRIES
MAX_ADDRESS_OUTOFRANGE
NO_HEADER

Definition at line 31 of file LUT.h.

                   {
      SUCCESS = 0,
      NO_ENTRIES = 1,
      DUP_ENTRIES = 2,
      MISS_ENTRIES = 3,
      MAX_ADDRESS_OUTOFRANGE = 4,
      NO_HEADER = 5
    };

Constructor & Destructor Documentation

l1t::LUT::LUT ( )

inline

Definition at line 40 of file LUT.h.

: nrBitsAddress_(0), nrBitsData_(0), addressMask_(0), dataMask_(0), data_() {}

l1t::LUT::LUT ( std::istream &  stream )

inlineexplicit

Definition at line 42 of file LUT.h.

References read().

: data_() { read(stream); }

l1t::LUT::~LUT ( )

inline

Definition at line 44 of file LUT.h.

{}

Member Function Documentation

int l1t::LUT::data ( unsigned int  address ) const

inline

Definition at line 46 of file LUT.h.

References addressMask_, data_, and dataMask_.

Referenced by L1TMuonOverlapParamsViewer::analyze(), l1t::calibrateAndRankJets(), l1t::calibrateAndRankTaus(), OMTFProcessor< GoldenPatternType >::configure(), ProcessorBase< GoldenPatternType >::configure(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::loadCalibrationLuts(), L1TMuonGlobalParamsViewer::printLUT(), and l1t::Stage1Layer2TauAlgorithmImpHW::processEvent().

                                         {
      return (address & addressMask_) < data_.size() ? dataMask_ & data_[addressMask_ & address] : 0;
    }

bool l1t::LUT::empty ( ) const

inline

Definition at line 58 of file LUT.h.

References data_.

Referenced by L1TMuonGlobalParamsViewer::printLUT().

{ return data_.empty(); }

unsigned int l1t::LUT::maxSize ( ) const

inline

Definition at line 55 of file LUT.h.

References addressMask_, and SiStripPI::max.

Referenced by L1TMuonOverlapParamsViewer::analyze(), L1TMuonGlobalParamsViewer::printLUT(), and l1t::Stage1Layer2TauAlgorithmImpHW::processEvent().

                                 {
      return addressMask_ == std::numeric_limits<unsigned int>::max() ? addressMask_ : addressMask_ + 1;
    }

unsigned int l1t::LUT::nrBitsAddress ( ) const

inline

Definition at line 52 of file LUT.h.

References nrBitsAddress_.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::loadCalibrationLuts().

{ return nrBitsAddress_; }

unsigned int l1t::LUT::nrBitsData ( ) const

inline

Definition at line 53 of file LUT.h.

References nrBitsData_.

Referenced by OMTFProcessor< GoldenPatternType >::configure(), ProcessorBase< GoldenPatternType >::configure(), and l1t::Stage2Layer2TauAlgorithmFirmwareImp1::loadCalibrationLuts().

{ return nrBitsData_; }

int l1t::LUT::read

(

std::istream &

stream

)

Definition at line 11 of file LUT.cc.

References a, addressMask_, b, data_, dataMask_, DUP_ENTRIES, mps_splice::entry, spr::find(), geometryCSVtoXML::line, SiStripPI::max, MAX_ADDRESS_OUTOFRANGE, MISS_ENTRIES, NO_ENTRIES, readHeader_(), AlCaHLTBitMon_QueryRunRegistry::string, SUCCESS, and HcalDetIdTransform::transform().

Referenced by l1t::convertToLUT(), edmIntegrityCheck.PublishToFileSystem::get(), LUT(), l1t::MicroGMTLUT::MicroGMTLUT(), and XMLConfigReader::readLUTs().

                                   {
  data_.clear();

  int readHeaderCode = readHeader_(stream);
  if (readHeaderCode != SUCCESS)
    return readHeaderCode;

  std::vector<std::pair<unsigned int, int> > entries;
  unsigned int maxAddress = addressMask_;
  std::string line;

  while (std::getline(stream, line)) {
    line.erase(std::find(line.begin(), line.end(), '#'), line.end());  //ignore comments
    std::istringstream lineStream(line);
    std::pair<unsigned int, int> entry;
    while (lineStream >> entry.first >> entry.second) {
      entry.first &= addressMask_;
      entry.second &= dataMask_;
      entries.push_back(entry);
      if (entry.first > maxAddress || maxAddress == addressMask_)
        maxAddress = entry.first;
    }
  }
  std::sort(entries.begin(), entries.end());
  if (entries.empty()) {
    //log the error we read nothing
    return NO_ENTRIES;
  }
  //this check is redundant as dups are also picked up by the next check but might make for easier debugging
  if (std::adjacent_find(entries.begin(), entries.end(), [](auto const& a, auto const& b) {
        return a.first == b.first;
      }) != entries.end()) {
    //log the error that we have duplicate addresses once masked
    return DUP_ENTRIES;
  }
  if (entries.front().first != 0 ||
      std::adjacent_find(entries.begin(), entries.end(), [](auto const& a, auto const& b) {
        return a.first + 1 != b.first;
      }) != entries.end()) {
    //log the error that we have a missing entry
    return MISS_ENTRIES;
  }

  if (maxAddress != std::numeric_limits<unsigned int>::max())
    data_.resize(maxAddress + 1, 0);
  else {
    //log the error that we have more addresses than we can deal with (which is 4gb so something probably has gone wrong anyways)
    return MAX_ADDRESS_OUTOFRANGE;
  }

  std::transform(entries.begin(), entries.end(), data_.begin(), [](auto const& x) { return x.second; });
  return SUCCESS;
}

int l1t::LUT::readHeader_ ( std::istream &  stream )

private

Definition at line 72 of file LUT.cc.

References geometryCSVtoXML::line, AlCaHLTBitMon_QueryRunRegistry::string, and relval_steps::version.

Referenced by read().

                                          {
  int startPos = stream.tellg();  //we are going to reset to this position before we exit
  std::string line;
  while (std::getline(stream, line)) {
    if (line.find("#<header>") == 0) {  //line
      std::istringstream lineStream(line);

      std::string version;      //currently not doing anything with this
      std::string headerField;  //currently not doing anything with this
      if (lineStream >> headerField >> version >> nrBitsAddress_ >> nrBitsData_) {
        addressMask_ = nrBitsAddress_ != 32 ? (0x1 << nrBitsAddress_) - 1 : ~0x0;
        dataMask_ = (0x1 << nrBitsData_) - 1;
        stream.seekg(startPos);
        return SUCCESS;
      }
    }
  }

  nrBitsAddress_ = 0;
  nrBitsData_ = 0;
  addressMask_ = (0x1 << nrBitsAddress_) - 1;
  dataMask_ = (0x1 << nrBitsData_) - 1;

  stream.seekg(startPos);
  return NO_HEADER;
}

template<class Archive >

void l1t::LUT::serialize ( Archive &  ar, const unsigned int  version  )

private

void l1t::LUT::write

(

std::ostream &

stream

)

const

Definition at line 65 of file LUT.cc.

References data.

Referenced by pkg.AbstractPkg::generate(), and l1t::MicroGMTLUT::MicroGMTLUT().

                                           {
  stream << "#<header> V1 " << nrBitsAddress_ << " " << nrBitsData_ << " </header> " << std::endl;
  for (unsigned int address = 0; address < data_.size(); address++) {
    stream << (address & addressMask_) << " " << data(address) << std::endl;
  }
}

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 69 of file LUT.h.

template<typename CondSerializationT , typename Enabled >

friend struct cond::serialization::access

friend

Definition at line 69 of file LUT.h.

Member Data Documentation

unsigned int l1t::LUT::addressMask_

private

Definition at line 65 of file LUT.h.

Referenced by data(), maxSize(), and read().

std::vector<int> l1t::LUT::data_

private

Definition at line 68 of file LUT.h.

Referenced by data(), empty(), and read().

unsigned int l1t::LUT::dataMask_

private

Definition at line 66 of file LUT.h.

Referenced by data(), and read().

unsigned int l1t::LUT::nrBitsAddress_

private

Definition at line 63 of file LUT.h.

Referenced by nrBitsAddress().

unsigned int l1t::LUT::nrBitsData_

private

Definition at line 64 of file LUT.h.

Referenced by nrBitsData().