edm::ThinnedAssociationsHelper Class Reference

#include <ThinnedAssociationsHelper.h>

Public Member Functions
void	addAssociation (BranchID const &, BranchID const &, BranchID const &, bool slimmed)
void	addAssociation (ThinnedAssociationBranches const &)
std::vector< std::pair< BranchID, ThinnedAssociationBranches const * > >	associationToBranches () const
std::vector< ThinnedAssociationBranches >::const_iterator	begin () const
void	clear ()
std::vector< ThinnedAssociationBranches > const &	data () const
std::vector< ThinnedAssociationBranches >::const_iterator	end () const
void	initAssociationsFromSecondary (std::vector< BranchID > const &, ThinnedAssociationsHelper const &)
std::vector< ThinnedAssociationBranches >::const_iterator	parentBegin (BranchID const &) const
std::vector< ThinnedAssociationBranches >::const_iterator	parentEnd (BranchID const &) const
void	requireMatch (ThinnedAssociationBranches const &input) const
void	selectAssociationProducts (std::vector< BranchDescription const * > const &associationDescriptions, std::set< BranchID > const &keptProductsInEvent, std::map< BranchID, bool > &keepAssociation) const
	ThinnedAssociationsHelper ()
void	updateFromParentProcess (ThinnedAssociationsHelper const &parentThinnedAssociationsHelper, std::map< BranchID, bool > const &keepAssociation, std::map< BranchID::value_type, BranchID::value_type > const &droppedBranchIDToKeptBranchID)
void	updateFromPrimaryInput (ThinnedAssociationsHelper const &)
void	updateFromSecondaryInput (ThinnedAssociationsHelper const &, std::vector< BranchID > const &associationsFromSecondary)

Private Member Functions
void	ensureSlimmingConstraints () const
std::vector< ThinnedAssociationBranches >::const_iterator	lower_bound (ThinnedAssociationBranches const &branches) const
bool	shouldKeepAssociation (BranchID const &association, std::vector< std::pair< BranchID, ThinnedAssociationBranches const * > > const &associationToBranches, std::set< BranchID > &branchesInRecursion, std::set< BranchID > const &keptProductsInEvent, std::map< BranchID, bool > &keepAssociation) const

Private Attributes
std::vector< ThinnedAssociationBranches >	vThinnedAssociationBranches_

Detailed Description

Author

W. David Dagenhart, created 11 June 2014

Definition at line 37 of file ThinnedAssociationsHelper.h.

Constructor & Destructor Documentation

ThinnedAssociationsHelper()

edm::ThinnedAssociationsHelper::ThinnedAssociationsHelper

(

)

Definition at line 18 of file ThinnedAssociationsHelper.cc.

{}

Member Function Documentation

addAssociation() [1/2]

void edm::ThinnedAssociationsHelper::addAssociation	(	BranchID const &	parent,
		BranchID const &	association,
		BranchID const &	thinned,
		bool	slimmed
	)

Definition at line 61 of file ThinnedAssociationsHelper.cc.

                                                               {
    addAssociation(ThinnedAssociationBranches(parent, association, thinned, slimmed));
  }

References class-composition::parent.

Referenced by initAssociationsFromSecondary(), edm::ThinningProducer< Collection, Selector >::registerThinnedAssociations(), and updateFromParentProcess().

addAssociation() [2/2]

void edm::ThinnedAssociationsHelper::addAssociation

(

ThinnedAssociationBranches const &

branches

)

Definition at line 68 of file ThinnedAssociationsHelper.cc.

                                                                                           {
    vThinnedAssociationBranches_.insert(lower_bound(branches), branches);
    if (branches.isSlimmed()) {
      try {
        ensureSlimmingConstraints();
      } catch (edm::Exception& ex) {
        ex.addContext("Calling ThinnedAssociationsHelper::addAssociation()");
        ex.addAdditionalInfo(fmt::format("When adding a slimmed collection with BranchID {}", branches.thinned().id()));
        throw ex;
      }
    }
  }

References cms::Exception::addAdditionalInfo(), cms::Exception::addContext(), ensureSlimmingConstraints(), dqm-mbProfile::format, edm::BranchID::id(), edm::ThinnedAssociationBranches::isSlimmed(), lower_bound(), edm::ThinnedAssociationBranches::thinned(), and vThinnedAssociationBranches_.

