CSCComparatorCodeLUT Class Reference

#include <CSCComparatorCodeLUT.h>

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
unsigned	checkedInput (unsigned in, unsigned maxWidth) const
	CSCComparatorCodeLUT (const std::string &)
float	data (unsigned int address) const
bool	empty () const
void	initialize ()
int	load (const std::string &inFileName)
float	lookup (int code) const
float	lookupPacked (const int input) const
unsigned int	maxSize () const
unsigned int	nrBitsAddress () const
unsigned int	nrBitsData () const
int	read (std::istream &stream)
void	save (std::ofstream &output)
void	write (std::ostream &stream) const
	~CSCComparatorCodeLUT ()

Private Member Functions
int	readHeader (std::istream &)

Private Attributes
unsigned int	addressMask_
std::vector< float >	data_
unsigned int	dataMask_
int	m_codeInWidth
bool	m_initialized
unsigned	m_outWidth
unsigned int	nrBitsAddress_
unsigned int	nrBitsData_

Detailed Description

Definition at line 14 of file CSCComparatorCodeLUT.h.

Member Enumeration Documentation

ReadCodes

enum CSCComparatorCodeLUT::ReadCodes

Enumerator
SUCCESS
NO_ENTRIES
DUP_ENTRIES
MISS_ENTRIES
MAX_ADDRESS_OUTOFRANGE
NO_HEADER

Definition at line 16 of file CSCComparatorCodeLUT.h.

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

Constructor & Destructor Documentation

CSCComparatorCodeLUT()

CSCComparatorCodeLUT::CSCComparatorCodeLUT ( const std::string &  fname )

explicit

Definition at line 5 of file CSCComparatorCodeLUT.cc.

    : nrBitsAddress_(0), nrBitsData_(0), addressMask_(0), dataMask_(0), data_(), m_codeInWidth(12), m_outWidth(32) {
  if (fname != std::string("")) {
    load(fname);
  } else {
    initialize();
  }
}

References alignmentValidation::fname, initialize(), load(), and AlCaHLTBitMon_QueryRunRegistry::string.

~CSCComparatorCodeLUT()

CSCComparatorCodeLUT::~CSCComparatorCodeLUT ( )

inline

Definition at line 28 of file CSCComparatorCodeLUT.h.

{}

Member Function Documentation

checkedInput()

unsigned CSCComparatorCodeLUT::checkedInput	(	unsigned	in,
		unsigned	maxWidth
	)		const

Definition at line 64 of file CSCComparatorCodeLUT.cc.

                                                                                {
  unsigned maxIn = (1 << maxWidth) - 1;
  return (in < maxIn ? in : maxIn);
}

References recoMuon::in, and SiStripMonitorCluster_cfi::maxWidth.

data()

float CSCComparatorCodeLUT::data

(

unsigned int

address

)

const

Definition at line 17 of file CSCComparatorCodeLUT.cc.

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

References addressMask_, and data_.

Referenced by lookupPacked(), and write().

empty()

bool CSCComparatorCodeLUT::empty ( void  ) const

inline

Definition at line 50 of file CSCComparatorCodeLUT.h.

{ return data_.empty(); }

References data_.

Referenced by initialize().

initialize()

void CSCComparatorCodeLUT::initialize

(

void

)

Definition at line 51 of file CSCComparatorCodeLUT.cc.

                                      {
  if (empty()) {
    std::stringstream stream;
    stream << "#<header> V1 " << m_codeInWidth << " " << m_outWidth << " </header> " << std::endl;
    for (int in = 0; in < (1 << m_codeInWidth); ++in) {
      int out = lookup(in);
      stream << in << " " << out << std::endl;
    }
    read(stream);
  }
  m_initialized = true;
}

References empty(), recoMuon::in, lookup(), m_codeInWidth, m_initialized, m_outWidth, MillePedeFileConverter_cfg::out, read(), and cms::cuda::stream.

Referenced by CSCComparatorCodeLUT().

load()

int CSCComparatorCodeLUT::load

(

const std::string &

inFileName

)

Definition at line 21 of file CSCComparatorCodeLUT.cc.

                                                          {
  std::ifstream fstream;
  fstream.open(edm::FileInPath(inFileName.c_str()).fullPath());
  if (!fstream.good()) {
    fstream.close();
    throw cms::Exception("FileOpenError") << "Failed to open LUT file: " << inFileName;
  }
  int readCode = read(fstream);
 
  m_initialized = true;
  fstream.close();
 
  return readCode;
}

References Exception, contentValuesFiles::fullPath, m_initialized, and read().

Referenced by CSCComparatorCodeLUT().

lookup()

float CSCComparatorCodeLUT::lookup

(

int

code

)

const

