Definition of unsigned integer types with overflow. More...

#include <L1GctUnsignedInt.h>

Inheritance diagram for L1GctUnsignedInt< nBits >:

Public Member Functions
	L1GctUnsignedInt ()
	Construct an unsigned integer with initial value zero. More...

	L1GctUnsignedInt (unsigned value)
	Construct an unsigned integer and check for overFlow. More...

template<int mBits>
	L1GctUnsignedInt (const L1GctUnsignedInt< mBits > &rhs)
	Copy contructor to move data between representations with different numbers of bits. More...

L1GctUnsignedInt	operator+ (const L1GctUnsignedInt &rhs) const
	add two numbers More...

L1GctUnsignedInt &	operator= (int value)
	overload = operator More...

bool	overFlow () const
	access overflow More...

void	reset ()
	reset value and overflow to zero More...

void	setOverFlow (bool oflow)
	set the overflow bit More...

void	setValue (unsigned value)
	Set value from unsigned. More...

int	size () const
	return number of bits More...

unsigned	value () const
	access value as unsigned More...

	~L1GctUnsignedInt ()
	Destructor. More...

Protected Attributes
int	m_nBits

bool	m_overFlow

unsigned	m_value

Static Protected Attributes
static const int	MAX_NBITS = 24

Detailed Description

template<int nBits>
class L1GctUnsignedInt< nBits >

Definition of unsigned integer types with overflow.

This file defines the template class L1GctUnsignedInt. It is used to store energy values that are represented in a given number of bits in hardware. The type has a built-in overFlow that is set if the value to be represented is outside the allowed range for that number of bits. This type represents unsigned integers; signed integers are represented by L1GctTwosComplement. Functions are defined to add two values, and to copy data into a different number of bits.

this header file contains method definitions because these are template classes see http://www.parashift.com/c++-faq-lite/templates.html#faq-35.12

Author: Jim Brooke & Greg Heath

Date: May 2006

Definition at line 27 of file L1GctUnsignedInt.h.

Constructor & Destructor Documentation

template<int nBits>

L1GctUnsignedInt< nBits >::L1GctUnsignedInt ( )

Construct an unsigned integer with initial value zero.

Definition at line 84 of file L1GctUnsignedInt.h.

References L1GctUnsignedInt< nBits >::m_nBits, L1GctUnsignedInt< nBits >::MAX_NBITS, and L1GctUnsignedInt< nBits >::reset().

                                           {
   m_nBits = nBits > 0 && nBits < MAX_NBITS ? nBits : 16;
   this->reset();
 }

template<int nBits>

L1GctUnsignedInt< nBits >::L1GctUnsignedInt ( unsigned value )

Construct an unsigned integer and check for overFlow.

Definition at line 90 of file L1GctUnsignedInt.h.

References L1GctUnsignedInt< nBits >::m_nBits, L1GctUnsignedInt< nBits >::m_overFlow, L1GctUnsignedInt< nBits >::MAX_NBITS, and L1GctUnsignedInt< nBits >::setValue().

                                                         {
   m_nBits = nBits > 0 && nBits < MAX_NBITS ? nBits : 16;
   m_overFlow = false;
   this->setValue(value);
 }

template<int nBits>

L1GctUnsignedInt< nBits >::~L1GctUnsignedInt ( )

Destructor.

Definition at line 97 of file L1GctUnsignedInt.h.

97 {}

template<int nBits>

template<int mBits>

L1GctUnsignedInt< nBits >::L1GctUnsignedInt ( const L1GctUnsignedInt< mBits > & rhs )

Copy contructor to move data between representations with different numbers of bits.

Definition at line 103 of file L1GctUnsignedInt.h.

References L1GctUnsignedInt< nBits >::m_nBits, L1GctUnsignedInt< nBits >::MAX_NBITS, L1GctUnsignedInt< nBits >::overFlow(), L1GctUnsignedInt< nBits >::setOverFlow(), L1GctUnsignedInt< nBits >::setValue(), and L1GctUnsignedInt< nBits >::value().

                                                                             {
   m_nBits = nBits > 0 && nBits < MAX_NBITS ? nBits : 16;
   this->setValue(rhs.value());
   this->setOverFlow(this->overFlow() || rhs.overFlow());
 }

Member Function Documentation

template<int nBits>