associationToBranches()

std::vector< std::pair< BranchID, ThinnedAssociationBranches const * > > edm::ThinnedAssociationsHelper::associationToBranches

(

)

const

Definition at line 176 of file ThinnedAssociationsHelper.cc.

            {
    std::vector<std::pair<BranchID, ThinnedAssociationBranches const*>> temp;
    for (auto const& item : vThinnedAssociationBranches_) {
      temp.push_back(std::make_pair(item.association(), &item));
    }
    std::sort(temp.begin(),
              temp.end(),
              [](std::pair<BranchID, ThinnedAssociationBranches const*> const& x,
                 std::pair<BranchID, ThinnedAssociationBranches const*> const& y) { return x.first < y.first; });
    return temp;
  }

References B2GTnPMonitor_cfi::item, jetUpdater_cfi::sort, groupFilesInBlocks::temp, and vThinnedAssociationBranches_.

Referenced by initAssociationsFromSecondary(), selectAssociationProducts(), and shouldKeepAssociation().

begin()

std::vector< ThinnedAssociationBranches >::const_iterator edm::ThinnedAssociationsHelper::begin

(

void

)

const

Definition at line 20 of file ThinnedAssociationsHelper.cc.

                                                                                             {
    return vThinnedAssociationBranches_.begin();
  }

References vThinnedAssociationBranches_.

Referenced by ensureSlimmingConstraints(), and edm::detail::getThinnedKeyFrom_implementation().

clear()

void edm::ThinnedAssociationsHelper::clear ( void  )

inline

Definition at line 52 of file ThinnedAssociationsHelper.h.

{ vThinnedAssociationBranches_.clear(); }

References vThinnedAssociationBranches_.

Referenced by BeautifulSoup.Tag::setString(), and updateFromParentProcess().

data()

std::vector<ThinnedAssociationBranches> const& edm::ThinnedAssociationsHelper::data ( ) const

inline

Definition at line 58 of file ThinnedAssociationsHelper.h.

{ return vThinnedAssociationBranches_; }

References vThinnedAssociationBranches_.

Referenced by updateFromParentProcess().

end()

std::vector< ThinnedAssociationBranches >::const_iterator edm::ThinnedAssociationsHelper::end

(

void

)

const

Definition at line 24 of file ThinnedAssociationsHelper.cc.

                                                                                           {
    return vThinnedAssociationBranches_.end();
  }

References vThinnedAssociationBranches_.

Referenced by Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), ensureSlimmingConstraints(), and edm::detail::getThinnedKeyFrom_implementation().

ensureSlimmingConstraints()

void edm::ThinnedAssociationsHelper::ensureSlimmingConstraints ( ) const

private

Definition at line 144 of file ThinnedAssociationsHelper.cc.

                                                                  {
    // ThinnedAssociationBranches defines an edge between a parent and
    // a thinned collection in the parentage tree of the thinned
    // collections. It is required that for a given parentage tree
    // there is at most one path from the root node to any leaf nodes
    // that has slimming edges.
 
    std::vector<::SlimmedCount> counts;
    BranchID prevParent;
    std::vector<SlimmedCount>::iterator currentCount;
    for (auto iItem = begin(), iEnd = end(); iItem != iEnd; ++iItem) {
      if (iItem->parent() == BranchID()) {
        continue;
      }
      if (iItem->parent() == prevParent) {
        addSlimmingChildrenCount(*this, *iItem, counts, currentCount->slimmedChildrenCount);
      } else {
        currentCount = std::lower_bound(
            counts.begin(), counts.end(), iItem->parent(), [](SlimmedCount const& c, BranchID const& b) {
              return c.parent < b;
            });
        // has the tree with iItem->parent() as root node already been counted?
        if (currentCount != counts.end() && currentCount->parent == iItem->parent()) {
          continue;
        }
        currentCount = counts.insert(currentCount, ::SlimmedCount{iItem->parent(), 0});
        addSlimmingChildrenCount(*this, *iItem, counts, currentCount->slimmedChildrenCount);
        prevParent = iItem->parent();
      }
    }
  }

References b, begin(), c, dqmiodumpmetadata::counts, end(), and pfDeepBoostedJetPreprocessParams_cfi::lower_bound.

Referenced by addAssociation().

initAssociationsFromSecondary()

