BuildCombinations.icc

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
namespace DerivationFramework { namespace TriggerMatchingUtils {
 
  template <typename T, typename PROJ>
    bool insertIntoSortedVector(std::vector<T>& vec, const T& ele,
                                PROJ proj)
    {
      auto itr = std::ranges::lower_bound(vec, proj(ele), {}, proj);
      // if no lower bound is found or the found element doesn't equal ele then
      // insert ele at this point
      if (itr == vec.end() || *itr != ele) {
        vec.insert(itr, ele);
        return true;
      }
      else
        return false;
    }
 
  template <typename R, typename PROJ>
    std::vector<typename R::value_type> sorted(const R& r, PROJ proj)
    {
      std::vector<typename R::value_type> output(std::begin(r), std::end(r));
      std::ranges::sort(output, {}, proj);
      return output;
    }
  
 
  template <typename T, typename INNERPROJ, typename OUTERPROJ>
    std::vector<std::vector<T>> getAllDistinctCombinations(
        std::vector<RangedItr<typename std::vector<T>::const_iterator>>& inputs,
        INNERPROJ innerproj,
        OUTERPROJ outerproj)
  {
    // This is where the output will go
    std::vector<std::vector<T>> output;
 
    // If inputs is empty or if any of the ranges within inputs are empty then
    // no combinations will be found!
    if (inputs.empty() || std::any_of(inputs.begin(), inputs.end(),
          [] (const auto& rangedItr) { return rangedItr.exhausted(); }) )
      return output;
 
    // This is the current output combination being built
    std::vector<T> currentCombination;
 
    // This iterator points to where in the vector of ranged iterators we are
    // looking. This can therefore often be acting as an iterator to and
    // iterator! *itr is an iterator, **itr is a const T&!
    // To disambiguate I will refer to itr as the outer iterator and *itr as the
    // inner iterator.
    auto itr = inputs.begin();
    while (true) {
      // Have we exhausted our current inner iterator?
      if (itr == inputs.end() || itr->exhausted() ) {
        // If the outer iterator has returned to the beginning then we're done
        // and every combination has been checked.
        if (itr == inputs.begin() )
          break;
        // otherwise we need to continue. To do this we
        // - reset the current inner iterator. This is so that the next time we
        //   return to it we look through all the elements again
        // - step the outer iterator back
        // - remove the last element of the current combination. That
        //   element will be replaced by the next valid one from the list *now*
        //   pointed to by the outer iterator.
        if (itr != inputs.end() )
          itr->restart();
        --itr;
        currentCombination.pop_back();
      } //> end if inner iterator is exhausted
      else {
        // Check if the pointed-to element is already in the current combination
        const T& currentCandidate = **itr;
        // Now that we've accessed this value, step past it
        ++*itr;
        if (std::find(
              currentCombination.begin(), 
              currentCombination.end(), 
              currentCandidate) == currentCombination.end() ) {
          // If it isn't, then add it.
          currentCombination.push_back(currentCandidate);
          // Step the outer iterator forwards so we're looking at the next list
          ++itr;
          if (itr == inputs.end() ) {
            // If we're at the end then this is a complete combination, add it
            // to the output.
            insertIntoSortedVector(output,
                                   sorted(currentCombination, innerproj),
                                   outerproj);
          }
        } //> end if currentCandidate is in currentCombination
      } //> end else (if inner iterator is exhausted)
    } //> end while loop
    return output;
  } //> end function getAllDistinctCombinations
 
}} //> end namespace DerivationFramework::TriggerMatchingUtils