edm::RefToBase is deprecated #42737
Comments
|
A new Issue was created by @makortel Matti Kortelainen. @Dr15Jones, @rappoccio, @smuzaffar, @makortel, @sextonkennedy, @antoniovilela can you please review it and eventually sign/assign? Thanks. cms-bot commands are listed here |
|
assign core, reconstruction, simulation, fastsim, analysis, pdmv, dqm, xpog FYI @cms-sw/egamma-pog-l2 @cms-sw/tracking-pog-l2 @cms-sw/muon-pog-l2 @cms-sw/tau-pog-l2 @cms-sw/jetmet-pog-l2 (the list is quite possibly incomplete) |
|
New categories assigned: fastsim,core,xpog,pdmv,analysis,simulation,reconstruction,dqm @mdhildreth,@mdhildreth,@jfernan2,@sbein,@ssekmen,@bbilin,@tjavaid,@AdrianoDee,@micsucmed,@nothingface0,@rvenditti,@miquork,@Dr15Jones,@smuzaffar,@emanueleusai,@syuvivida,@sunilUIET,@simonepigazzini,@makortel,@mandrenguyen,@tvami,@vlimant,@civanch,@civanch,@pmandrik you have been requested to review this Pull request/Issue and eventually sign? Thanks |
ROOT is eventually deprecating the current
TTreedata storage in favor of their newRNTuple. TheRNTupleis not planned to support dynamic polymorphism. One such use case in our data formats isedm::RefToBase<T>that internally uses dynamic-polymorphism based type erasure. The straightforward migration path is towardsedm::Ptr<T>, but there are also many cases where the use ofedm::RefToBase<T>could be cleaned up. The purpose of this issue is to list all the current uses ofedm::RefToBase<T>, discuss how to address them, and track progress.1. Only dictionary declarations and/or type aliases and/or commented-out code, otherwise unused
All of these can be easily removed without impacting anything
These are partially addressed in #43055
edm::RefToBase<reco::BaseTagInfo>edm::RefToBase<reco::PhotonCore>,edm::RefToBaseVector<reco::PhotonCore>edm::RefToBase<reco::GsfElectronCore>,edm::RefToBaseVector<reco::GsfElectronCore>edm::RefToBase<reco::ElectronSeed>edm::RefToBase<L2MuonTrajectorySeed>edm::RefToBase<L3MuonTrajectorySeed>edm::RefToBase<reco::ConvBremSeed>edm::RefToBase<reco::PFTau>,edm::RefToBaseVector<reco::PFTau>edm::RefToBase<PSimHit>TrackPSimHitRefToBase,TrackPSimHitRefToBaseVectoredm::RefToBase<CompositeCandidate>edm::RefToBaseVector<CompositeCandidate>edm::RefToBase<NamedCompositeCandidate>edm::RefToBaseVector<NamedCompositeCandidate>edm::RefToBase<VertexCompositeCandidate>edm::RefToBaseVector<VertexCompositeCandidate>edm::RefToBase<VertexCompositePtrCandidate>edm::RefToBaseVector<VertexCompositePtrCandidate>2. Referenced-to class appear to be unused
The unused code could be removed. At minimum the dictionaries and/or type aliases should be removed.
These are addressed in #43080
edm::RefToBase<reco::WMuNuCandidatePtr>,edm::RefToBaseVector<reco::WMuNuCandidatePtr>reco::WMuNuCandidatePtrseems to be unusededm::RefToBase<reco::WMuNuCandidate>,edm::RefToBaseVector<reco::WMuNuCandidate>reco::WMuNuCandidateseems to be unusededm::RefToBase<CaloRecHit>CaloRecHitRefCaloRecHitCandidate, but not elsewhere?CaloRecHitCandidateseems to be only produced byCaloRecHitCandidateProducer<T>(asedm::OwnVector<Candidate>). Unclear if anything consumes. The template instantiations seem to be unused.edm::RefToBase<CaloRecHit>andCaloRecHitCandidateedm::Ptr<CaloRecHit>3. Other uses in addition of unused dictionary declarations
Remove the dictionaries, and replace the uses of
edm::RefToBase<T>withedm::Ptr<T>. These classes are used also in the EDProducer template instantiations listed in section 6, so the dictionaries can not be removed until the production ofedm::RefToBaseVector<T>there have been removed.edm::RefToBase<reco::Photon>,edm::RefToBaseVector<reco::Photon>edm::RefToBase<reco::Electron>,edm::RefToBaseVector<reco::Electron>edm::RefToBase<reco::GsfElectron>,edm::RefToBaseVector<reco::GsfElectron>4. Seemingly unused class template instantiations
Remove the class template instantiations.
Used only via instantiation of
TriggerMatchProducer<T>andTriggerCandProducer<T>class templates:edm::RefToBaseVector<reco::RecoChargedCandidate>edm::RefToBaseVector<reco::RecoEcalCandidate>edm::RefToBaseVector<reco::SuperCluster>Used only via instantiation of
TriggerCandProducer<T>class template:edm::RefToBaseVector<reco::IsolatedPixelTrackCandidate>Used in instantiation of
TriggerMatchProducer<T>andTriggerCandProducer<T>, and also inpat::METconstructor (replace that use withedm::Ptr<reco::MET>):edm::RefToBaseVector<reco::MET>5. Referenced-to class
Tis a base classThe
edm::RefToBase<T>andedm::RefToBaseVector<T>are to be replaced withedm::Ptr<T>andedm::PtrVector<T>. In cases where theRefToBaseis used as member data, backwards compatibility could, in principle, be achieved with iorules. In cases where theRefToBaseis used as part of type name (like as a template argument toedm::AssociationMap<...>, backwards compatibility likely needs to be broken.I should note there is a connection to the deprecation of the
edm::OwnVector<T>(#42734). If we end up in overhauling the data formats in a way that (even static) polymorphism is not needed (see "Discussion" in #42734 (comment)), it might be that some of the cases whereedm::RefToBase<T>is used today would not be needed at all.5.1.
edm::RefToBase<T>is not (very) widely usededm::RefToBase<reco::CaloCluster>CaloClusterRefedm::RefToBase<reco::Muon>,edm::RefToBaseVector<reco::Muon>MuonBaseRef5.2.
edm::RefToBase<T>is widely usededm::RefToBase<reco::Track>,edm::RefToBaseVector<reco::Track>TrackBaseRefandTrackBaseRefVectoredm::RefToBase<reco::Jet>,edm::RefToBaseVector<reco::Jet>JetBaseRefedm::RefToBase<reco::Candidate>,edm::RefToBaseVector<reco::Candidate>CandidateBaseRef,CandidateBaseRefVectoredm::RefToBase<TrajectorySeed>6. Class templates that produce
edm::RefToBaseVector<T>While converting these class templates to produce
edm::PtrVectoris straightforward, in the leading order these templates add dependencies for the migration of their argument types. Given thatedm::RefToBase<reco::Candidate>,edm::RefToBase<reco::Jet>, andedm::RefToBase<reco::Track>are widely used, it would be useful to have a way to decouple their migrations. One simple way (thatTriggerMatchProducer<T>already does) would be toedm::RefToBaseVector<T>andedm::PtrVector<T>Taway fromedm::RefToBase<T>edm::RefToBaseVector<T>from these producer templatesTriggerMatchProducer<T>reco::Candidate,reco::Electron,reco::GsfElectron,reco::IsolatedPixelTrackCandidate,reco::Jet,reco::Muonreco::RecoChargedCandidate,reco::RecoEcalCandidate,reco::SuperCluster,reco::METTriggerCandProducer<T>reco::Muon,reco::GsfElectron,reco::Jet,reco::MET,reco::Candidate,reco::Electron,reco::Photonreco::RecoChargedCandidate,reco::RecoEcalCandidate,reco::SuperCluster,reco::IsolatedPixelTrackCandidateObjectViewCleaner<T>reco::Candidate,reco::Jet,reco::Muon,reco::GsfElectron,reco::Electron,reco::Photon<anonymous namespace>::ObjectViewCleaner<T>reco::Candidate,reco::Jet,reco::Muon,reco::GsfElectron,reco::Electron,reco::Photon,reco::TrackGenericSelectorByValueMap<T, C>reco::GsfElectronThe text was updated successfully, but these errors were encountered: