HLT::TriggerElement::ObjectIndex Class Reference

Helper class for conversion from/to int stored in TE and pair of ints used in Navigation Object pointer in Navigation is pair of ints. More...

#include <TriggerElement.h>

Collaboration diagram for HLT::TriggerElement::ObjectIndex:

Public Member Functions
	ObjectIndex ()
	ObjectIndex (sub_index_type subType, index_type begin, index_type end)
	constructor used to create index used in TE More...
sub_index_type	subTypeIndex () const
	to get collection index More...
index_type	objectsBegin () const
	to get object number in th ecollection More...
index_type	objectsEnd () const
	to get object number in th ecollection More...
bool	isSameOrWithin (const ObjectIndex *idx) const
	check if idx is the same as this or is within this index More...
void	updateBeginAndEnd (index_type begin, index_type end)
bool	operator< (const ObjectIndex &obj) const
void	serialize (std::vector< uint32_t > &output) const
void	deserialize (std::vector< uint32_t >::const_iterator &inputIt)
void	setSubTypeIndex (sub_index_type idx)
bool	valid () const
bool	operator== (const ObjectIndex &rhs) const
bool	operator!= (const ObjectIndex &rhs) const

Private Attributes
sub_index_type	m_subTypeIndex
	actual index storage More...
index_type	m_objIndexBegin
	auxiliary index word for big features More...
index_type	m_objIndexEnd
	auxiliary index word for big features More...

Detailed Description

Helper class for conversion from/to int stored in TE and pair of ints used in Navigation Object pointer in Navigation is pair of ints.

One is pointing so collection of givent type. Second int points to object in this sub collection. In TE fro historical reason (and space saving) this 2 ints need to colapse into one 32bit int.

Warning

Therefore limitation ... we can have up to 65000 distinct collections of given type

Therefore limitation ... we can have up to 65000 objects in each subcollection.

Definition at line 75 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

Constructor & Destructor Documentation

ObjectIndex() [1/2]

TriggerElement::ObjectIndex::ObjectIndex

(

)

Definition at line 234 of file TrigNavStructure/Root/TriggerElement.cxx.

  : m_subTypeIndex(invalid_sub_index), m_objIndexBegin(invalid_index), m_objIndexEnd(invalid_index) {}

ObjectIndex() [2/2]

TriggerElement::ObjectIndex::ObjectIndex	(	sub_index_type	subType,
		index_type	begin,
		index_type	end
	)

constructor used to create index used in TE

Definition at line 238 of file TrigNavStructure/Root/TriggerElement.cxx.

  : m_subTypeIndex(subType), m_objIndexBegin(begin), m_objIndexEnd(end)
{
    if (subType >= invalid_sub_index)
    throw std::runtime_error("To many collections of one type: " + std::to_string(subType)+" >= 0xffff" );
}

Member Function Documentation

deserialize()

void TriggerElement::ObjectIndex::deserialize

(

std::vector< uint32_t >::const_iterator &

inputIt

)

Definition at line 306 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                                       {
    // check if compressed reference
    uint32_t w = *inputIt++; // pickup and advance
    if ( w & 0x80000000 ) {
      // small numbers (compressed to one word)
    m_subTypeIndex  = w & 0xf;
    m_objIndexBegin =  ( (w>>18) &  0x1fff );
    m_objIndexEnd   =  (w>>4) & 0x3fff;
    //  std::cerr << "feature idx deser: " << std::hex << w << std::dec << " " << std::endl;
    } else if ( (w & 0x40000000) == 0 ) {   
      // medium numbers (compressed to 2 words)
    m_subTypeIndex  = w & 0xffff; 
    uint32_t w2 = *inputIt++;
    m_objIndexBegin = w2 >> 16; 
    m_objIndexEnd   = w2 & 0xffff; 
    //  std::cerr << "feature idx2: " << std::hex << m_subTypeIndex << " " << m_objIndex << std::dec << std::endl;
    } else {
      // huge numbers (3 word involved)
      m_subTypeIndex  = w & 0xffff;
      m_objIndexBegin = *inputIt++;
      m_objIndexEnd   = *inputIt++;
 
    }
    // at the end the inputIt is pointing outside the ObjectIndex
}

isSameOrWithin()

bool TriggerElement::ObjectIndex::isSameOrWithin

(

const ObjectIndex *

idx

)

const

check if idx is the same as this or is within this index

Definition at line 332 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                             {
    if ( this->subTypeIndex() != idx->subTypeIndex() )
    return false;
    if ( this->objectsBegin() > idx->objectsBegin() )
    return false;
    if ( this->objectsEnd() < idx->objectsEnd() )
    return false;
    return true;
}

objectsBegin()

uint32_t TriggerElement::ObjectIndex::objectsBegin

(

)

const