void edm::ThinnedAssociationsHelper::initAssociationsFromSecondary	(	std::vector< BranchID > const &	associationsFromSecondary,
		ThinnedAssociationsHelper const &	fileAssociationsHelper
	)

Definition at line 337 of file ThinnedAssociationsHelper.cc.

                                                                                                                     {
    if (associationsFromSecondary.empty())
      return;
 
    std::vector<std::pair<BranchID, ThinnedAssociationBranches const*>> assocToBranches =
        fileAssociationsHelper.associationToBranches();
 
    for (BranchID const& association : associationsFromSecondary) {
      auto branches = std::lower_bound(
          assocToBranches.begin(),
          assocToBranches.end(),
          std::make_pair(association, static_cast<ThinnedAssociationBranches const*>(nullptr)),
          [](std::pair<BranchID, ThinnedAssociationBranches const*> const& x,
             std::pair<BranchID, ThinnedAssociationBranches const*> const& y) { return x.first < y.first; });
      // This should never happen
      if (branches == assocToBranches.end() || branches->first != association) {
        throw edm::Exception(errors::LogicError,
                             "ThinnedAssociationHelper::initAssociationsFromSecondary could not find branches "
                             "information, contact Framework developers");
      }
      addAssociation(*(branches->second));
    }
  }

References addAssociation(), associationToBranches(), Exception, edm::errors::LogicError, and pfDeepBoostedJetPreprocessParams_cfi::lower_bound.

lower_bound()

std::vector< ThinnedAssociationBranches >::const_iterator edm::ThinnedAssociationsHelper::lower_bound ( ThinnedAssociationBranches const &  branches ) const

private

Definition at line 50 of file ThinnedAssociationsHelper.cc.

                                                        {
    return std::lower_bound(
        vThinnedAssociationBranches_.begin(),
        vThinnedAssociationBranches_.end(),
        branches,
        [](ThinnedAssociationBranches const& x, ThinnedAssociationBranches const& y) {
          return x.parent() < y.parent() ? true : y.parent() < x.parent() ? false : x.association() < y.association();
        });
  }

References funct::false, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, funct::true, and vThinnedAssociationBranches_.

Referenced by addAssociation().

parentBegin()

std::vector< ThinnedAssociationBranches >::const_iterator edm::ThinnedAssociationsHelper::parentBegin

(

BranchID const &

parent

)

const

Definition at line 28 of file ThinnedAssociationsHelper.cc.

                                    {
    ThinnedAssociationBranches target(parent, BranchID(), BranchID(), false);
    return std::lower_bound(vThinnedAssociationBranches_.begin(),
                            vThinnedAssociationBranches_.end(),
                            target,
                            [](ThinnedAssociationBranches const& x, ThinnedAssociationBranches const& y) {
                              return x.parent() < y.parent();
                            });
  }

References pfDeepBoostedJetPreprocessParams_cfi::lower_bound, class-composition::parent, filterCSVwithJSON::target, and vThinnedAssociationBranches_.

Referenced by edm::detail::getThinnedKeyFrom_implementation(), edm::detail::getThinnedProductOnSlimmingDepth(), edm::detail::getThinnedProductsOnSlimmingDepth(), requireMatch(), and shouldKeepAssociation().

parentEnd()

std::vector< ThinnedAssociationBranches >::const_iterator edm::ThinnedAssociationsHelper::parentEnd

(

BranchID const &

parent

)

const

Definition at line 39 of file ThinnedAssociationsHelper.cc.

                                    {
    ThinnedAssociationBranches target(parent, BranchID(), BranchID(), false);
    return std::upper_bound(vThinnedAssociationBranches_.begin(),
                            vThinnedAssociationBranches_.end(),
                            target,
                            [](ThinnedAssociationBranches const& x, ThinnedAssociationBranches const& y) {
                              return x.parent() < y.parent();
                            });
  }

References class-composition::parent, filterCSVwithJSON::target, pfDeepBoostedJetPreprocessParams_cfi::upper_bound, and vThinnedAssociationBranches_.

Referenced by edm::detail::getThinnedKeyFrom_implementation(), edm::detail::getThinnedProductOnSlimmingDepth(), edm::detail::getThinnedProductsOnSlimmingDepth(), requireMatch(), and shouldKeepAssociation().

requireMatch()

void edm::ThinnedAssociationsHelper::requireMatch