L1GctUnsignedInt< nBits > L1GctUnsignedInt< nBits >::operator+ ( const L1GctUnsignedInt< nBits > & rhs ) const

add two numbers

Definition at line 123 of file L1GctUnsignedInt.h.

References L1GctUnsignedInt< nBits >::overFlow(), L1GctUnsignedInt< nBits >::setOverFlow(), L1GctUnsignedInt< nBits >::setValue(), groupFilesInBlocks::temp, and L1GctUnsignedInt< nBits >::value().

Referenced by L1GctUnsignedInt< L1GctInternEtSum::kTotEtOrHtNBits >::size().

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

template<int nBits>

L1GctUnsignedInt< nBits > & L1GctUnsignedInt< nBits >::operator= ( int value )

overload = operator

Definition at line 144 of file L1GctUnsignedInt.h.

References L1GctUnsignedInt< nBits >::setValue().

Referenced by L1GctUnsignedInt< L1GctInternEtSum::kTotEtOrHtNBits >::size().

                                                                      {
   this->setValue(value);
   return *this;
 }

template<int nBits>

bool L1GctUnsignedInt< nBits >::overFlow ( ) const

inline

access overflow

Definition at line 56 of file L1GctUnsignedInt.h.

Referenced by L1GctJetFinderBase::doEtSums(), L1GctJetFinderBase::doHtSums(), L1GctJetFinderBase::etComponentForJetFinder(), L1GctJetCount< nBits >::L1GctJetCount(), L1GctUnsignedInt< nBits >::L1GctUnsignedInt(), L1GctMet::metVector(), L1GctJetCount< nBits >::operator+(), L1GctUnsignedInt< nBits >::operator+(), L1GctWheelEnergyFpga::process(), L1GctGlobalEnergyAlgos::process(), and L1GctJetLeafCard::process().

56 { return m_overFlow; }

L1GctUnsignedInt::m_overFlow

bool m_overFlow

Definition: L1GctUnsignedInt.h:75

template<int nBits>

void L1GctUnsignedInt< nBits >::reset ( void )

inline

reset value and overflow to zero

Definition at line 41 of file L1GctUnsignedInt.h.

Referenced by L1GctUnsignedInt< nBits >::L1GctUnsignedInt(), L1GctJetFinderBase::hfTowerSumsType::reset(), L1GctWheelEnergyFpga::resetProcessor(), L1GctJetLeafCard::resetProcessor(), and L1GctGlobalEnergyAlgos::resetProcessor().

                {
     m_value = static_cast<unsigned>(0);
     m_overFlow = false;
   }

template<int nBits>

void L1GctUnsignedInt< nBits >::setOverFlow ( bool oflow )

inline

set the overflow bit

Definition at line 50 of file L1GctUnsignedInt.h.

Referenced by L1GctJetFinderBase::doEtSums(), L1GctJetFinderBase::doHtSums(), L1GctUnsignedInt< nBits >::L1GctUnsignedInt(), L1GctMet::metVector(), L1GctUnsignedInt< nBits >::operator+(), L1GctGlobalEnergyAlgos::process(), L1GctGlobalEnergyAlgos::setInputWheelEt(), and L1GctGlobalEnergyAlgos::setInputWheelHt().

50 { m_overFlow = oflow; }

L1GctUnsignedInt::m_overFlow

bool m_overFlow

Definition: L1GctUnsignedInt.h:75

template<int nBits>

void L1GctUnsignedInt< nBits >::setValue ( unsigned value )

Set value from unsigned.

Definition at line 111 of file L1GctUnsignedInt.h.

References L1GctUnsignedInt< nBits >::m_nBits, L1GctUnsignedInt< nBits >::m_overFlow, and L1GctUnsignedInt< nBits >::m_value.

Referenced by L1GctJetFinderBase::doEtSums(), L1GctJetFinderBase::doHtSums(), L1GctUnsignedInt< nBits >::L1GctUnsignedInt(), L1GctMet::metVector(), L1GctUnsignedInt< nBits >::operator+(), L1GctUnsignedInt< nBits >::operator=(), L1GctWheelEnergyFpga::process(), L1GctGlobalEnergyAlgos::process(), L1GctJetLeafCard::process(), L1GctUnsignedInt< L1GctInternEtSum::kTotEtOrHtNBits >::reset(), L1GctGlobalEnergyAlgos::setInputWheelEt(), and L1GctGlobalEnergyAlgos::setInputWheelHt().

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