Definition at line 36 of file CSCComparatorCodeLUT.cc.

                                                 {
  if (m_initialized) {
    return lookupPacked(code);
  }
  return 0;
}

References lookupPacked(), and m_initialized.

Referenced by initialize().

lookupPacked()

float CSCComparatorCodeLUT::lookupPacked

(

const int

input

)

const

Definition at line 43 of file CSCComparatorCodeLUT.cc.

                                                              {
  if (m_initialized) {
    return data((unsigned int)input);
  }
  throw cms::Exception("Uninitialized") << "If you're not loading a LUT from file you need to implement lookupPacked.";
  return 0;
}

References data(), Exception, input, and m_initialized.

Referenced by lookup().

maxSize()

unsigned int CSCComparatorCodeLUT::maxSize

(

)

const

Definition at line 130 of file CSCComparatorCodeLUT.cc.

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

References addressMask_, and SiStripPI::max.

nrBitsAddress()

unsigned int CSCComparatorCodeLUT::nrBitsAddress ( ) const

inline

Definition at line 46 of file CSCComparatorCodeLUT.h.

{ return nrBitsAddress_; }

References nrBitsAddress_.

nrBitsData()

unsigned int CSCComparatorCodeLUT::nrBitsData ( ) const

inline

Definition at line 47 of file CSCComparatorCodeLUT.h.

{ return nrBitsData_; }

References nrBitsData_.

read()

int CSCComparatorCodeLUT::read

(

std::istream &

stream

)

Definition at line 69 of file CSCComparatorCodeLUT.cc.

                                                 {
  data_.clear();
 
  int readHeaderCode = readHeader(stream);
  if (readHeaderCode != SUCCESS)
    return readHeaderCode;
 
  std::vector<std::pair<unsigned int, float> > 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, float> 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;
}

References a, addressMask_, b, data_, DUP_ENTRIES, mps_splice::entry, spr::find(), mps_splice::line, SiStripPI::max, MAX_ADDRESS_OUTOFRANGE, MISS_ENTRIES, NO_ENTRIES, readHeader(), cms::cuda::stream, AlCaHLTBitMon_QueryRunRegistry::string, SUCCESS, HcalDetIdTransform::transform(), and x.

Referenced by edmIntegrityCheck.PublishToFileSystem::get(), initialize(), and load().

readHeader()

int CSCComparatorCodeLUT::readHeader ( std::istream &  stream )

private

Definition at line 134 of file CSCComparatorCodeLUT.cc.

                                                       {
  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;
}

References addressMask_, dataMask_, mps_splice::line, NO_HEADER, nrBitsAddress_, nrBitsData_, cms::cuda::stream, AlCaHLTBitMon_QueryRunRegistry::string, SUCCESS, and BeamSplash_cfg::version.

Referenced by read().

save()

void CSCComparatorCodeLUT::save

(

std::ofstream &

output

)

Definition at line 15 of file CSCComparatorCodeLUT.cc.

{ write(output); }

References convertSQLitetoXML_cfg::output, and write().

write()

void CSCComparatorCodeLUT::write

(

std::ostream &

stream

)

const

Definition at line 123 of file CSCComparatorCodeLUT.cc.

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

References addressMask_, data(), data_, nrBitsAddress_, nrBitsData_, and cms::cuda::stream.

Referenced by save().

Member Data Documentation

addressMask_

unsigned int CSCComparatorCodeLUT::addressMask_

private

Definition at line 57 of file CSCComparatorCodeLUT.h.

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

data_

std::vector<float> CSCComparatorCodeLUT::data_

private

Definition at line 60 of file CSCComparatorCodeLUT.h.

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

dataMask_

unsigned int CSCComparatorCodeLUT::dataMask_

private

Definition at line 58 of file CSCComparatorCodeLUT.h.

Referenced by readHeader().

m_codeInWidth

int CSCComparatorCodeLUT::m_codeInWidth

private

Definition at line 62 of file CSCComparatorCodeLUT.h.

Referenced by initialize().

m_initialized

bool CSCComparatorCodeLUT::m_initialized

private

Definition at line 64 of file CSCComparatorCodeLUT.h.

Referenced by initialize(), load(), lookup(), and lookupPacked().

m_outWidth

unsigned CSCComparatorCodeLUT::m_outWidth

private

Definition at line 63 of file CSCComparatorCodeLUT.h.

Referenced by initialize().

nrBitsAddress_

unsigned int CSCComparatorCodeLUT::nrBitsAddress_

private

Definition at line 55 of file CSCComparatorCodeLUT.h.

Referenced by nrBitsAddress(), readHeader(), and write().

nrBitsData_

unsigned int CSCComparatorCodeLUT::nrBitsData_

private

Definition at line 56 of file CSCComparatorCodeLUT.h.

Referenced by nrBitsData(), readHeader(), and write().