(

ThinnedAssociationBranches const &

input

)

const

Definition at line 263 of file ThinnedAssociationsHelper.cc.

                                                                                            {
    bool foundMatch = false;
    for (auto entry = parentBegin(input.parent()), iEnd = parentEnd(input.parent()); entry != iEnd; ++entry) {
      if (entry->association() == input.association() && entry->thinned() == input.thinned()) {
        foundMatch = true;
        break;
      }
    }
    if (!foundMatch) {
      throw edm::Exception(
          errors::MismatchedInputFiles,
          "ThinnedAssociationHelper::requireMatch, Illegal attempt to merge files with different ThinnedAssociations");
    }
  }

References mps_splice::entry, Exception, input, edm::errors::MismatchedInputFiles, parentBegin(), and parentEnd().

Referenced by updateFromPrimaryInput(), and updateFromSecondaryInput().

selectAssociationProducts()

void edm::ThinnedAssociationsHelper::selectAssociationProducts	(	std::vector< BranchDescription const * > const &	associationDescriptions,
		std::set< BranchID > const &	keptProductsInEvent,
		std::map< BranchID, bool > &	keepAssociation
	)		const

Definition at line 189 of file ThinnedAssociationsHelper.cc.

                                                     {
    keepAssociation.clear();
    // Copy the elements in vThinnedAssociationBranches_ into a vector sorted on
    // the association BranchID so we can do searches on that BranchID faster.
    std::vector<std::pair<BranchID, ThinnedAssociationBranches const*>> assocToBranches = associationToBranches();
 
    for (auto association : associationDescriptions) {
      if (association
              ->isAlias()) {  // There is no reason to configure an association product with an EDAlias (ignore and drop them if they exist)
        keepAssociation.insert(std::make_pair(association->branchID(), false));
      } else {
        std::set<BranchID> branchesInRecursion;
        shouldKeepAssociation(
            association->branchID(), assocToBranches, branchesInRecursion, keptProductsInEvent, keepAssociation);
      }
    }
  }

References associationToBranches(), and shouldKeepAssociation().

Referenced by edm::SubProcess::selectProducts(), edm::global::OutputModuleBase::selectProducts(), edm::limited::OutputModuleBase::selectProducts(), and edm::one::OutputModuleBase::selectProducts().

shouldKeepAssociation()

bool edm::ThinnedAssociationsHelper::shouldKeepAssociation ( BranchID const &  association, std::vector< std::pair< BranchID, ThinnedAssociationBranches const * > > const &  associationToBranches, std::set< BranchID > &  branchesInRecursion, std::set< BranchID > const &  keptProductsInEvent, std::map< BranchID, bool > &  keepAssociation  ) const

private

Definition at line 210 of file ThinnedAssociationsHelper.cc.

                                                     {
    // If we already decided to keep or drop this one, then
    // return the same decision.
    auto decision = keepAssociation.find(association);
    if (decision != keepAssociation.end()) {
      return decision->second;
    }
 
    // Be careful not to fall into an infinite loop because
    // of a circular recursion.
    if (!branchesInRecursion.insert(association).second) {
      return false;
    }
 
    // If the thinned collection is being kept then keep the association
    auto branches = std::lower_bound(
        associationToBranches.begin(),
        associationToBranches.end(),
        std::make_pair(association, static_cast<ThinnedAssociationBranches const*>(nullptr)),
        [](std::pair<BranchID, ThinnedAssociationBranches const*> const& x,
           std::pair<BranchID, ThinnedAssociationBranches const*> const& y) { return x.first < y.first; });
    // This should never happen
    if (branches == associationToBranches.end() || branches->first != association) {
      throw edm::Exception(errors::LogicError,
                           "ThinnedAssociationHelper::shouldKeepAssociation could not find branches information, "
                           "contact Framework developers");
    }
    BranchID const& thinnedCollection = branches->second->thinned();
    if (keptProductsInEvent.find(thinnedCollection) != keptProductsInEvent.end()) {
      keepAssociation.insert(std::make_pair(association, true));
      return true;
    }
    // otherwise loop over any associations where the thinned collection
    // is also a parent collection and recursively examine those to see
    // if their thinned collections are being kept.
    auto iterEnd = parentEnd(thinnedCollection);
    for (auto match = parentBegin(thinnedCollection); match != iterEnd; ++match) {
      if (shouldKeepAssociation(
              match->association(), associationToBranches, branchesInRecursion, keptProductsInEvent, keepAssociation)) {
        keepAssociation.insert(std::make_pair(association, true));
        return true;
      }
    }
    // drop the association
    keepAssociation.insert(std::make_pair(association, false));
    return false;
  }

