IPartCombItr.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGCOMPOSITEUTILS_IPARTCOMBITR_H
#define TRIGCOMPOSITEUTILS_IPARTCOMBITR_H
 
#include "xAODBase/IParticleContainer.h"
#include "TrigCompositeUtils/KFromNItr.h"
#include "TrigCompositeUtils/LinkInfo.h"
#include "TrigCompositeUtils/ProductItr.h"
 
#include <iterator>
#include <vector>
#include <tuple>
#include <functional>
 
 
namespace TrigCompositeUtils
{
 
  enum class FilterType
  {
    All,
    UniqueObjects,
    UniqueRoIs,
    UniqueInitialRoIs
  };

  bool uniqueObjects(const std::vector<LinkInfo<xAOD::IParticleContainer>> &links);
  bool uniqueInitialRoIs(const std::vector<LinkInfo<xAOD::IParticleContainer>> &links);
  bool uniqueRoIs(const std::vector<LinkInfo<xAOD::IParticleContainer>> &links);
 
  class IPartCombItr
  {
  public:
    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;

    static FilterFunc_t getFilter(FilterType filter);

    IPartCombItr();

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

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

    std::size_t size() const { return m_current.size(); }

    std::size_t nLegs() const { return m_linkInfoItrs.size(); }

    void reset();

    bool exhausted() const;

    reference operator*() const;
    pointer operator->() const;

    IPartCombItr &operator++();

    IPartCombItr operator++(int);

    bool operator==(const IPartCombItr &other) const;
    bool operator!=(const IPartCombItr &other) const;
 
  private:
    FilterFunc_t m_filter;
    std::vector<LInfoItr_t> m_linkInfoItrs;
    ProductItr<KFromNItr> m_idxItr;
    void readCurrent();
    VecLInfo_t m_current;
 
  }; //> end class IPartCombItr
} // namespace TrigCompositeUtils
 
#endif //> !TRIGCOMPOSITEUTILS_IPARTCOMBITR_H