L1GctUnsignedInt.h

Go to the documentation of this file.

#ifndef L1GCTUNSIGNEDINT_H
#define L1GCTUNSIGNEDINT_H
 
#include <ostream>
 
template <int nBits>
class L1GctUnsignedInt {
public:
  L1GctUnsignedInt();
  L1GctUnsignedInt(unsigned value);
  ~L1GctUnsignedInt();
 
  template <int mBits>
  L1GctUnsignedInt(const L1GctUnsignedInt<mBits>& rhs);
 
  void reset() {
    m_value = static_cast<unsigned>(0);
    m_overFlow = false;
  }
 
  void setValue(unsigned value);
 
  void setOverFlow(bool oflow) { m_overFlow = oflow; }
 
  unsigned value() const { return m_value; }
 
  bool overFlow() const { return m_overFlow; }
 
  int size() const { return m_nBits; }
 
  L1GctUnsignedInt operator+(const L1GctUnsignedInt& rhs) const;
 
  L1GctUnsignedInt& operator=(int value);
 
protected:
  // number of bits
  int m_nBits;
 
  // value
  unsigned m_value;
 
  // overflow
  bool m_overFlow;
 
  static const int MAX_NBITS = 24;
};
 
template <int nBits>
std::ostream& operator<<(std::ostream& s, const L1GctUnsignedInt<nBits>& data);
 
template <int nBits>
L1GctUnsignedInt<nBits>::L1GctUnsignedInt() {
  m_nBits = nBits > 0 && nBits < MAX_NBITS ? nBits : 16;
  this->reset();
}
 
template <int nBits>
L1GctUnsignedInt<nBits>::L1GctUnsignedInt(unsigned value) {
  m_nBits = nBits > 0 && nBits < MAX_NBITS ? nBits : 16;
  m_overFlow = false;
  this->setValue(value);
}
 
template <int nBits>
L1GctUnsignedInt<nBits>::~L1GctUnsignedInt() {}
 
// copy contructor to move data between
// representations with different numbers of bits
template <int nBits>
template <int mBits>
L1GctUnsignedInt<nBits>::L1GctUnsignedInt(const L1GctUnsignedInt<mBits>& rhs) {
  m_nBits = nBits > 0 && nBits < MAX_NBITS ? nBits : 16;
  this->setValue(rhs.value());
  this->setOverFlow(this->overFlow() || rhs.overFlow());
}
 
// set value, checking for overflow
template <int nBits>
void L1GctUnsignedInt<nBits>::setValue(unsigned value) {
  // check for overflow
  if (value >= (static_cast<unsigned>(1 << m_nBits))) {
    m_overFlow = true;
  }
 
  // set value with bitmask
  m_value = value & ((1 << m_nBits) - 1);
}
 
// add two unsigneds
template <int nBits>
L1GctUnsignedInt<nBits> L1GctUnsignedInt<nBits>::operator+(const L1GctUnsignedInt<nBits>& rhs) const {
  // temporary variable for storing the result (need to set its size)
  L1GctUnsignedInt<nBits> temp;
 
  unsigned sum;
  bool ofl;
 
  // do the addition here
  sum = this->value() + rhs.value();
  ofl = this->overFlow() || rhs.overFlow();
 
  //fill the temporary argument
  temp.setValue(sum);
  temp.setOverFlow(temp.overFlow() || ofl);
 
  // return the temporary
  return temp;
}
 
// overload assignment by int
template <int nBits>
L1GctUnsignedInt<nBits>& L1GctUnsignedInt<nBits>::operator=(int value) {
  this->setValue(value);
  return *this;
}
 
// overload ostream<<
template <int nBits>
std::ostream& operator<<(std::ostream& s, const L1GctUnsignedInt<nBits>& data) {
  s << "L1GctUnsignedInt value : " << data.value();
  if (data.overFlow()) {
    s << " Overflow set! ";
  }
 
  return s;
}
 
#endif