References associationToBranches(), Exception, edm::errors::LogicError, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, edm::match(), parentBegin(), parentEnd(), and edm::ThinnedAssociationBranches::thinned().

Referenced by selectAssociationProducts().

updateFromParentProcess()

void edm::ThinnedAssociationsHelper::updateFromParentProcess	(	ThinnedAssociationsHelper const &	parentThinnedAssociationsHelper,
		std::map< BranchID, bool > const &	keepAssociation,
		std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID
	)

Definition at line 314 of file ThinnedAssociationsHelper.cc.

                                                                                           {
    clear();
    for (auto const& associationBranches : parentThinnedAssociationsHelper.data()) {
      auto keep = keepAssociation.find(associationBranches.association());
      if (keep != keepAssociation.end() && keep->second) {
        BranchID parent = associationBranches.parent();
        auto iter = droppedBranchIDToKeptBranchID.find(parent.id());
        if (iter != droppedBranchIDToKeptBranchID.end()) {
          parent = BranchID(iter->second);
        }
        BranchID thinned = associationBranches.thinned();
        iter = droppedBranchIDToKeptBranchID.find(thinned.id());
        if (iter != droppedBranchIDToKeptBranchID.end()) {
          thinned = BranchID(iter->second);
        }
        addAssociation(parent, associationBranches.association(), thinned, associationBranches.isSlimmed());
      }
    }
  }

References addAssociation(), clear(), data(), edm::BranchID::id(), keep, and class-composition::parent.

updateFromPrimaryInput()

void edm::ThinnedAssociationsHelper::updateFromPrimaryInput

(

ThinnedAssociationsHelper const &

helper

)

Definition at line 278 of file ThinnedAssociationsHelper.cc.

                                                                                                {
    if (vThinnedAssociationBranches_.empty()) {
      vThinnedAssociationBranches_ = helper.data();
      return;
    }
    std::vector<ThinnedAssociationBranches> const& inputData = helper.data();
    for (auto const& inputEntry : inputData) {
      requireMatch(inputEntry);
    }
  }

References requireMatch(), and vThinnedAssociationBranches_.

Referenced by edm::StreamerInputSource::mergeIntoRegistry().

updateFromSecondaryInput()

void edm::ThinnedAssociationsHelper::updateFromSecondaryInput	(	ThinnedAssociationsHelper const &	helper,
		std::vector< BranchID > const &	associationsFromSecondary
	)

Definition at line 289 of file ThinnedAssociationsHelper.cc.

                                                                                                                 {
    if (associationsFromSecondary.empty())
      return;
 
    std::vector<std::pair<BranchID, ThinnedAssociationBranches const*>> assocToBranches =
        helper.associationToBranches();
 
    for (BranchID const& association : associationsFromSecondary) {
      auto branches = std::lower_bound(
          assocToBranches.begin(),
          assocToBranches.end(),
          std::make_pair(association, static_cast<ThinnedAssociationBranches const*>(nullptr)),
          [](std::pair<BranchID, ThinnedAssociationBranches const*> const& x,
             std::pair<BranchID, ThinnedAssociationBranches const*> const& y) { return x.first < y.first; });
      // This should never happen
      if (branches == assocToBranches.end() || branches->first != association) {
        throw edm::Exception(errors::LogicError,
                             "ThinnedAssociationHelper::initAssociationsFromSecondary could not find branches "
                             "information, contact Framework developers");
      }
      requireMatch(*(branches->second));
    }
  }

References Exception, edm::errors::LogicError, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, and requireMatch().

Member Data Documentation

vThinnedAssociationBranches_

std::vector<ThinnedAssociationBranches> edm::ThinnedAssociationsHelper::vThinnedAssociationBranches_

private

Definition at line 86 of file ThinnedAssociationsHelper.h.

Referenced by addAssociation(), associationToBranches(), begin(), clear(), data(), end(), lower_bound(), parentBegin(), parentEnd(), and updateFromPrimaryInput().