Iterator used to loop over multi-particle combinations. More...

#include <ComboIterator.h>

Inheritance diagram for HLT::ComboIterator:

Collaboration diagram for HLT::ComboIterator:

Public Member Functions
	ComboIterator (const std::vector< TEVec > &tes, const TrigNavStructure *nav)
	Constructor; gets a vector of TE vectors and a pointer to Navigation as arguments. More...

bool	rewind ()
	Rewind method, resetting the iterator to the first element. More...

TEVec &	operator* ()
	Unary * operator, used to recover the current combination. More...

bool	isValid () const
	Validity check for the iterator. More...

TEVec &	combination ()
	Accessor method for the current combination. More...

ComboIterator &	operator++ (int)
	Post increment operator. More...

ComboIterator &	operator++ ()
	Pre increment operator. More...

Protected Member Functions
virtual bool	overlaps (const TriggerElement t1, const TriggerElement t2) const
	Method used to test overlaps between two TEs. More...

bool	overlaps (const TriggerElement *t1, const TEVec &teVec, int idx=-1) const
	Method used to test overlaps between a TE and a vector of TEs. More...

bool	incrementByOne (int pos, bool &ok)
	Private increment method. More...

bool	increment (int pos)
	Private increment method. More...

bool	reset (int pos)
	Private reset method. More...

void	invalidate ()
	Method used to invalidate the current combination. More...

void	print () const
	Debug dump to std::cout. More...

Protected Attributes
TEVec	m_comb
	Current combination of TEs. More...

std::vector< int >	m_idx
	Vector of indexes keeping track of the loop over combinations. More...

std::vector< TEVec >	m_tes
	Vector of vectors of TEs to be combined. More...

bool	m_valid
	Validity status variable. More...

const TrigNavStructure *	m_nav
	Pointer to the navigation service. More...

Detailed Description

Iterator used to loop over multi-particle combinations.

Author: Nicolas Berger Nicol.nosp@m.as.B.nosp@m.erger.nosp@m.@cer.nosp@m.n.ch - CERN

This iterator class is used by HLT algorithms to iterate over multi-particle combinations. Given a set of TEs, passed in the constructor, the iterator can be used to move over all the possible combinations of TEs. These combinations are built taking one TE from each of the vector of TEs passed in the constructor. So, as an example, to build all possible couples of TEs of the same type, the starting point will be a vector containing twice the same vector of TEs.

Definition at line 74 of file ComboIterator.h.

Constructor & Destructor Documentation

◆ ComboIterator()

HLT::ComboIterator::ComboIterator	(	const std::vector< TEVec > &	tes,
		const TrigNavStructure *	nav
	)

Constructor; gets a vector of TE vectors and a pointer to Navigation as arguments.

Parameters

tes	vector of subvectors of TEs, one for each input type. Each subvector is the list of all TEs of a given type in the event. The same type may appear multiple times in the case of identical input particle types.
nav	pointer to the navigation service.

Definition at line 15 of file ComboIterator.cxx.

   : m_valid(true),
     m_nav(nav)
  
 {
   for (unsigned int i = 0; i < tes.size(); i++) 
     m_tes.push_back(tes[i]);
  
   rewind();
 }

Member Function Documentation

◆ combination()

TEVec& HLT::ComboIterator::combination ( )

inlinevirtual

Accessor method for the current combination.

Implements HLT::ComboIteratorBase.

Definition at line 98 of file ComboIterator.h.

98 { return m_comb; }

◆ increment()

bool HLT::ComboIterator::increment ( int pos )

protected

Private increment method.

Definition at line 69 of file ComboIterator.cxx.

 {
   if (!isValid()) return false;
  
   bool ok = false;
   while (!ok) if (!incrementByOne(pos, ok)) return false;
  
   return ok;
 }

◆ incrementByOne()

bool HLT::ComboIterator::incrementByOne	(	int	pos,
		bool &	ok
	)

protected

Private increment method.

