TrigCompositeUtils::IPartCombItr Class Reference

#include <IPartCombItr.h>

Collaboration diagram for TrigCompositeUtils::IPartCombItr:

Public Types
using	VecLInfo_t = std::vector<LinkInfo<xAOD::IParticleContainer>>
using	LInfoItr_t = VecLInfo_t::const_iterator
using	FilterFunc_t = std::function<bool(const IPartCombItr::VecLInfo_t &)>
using	iterator_category = std::input_iterator_tag
using	value_type = VecLInfo_t
using	reference = const value_type &
using	pointer = const value_type *
using	difference_type = std::ptrdiff_t

Public Member Functions
	IPartCombItr ()
	A default constructed iterator acts as a past-the-end iterator.
	IPartCombItr (const std::vector< std::tuple< std::size_t, LInfoItr_t, LInfoItr_t > > &pieces, FilterFunc_t filter)
	The direct constructor.
	IPartCombItr (const std::vector< std::tuple< std::size_t, LInfoItr_t, LInfoItr_t > > &pieces, FilterType filter=FilterType::UniqueObjects)
	The direct constructor.
std::size_t	size () const
	The size of each combination.
std::size_t	nLegs () const
	The number of legs.
void	reset ()
	Reset the iterator to its starting point.
bool	exhausted () const
	True if this iterator is past the end.
reference	operator* () const
	Dereference.
pointer	operator-> () const
IPartCombItr &	operator++ ()
	Pre-increment operator.
IPartCombItr	operator++ (int)
	Post-increment operator.
bool	operator== (const IPartCombItr &other) const
	Iterator comparison functions.
bool	operator!= (const IPartCombItr &other) const

Static Public Member Functions
static FilterFunc_t	getFilter (FilterType filter)
	Get a function corresponding to the specified FilterType enum.

Private Member Functions
void	readCurrent ()

Private Attributes
FilterFunc_t	m_filter
std::vector< LInfoItr_t >	m_linkInfoItrs
ProductItr< KFromNItr >	m_idxItr
VecLInfo_t	m_current

Detailed Description

Definition at line 40 of file IPartCombItr.h.

Member Typedef Documentation

difference_type

using TrigCompositeUtils::IPartCombItr::difference_type = std::ptrdiff_t

Definition at line 51 of file IPartCombItr.h.

FilterFunc_t

using TrigCompositeUtils::IPartCombItr::FilterFunc_t = std::function<bool(const IPartCombItr::VecLInfo_t &)>

Definition at line 45 of file IPartCombItr.h.

iterator_category

using TrigCompositeUtils::IPartCombItr::iterator_category = std::input_iterator_tag

Definition at line 47 of file IPartCombItr.h.

LInfoItr_t

using TrigCompositeUtils::IPartCombItr::LInfoItr_t = VecLInfo_t::const_iterator

Definition at line 44 of file IPartCombItr.h.

pointer

using TrigCompositeUtils::IPartCombItr::pointer = const value_type *

Definition at line 50 of file IPartCombItr.h.

reference

using TrigCompositeUtils::IPartCombItr::reference = const value_type &

Definition at line 49 of file IPartCombItr.h.

value_type

using TrigCompositeUtils::IPartCombItr::value_type = VecLInfo_t

Definition at line 48 of file IPartCombItr.h.

VecLInfo_t

using TrigCompositeUtils::IPartCombItr::VecLInfo_t = std::vector<LinkInfo<xAOD::IParticleContainer>>

Definition at line 43 of file IPartCombItr.h.

Constructor & Destructor Documentation

IPartCombItr() [1/3]

TrigCompositeUtils::IPartCombItr::IPartCombItr

(

)

A default constructed iterator acts as a past-the-end iterator.

Definition at line 89 of file IPartCombItr.cxx.

{}

IPartCombItr() [2/3]

TrigCompositeUtils::IPartCombItr::IPartCombItr	(	const std::vector< std::tuple< std::size_t, LInfoItr_t, LInfoItr_t > > &	pieces,
		FilterFunc_t	filter )

The direct constructor.

Takes a vector of tuples. The last two elements of each tuple are start and end iterators describing ranges of IParticleContainer LinkInfos. The first element describes how many particles from this range are used in the output combinations

Definition at line 91 of file IPartCombItr.cxx.

      : m_filter(std::move(filter))
  {
    std::vector<KFromNItr> idxItrs;
    idxItrs.reserve(pieces.size());
    m_linkInfoItrs.reserve(pieces.size());
    std::size_t size = 0;
    for (const auto &tup : pieces)
    {
      std::size_t multiplicity = std::get<0>(tup);
      LInfoItr_t begin = std::get<1>(tup);
      LInfoItr_t end = std::get<2>(tup);
      idxItrs.emplace_back(multiplicity, std::distance(begin, end));
      m_linkInfoItrs.push_back(begin);
      size += multiplicity;
    }
    m_idxItr = ProductItr<KFromNItr>(idxItrs, std::vector<KFromNItr>(idxItrs.size()));
    m_current.assign(size, {});
    readCurrent();
  }

IPartCombItr() [3/3]

TrigCompositeUtils::IPartCombItr::IPartCombItr	(	const std::vector< std::tuple< std::size_t, LInfoItr_t, LInfoItr_t > > &	pieces,
		FilterType	filter = FilterType::UniqueObjects )