to get object number in th ecollection

Definition at line 256 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                       {
  return m_objIndexBegin;
}

objectsEnd()

uint32_t TriggerElement::ObjectIndex::objectsEnd

(

)

const

to get object number in th ecollection

Definition at line 260 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                     {
  return m_objIndexEnd;
}

operator!=()

bool HLT::TriggerElement::ObjectIndex::operator!= ( const ObjectIndex &  rhs ) const

inline

Definition at line 99 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

                                                    {
    return ! (*this == rhs);
      }

operator<()

bool TriggerElement::ObjectIndex::operator<

(

const ObjectIndex &

obj

)

const

Definition at line 269 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                      {
  if ( m_subTypeIndex != obj.m_subTypeIndex )
    return m_subTypeIndex < obj.m_subTypeIndex;
  if ( m_objIndexBegin != obj.m_objIndexBegin )
    return m_objIndexBegin < obj.m_objIndexBegin;
  
  return m_objIndexEnd < obj.m_objIndexEnd;
}

operator==()

bool HLT::TriggerElement::ObjectIndex::operator== ( const ObjectIndex &  rhs ) const

inline

Definition at line 93 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

                                                    {
    if (m_subTypeIndex != rhs.m_subTypeIndex || m_objIndexBegin != rhs.m_objIndexBegin 
        || m_objIndexEnd != rhs.m_objIndexEnd)
      return false;
    return true;
      }

serialize()

void TriggerElement::ObjectIndex::serialize

(

std::vector< uint32_t > &

output

)

const

Definition at line 278 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                           {
    // here comec the compression 
    // check if we can fit into one int
    // ie. subtypeIndex fits into the 4 bits (0-8)
    // if the begin  indexes fit into the 13 bits (0-8192 )
    // if the end    indexes fit into the 14 bits (0-16383 )
  
    if ( (0 == (m_subTypeIndex & ~0xf)) && (0 == (objectsBegin() & ~0x1fff)) && ( 0 == (objectsEnd() & ~0x3fff)) ) {
    output.push_back(0x80000000 | m_subTypeIndex | objectsEnd()<< 4 | objectsBegin() << 18);
    //  std::cerr << "feature idx ser: " << std::hex << output.back() << std::dec << std::endl;
 
    } else if ( (0 == (objectsBegin() & ~0xffff)) && (0 == (objectsEnd() & ~0xffff)) ) {
      // check if we can fit into two ints
      // ie. subtypeIndex fits into the 16 bits 
      // if the begin  indexes fit into the 16 bits (0-65536 )
      // if the end    indexes fit into the 16 bits (0-65536)
      
      //    std::cerr << "feature idx2: " << std::hex << m_subTypeIndex << " " << m_objIndex << std::dec << std::endl;
    output.push_back(m_subTypeIndex);
    output.push_back((objectsBegin() << 16) |  (objectsEnd()) );
    } else {
      // we have to use 3 words
      output.push_back(m_subTypeIndex | 0x40000000); // second most significant bit marks that
      output.push_back(objectsBegin());
      output.push_back(objectsEnd());
    }
}

setSubTypeIndex()

void HLT::TriggerElement::ObjectIndex::setSubTypeIndex ( sub_index_type  idx )

inline

Definition at line 91 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

{ m_subTypeIndex = idx; }

subTypeIndex()

uint16_t TriggerElement::ObjectIndex::subTypeIndex

(

)

const

to get collection index

Definition at line 247 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                       {
    return m_subTypeIndex;
}

updateBeginAndEnd()

void TriggerElement::ObjectIndex::updateBeginAndEnd	(	index_type	begin,
		index_type	end
	)

Definition at line 264 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                                   {
  m_objIndexBegin = begin; 
  m_objIndexEnd   = end;
}

valid()

bool TriggerElement::ObjectIndex::valid

(

)

const

Definition at line 342 of file TrigNavStructure/Root/TriggerElement.cxx.

                                            {
  if ( m_subTypeIndex == invalid_sub_index && m_objIndexBegin == invalid_index && m_objIndexEnd == invalid_index )
    return false;
  return true;
}

Member Data Documentation

m_objIndexBegin

index_type HLT::TriggerElement::ObjectIndex::m_objIndexBegin

private

auxiliary index word for big features

Definition at line 105 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

m_objIndexEnd

index_type HLT::TriggerElement::ObjectIndex::m_objIndexEnd

private

auxiliary index word for big features

Definition at line 106 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

m_subTypeIndex

sub_index_type HLT::TriggerElement::ObjectIndex::m_subTypeIndex

private

actual index storage

Definition at line 104 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

---

The documentation for this class was generated from the following files:

• TrigNavStructure/TrigNavStructure/TriggerElement.h
• TrigNavStructure/Root/TriggerElement.cxx