Definition at line 80 of file ComboIterator.cxx.

 {
   //  cout << "increment1 " << pos << endl;
  
   if (pos >= (int)m_comb.size() || pos < 0) return false;
  
   ok = false;
  
   // If we're at the end of the vector for this element, ...
   if (m_idx[pos] == (int)m_tes[pos].size() - 1) {
  
     // ... if it's the first (innermost-loop) one, we're done...
     if (pos == 0) return false;
  
     // ... otherwise increment the previous element by one...
     if (!increment(pos - 1)) return false;
  
     // ... reset this one...
     if (!reset(pos)) return false;
  
     // ... and increment it (from reset to valid).
     if (!increment(pos)) return false;
   }
   else {
   // else it's just the normal case,
  
     m_idx [pos]++;
     m_comb[pos] =  m_tes[pos][m_idx[pos]];
   }
  
   ok = !overlaps(m_comb[pos], m_comb, pos);
   //  cout << "after increment (pos=" << pos << ", ok=" << ok << ")" << endl; print();
  
   return true;
 }

◆ invalidate()

void HLT::ComboIterator::invalidate ( )

protected

Method used to invalidate the current combination.

Definition at line 189 of file ComboIterator.cxx.

 {
   //  cout << "-------------------------------" << endl;
   //  cout << "Invalidate!" << endl;
   //  cout << "-------------------------------" << endl;
   m_valid = false; 
   m_comb.clear(); 
 }

◆ isValid()

bool HLT::ComboIterator::isValid ( ) const

inlinevirtual

Validity check for the iterator.

Returns: result of the validity check; returns false if iterator is at end, true otherwise.

Implements HLT::ComboIteratorBase.

Definition at line 95 of file ComboIterator.h.

95 { return m_valid; }

◆ operator*()

TEVec& HLT::ComboIterator::operator* ( )

inlinevirtual

Unary * operator, used to recover the current combination.

Implements HLT::ComboIteratorBase.

Definition at line 90 of file ComboIterator.h.

90 { return combination(); }

◆ operator++() [1/2]

HLT::ComboIterator & HLT::ComboIterator::operator++ ( )

virtual

Pre increment operator.

Implements HLT::ComboIteratorBase.

Definition at line 58 of file ComboIterator.cxx.

 { 
   if (!increment((int)m_comb.size() - 1)) invalidate();
   //  cout << "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv" << endl;
   //  print();
   //  cout << "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^" << endl;
  
   return *this; 
 }

◆ operator++() [2/2]

ComboIterator& HLT::ComboIterator::operator++ ( int )

inlinevirtual

Post increment operator.

Implements HLT::ComboIteratorBase.

Definition at line 101 of file ComboIterator.h.

101 { return operator++(); }

◆ overlaps() [1/2]

bool HLT::ComboIterator::overlaps	(	const TriggerElement *	t1,
		const TEVec &	teVec,
		int	idx = `-1`
	)		const

protected

Method used to test overlaps between a TE and a vector of TEs.

Returns: result of the overlap test; returns true if the TE corresponds to the same RoI as one of the TEs in the vector, false otherwise.

Parameters

t1	TE to check.
teVec	TE vector to check.
idx	optional integer parameter, limiting the check over the 0..idx-1 range of the vector.

Definition at line 146 of file ComboIterator.cxx.

 {
   if (idx < 0) idx = teVec.size();
  
   for (int i = 0; i < idx; i++) {
     if (!teVec[i]) return false;
     if (overlaps(te1, teVec[i])) return true;
   }
  
   return false;
 }

◆ overlaps() [2/2]

bool HLT::ComboIterator::overlaps	(	const TriggerElement *	t1,
		const TriggerElement *	t2
	)		const

protectedvirtual

Method used to test overlaps between two TEs.

Returns: result of the overlap test; returns true if the two TEs correspond to the same RoI, false otherwise.

Parameters

t1	first TE to check.
t2	second TE to check.

Reimplemented in HLT::ComboIteratorTopo.

Definition at line 160 of file ComboIterator.cxx.

 {
   if (te1 == te2) return true;
   if (m_nav && m_nav->haveCommonRoI(te1, te2)) return true;
  
   return false;
 }