The direct constructor.

Takes a vector of tuples. The last two elements of each tuple are start and end iterators describing ranges of IParticleContainer LinkInfos. The first element describes how many particles from this range are used in the output combinations

Definition at line 114 of file IPartCombItr.cxx.

      : IPartCombItr(pieces, getFilter(filter))
  {
  }

Member Function Documentation

exhausted()

bool TrigCompositeUtils::IPartCombItr::exhausted

(

)

const

True if this iterator is past the end.

Definition at line 128 of file IPartCombItr.cxx.

  {
    return m_idxItr.exhausted();
  }

getFilter()

IPartCombItr::FilterFunc_t TrigCompositeUtils::IPartCombItr::getFilter ( FilterType filter )

static

Get a function corresponding to the specified FilterType enum.

Definition at line 75 of file IPartCombItr.cxx.

  {
    switch (filter){
    case FilterType::All:
      return [](const VecLInfo_t &) { return true; };
    case FilterType::UniqueObjects:
      return uniqueObjects;
    case FilterType::UniqueRoIs:
      return uniqueRoIs;
    default:
      throw std::runtime_error("Unhandled FilterType enum value!");
    }
  }

nLegs()

std::size_t TrigCompositeUtils::IPartCombItr::nLegs ( ) const

inline

The number of legs.

Definition at line 89 of file IPartCombItr.h.

{ return m_linkInfoItrs.size(); }

operator!=()

bool TrigCompositeUtils::IPartCombItr::operator!=

(

const IPartCombItr &

other

)

const

Definition at line 172 of file IPartCombItr.cxx.

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

operator*()

IPartCombItr::reference TrigCompositeUtils::IPartCombItr::operator*

(

)

const

Dereference.

Definition at line 133 of file IPartCombItr.cxx.

  {
    if (exhausted())
      throw std::runtime_error("Dereferencing past-the-end iterator");
    return m_current;
  }

operator++() [1/2]

IPartCombItr & TrigCompositeUtils::IPartCombItr::operator++

(

)

Pre-increment operator.

Definition at line 147 of file IPartCombItr.cxx.

  {
    if (exhausted())
      // Don't iterate an iterator that is already past the end
      return *this;
    ++m_idxItr;
    readCurrent();
    return *this;
  }

operator++() [2/2]

IPartCombItr TrigCompositeUtils::IPartCombItr::operator++

(

int

)

Post-increment operator.

Definition at line 157 of file IPartCombItr.cxx.

  {
    IPartCombItr ret(*this);
    this->operator++();
    return ret;
  }

operator->()

IPartCombItr::pointer TrigCompositeUtils::IPartCombItr::operator->

(

)

const

Definition at line 140 of file IPartCombItr.cxx.

  {
    if (exhausted())
      throw std::runtime_error("Dereferencing past-the-end iterator");
    return &m_current;
  }

operator==()

bool TrigCompositeUtils::IPartCombItr::operator==

(

const IPartCombItr &

other

)

const

Iterator comparison functions.

Definition at line 164 of file IPartCombItr.cxx.

  {
    // All past-the-end iterators compare equal
    if (exhausted() && other.exhausted())
      return true;
    return m_idxItr == other.m_idxItr && m_linkInfoItrs == other.m_linkInfoItrs;
  }

readCurrent()

void TrigCompositeUtils::IPartCombItr::readCurrent ( )

private

Definition at line 177 of file IPartCombItr.cxx.

  {
    if (exhausted())
      m_current.assign(m_current.size(), {});
    else
    {
      auto currentItr = m_current.begin();
      for (std::size_t iLeg = 0; iLeg < nLegs(); ++iLeg)
      {
        std::vector<std::size_t> indices = *(*m_idxItr)[iLeg];
        for (std::size_t idx : indices)
            *(currentItr++) = *(m_linkInfoItrs[iLeg] + idx);
      }
      if (!m_filter(m_current))
        // If we fail the filter condition, advance the iterator again
        this->operator++();
    }
  }

reset()

void TrigCompositeUtils::IPartCombItr::reset

(

)

Reset the iterator to its starting point.

Note that this resets all component iterators, so it will not reset this object to its starting point if any of the iterators passed to it were not initially in their starting positions

Definition at line 121 of file IPartCombItr.cxx.

  {
    // Reset each individual iterator and set our current value accordingly
    m_idxItr.reset();
    readCurrent();
  }

size()

std::size_t TrigCompositeUtils::IPartCombItr::size ( ) const

inline

The size of each combination.

Definition at line 86 of file IPartCombItr.h.

{ return m_current.size(); }

Member Data Documentation

m_current

VecLInfo_t TrigCompositeUtils::IPartCombItr::m_current

private

Definition at line 122 of file IPartCombItr.h.

m_filter

FilterFunc_t TrigCompositeUtils::IPartCombItr::m_filter

private

Definition at line 118 of file IPartCombItr.h.

m_idxItr

ProductItr<KFromNItr> TrigCompositeUtils::IPartCombItr::m_idxItr

private

Definition at line 120 of file IPartCombItr.h.

m_linkInfoItrs

std::vector<LInfoItr_t> TrigCompositeUtils::IPartCombItr::m_linkInfoItrs

private

Definition at line 119 of file IPartCombItr.h.

---

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

• IPartCombItr.h
• IPartCombItr.cxx