◆ print()

void HLT::ComboIterator::print ( ) const

protected

Debug dump to std::cout.

Definition at line 170 of file ComboIterator.cxx.

 {
   cout << endl;
   cout << "TEs:" << endl;
   cout << "{" << endl;
   for (unsigned int i = 0; i < m_tes.size(); i++) {
     cout << "  [ ";
     for (unsigned int j = 0; j < m_tes[i].size(); j++) cout << m_tes[i][j] << " ";
     cout << "]" << endl;
   }
   cout << "}" << endl << endl << "Comb = [ ";
   for (unsigned int i = 0; i < m_comb.size(); i++)  cout << m_comb[i] << " ";
   cout << "]" << endl << "Idxs = [ ";
   for (unsigned int i = 0; i < m_idx.size(); i++)  cout << m_idx[i] << " ";
   cout << "]" << endl;
   cout << (isValid() ? "Valid" : "Invalid") << endl << endl;
 }

◆ reset()

bool HLT::ComboIterator::reset ( int pos )

protected

Private reset method.

Definition at line 117 of file ComboIterator.cxx.

 {
   //  cout << "Reset : " << pos << endl;
  
   if (pos >= (int)m_comb.size() || pos < 0) return false;
  
   m_comb[pos] = 0; 
   m_idx [pos] = -1;
  
   
   // Find the previous element of the same type (if any), and get its index
   // in the vector of TEs of this type...    
   
   for (unsigned int j = pos; j > 0; j--) {
  
     if (!m_comb[j - 1]) continue;
  
     // Find the TE of the same type with the highest index
     if (m_comb[j - 1]->getId() == m_tes[pos][0]->getId()) {
       m_idx[pos] = m_idx[j - 1];
       break;
     }
   }
  
   //  cout << "reset to index = " << m_idx[pos] << endl;
   return 1;
 }

◆ rewind()

bool HLT::ComboIterator::rewind ( )

virtual

Rewind method, resetting the iterator to the first element.

Implements HLT::ComboIteratorBase.

Definition at line 27 of file ComboIterator.cxx.

 {
   m_comb.clear();
   m_idx.clear();
  
   //  cout << "Construct" << endl;
  
   for (unsigned int i = 0; i < m_tes.size(); i++) {
  
     if (m_tes[i].size() == 0) {
       invalidate();
       return 0;
     }
  
     m_comb.push_back(0);
     m_idx.push_back(-1);
  
     if (!reset(i) || !increment(i)) {
       invalidate(); 
       return 0;
     }
   }
  
   //  cout << "After setup: " << endl;
   //  cout << "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv" << endl;
   //  print();
   //  cout << "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^" << endl;
   return isValid();
 }

Member Data Documentation

◆ m_comb

TEVec HLT::ComboIterator::m_comb

protected

Current combination of TEs.

Definition at line 140 of file ComboIterator.h.

◆ m_idx

std::vector<int> HLT::ComboIterator::m_idx

protected

Vector of indexes keeping track of the loop over combinations.

Definition at line 143 of file ComboIterator.h.

◆ m_nav

const TrigNavStructure* HLT::ComboIterator::m_nav

protected

Pointer to the navigation service.

Definition at line 152 of file ComboIterator.h.

◆ m_tes

std::vector<TEVec> HLT::ComboIterator::m_tes

protected

Vector of vectors of TEs to be combined.

Definition at line 146 of file ComboIterator.h.

◆ m_valid

bool HLT::ComboIterator::m_valid

protected

Validity status variable.

Definition at line 149 of file ComboIterator.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ComboIterator()

Member Function Documentation

◆ combination()

◆ increment()

◆ incrementByOne()

◆ invalidate()

◆ isValid()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ overlaps() [1/2]

◆ overlaps() [2/2]

◆ print()

◆ reset()

◆ rewind()

Member Data Documentation

◆ m_comb

◆ m_idx

◆ m_nav

◆ m_tes

◆ m_valid