CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends
edm::AssociationMap< Tag > Class Template Reference

#include <AssociationMap.h>

Classes

struct  const_iterator
 const iterator More...
 
struct  Find
 find helper More...
 

Public Types

typedef Tag::data_type data_type
 insert data type More...
 
typedef Tag::index_type index_type
 index type More...
 
typedef std::map< index_type,
value_type
internal_transient_map_type
 transient map type More...
 
typedef Tag::key_type key_type
 insert key type More...
 
typedef Tag::map_type map_type
 map type More...
 
typedef Tag::ref_type ref_type
 Holds the RefProd or RefToBaseProd of 1 or 2 collections. More...
 
typedef value_type::value_type result_type
 type return by operator[] More...
 
typedef AssociationMap< Tag > self
 self type More...
 
typedef map_type::size_type size_type
 size type More...
 
typedef helpers::KeyVal
< key_type, internal_val_type
value_type
 type returned by dereferenced iterator, also can be inserted More...
 

Public Member Functions

 AssociationMap ()
 default constructor More...
 
 AssociationMap (EDProductGetter const *getter)
 
 AssociationMap (const ref_type &ref)
 
template<typename... Args>
 AssociationMap (Args...args)
 
const_iterator begin () const
 first iterator over the map (read only) More...
 
void clear ()
 clear map More...
 
bool empty () const
 return true if empty More...
 
const_iterator end () const
 last iterator over the map (read only) More...
 
size_type erase (const key_type &k)
 erase the element whose key is k More...
 
const_iterator find (const key_type &k) const
 find element with specified reference key More...
 
void insert (const key_type &k, const data_type &v)
 insert an association More...
 
void insert (const value_type &kv)
 
Tag::transient_key_vector keys ()
 
Tag::transient_map_type map ()
 
size_type numberOfAssociations (const key_type &k) const
 number of associations to a key More...
 
template<typename K >
size_type numberOfAssociations (const K &k) const
 
const result_typeoperator[] (const key_type &k) const
 find element with specified reference key More...
 
template<typename K >
const result_typeoperator[] (const K &k) const
 
void post_insert ()
 post insert action More...
 
const ref_typerefProd () const
 return ref-prod structure More...
 
size_type size () const
 map size More...
 
Tag::transient_val_vector values ()
 

Static Public Member Functions

static short Class_Version ()
 

Private Types

typedef Tag::val_type internal_val_type
 

Private Member Functions

const_iterator find (size_type i) const
 find element with index i More...
 
const value_typeget (size_type i) const
 return value_typeelement with key i More...
 

Private Attributes

map_type map_
 index map More...
 
ref_type ref_
 reference set More...
 
internal_transient_map_type transientMap_
 transient reference map More...
 

Friends

struct const_iterator
 
struct Find
 
template<typename , typename , typename >
class OneToMany
 
template<typename , typename , typename , typename >
class OneToManyWithQuality
 
template<typename , typename , typename >
class OneToOne
 
template<typename , typename , typename >
class OneToValue
 
struct refhelper::FindTrait< self, value_type >
 

Detailed Description

template<typename Tag>
class edm::AssociationMap< Tag >

one-to-many or one-to-one associative map using EDM references

Author
Luca Lista, INFN

In general, this class is intuitive, but two special cases deserves some extra discussion. These are somewhat unusual corner cases, but sometimes actually have arisen.

First, one can initialize the AssociationMap by passing in a Handle to a collection as an argument to the constructor. Usually it is a good way to initialize it. But this will fail in the case where a collection template parameter to Tag (either CKey or CVal) is a View and the underlying collection read into the View is a RefVector, PtrVector, or vector(Ptr). AssociationMap will behave improperly if the constructor is passed a Handle<View<C> >. In this case, one should initialize with a EDProductGetter const* or construct a RefToBaseProd whose ProductID is associated with the underlying container, not the RefVector, PtrVector, or vector<Ptr>.

AssociationMap is designed to support cases where all the Key Ref's point into one container and all the Val Ref's point into one other container. For example, if one read a vector<Ptr> into a View and the Ptr's pointed into different containers and you tried to use these as elements of CVal, then AssociationMap will not work.

Definition at line 47 of file AssociationMap.h.

Member Typedef Documentation

template<typename Tag>
typedef Tag::data_type edm::AssociationMap< Tag >::data_type

insert data type

Definition at line 59 of file AssociationMap.h.

template<typename Tag>
typedef Tag::index_type edm::AssociationMap< Tag >::index_type

index type

Definition at line 55 of file AssociationMap.h.

template<typename Tag>
typedef std::map<index_type, value_type> edm::AssociationMap< Tag >::internal_transient_map_type

transient map type

Definition at line 71 of file AssociationMap.h.

template<typename Tag>
typedef Tag::val_type edm::AssociationMap< Tag >::internal_val_type
private

This is the second part of the value part of the items stored in the transient map

Definition at line 50 of file AssociationMap.h.

template<typename Tag>
typedef Tag::key_type edm::AssociationMap< Tag >::key_type

insert key type

Definition at line 57 of file AssociationMap.h.

template<typename Tag>
typedef Tag::map_type edm::AssociationMap< Tag >::map_type

map type

Definition at line 63 of file AssociationMap.h.

template<typename Tag>
typedef Tag::ref_type edm::AssociationMap< Tag >::ref_type

Holds the RefProd or RefToBaseProd of 1 or 2 collections.

Definition at line 61 of file AssociationMap.h.

template<typename Tag>
typedef value_type::value_type edm::AssociationMap< Tag >::result_type

type return by operator[]

Definition at line 69 of file AssociationMap.h.

template<typename Tag>
typedef AssociationMap<Tag> edm::AssociationMap< Tag >::self

self type

Definition at line 53 of file AssociationMap.h.

template<typename Tag>
typedef map_type::size_type edm::AssociationMap< Tag >::size_type

size type

Definition at line 65 of file AssociationMap.h.

template<typename Tag>
typedef helpers::KeyVal<key_type, internal_val_type> edm::AssociationMap< Tag >::value_type

type returned by dereferenced iterator, also can be inserted

Definition at line 67 of file AssociationMap.h.

Constructor & Destructor Documentation

template<typename Tag>
edm::AssociationMap< Tag >::AssociationMap ( )
inline

default constructor

Definition at line 97 of file AssociationMap.h.

97 { }
template<typename Tag>
edm::AssociationMap< Tag >::AssociationMap ( EDProductGetter const *  getter)
inlineexplicit

Definition at line 104 of file AssociationMap.h.

104  :
105  ref_(getter) { }
ref_type ref_
reference set
template<typename Tag>
edm::AssociationMap< Tag >::AssociationMap ( const ref_type ref)
inlineexplicit

Definition at line 110 of file AssociationMap.h.

110 : ref_(ref) { }
ref_type ref_
reference set
template<typename Tag>
template<typename... Args>
edm::AssociationMap< Tag >::AssociationMap ( Args...  args)
inline

Definition at line 144 of file AssociationMap.h.

144 : ref_(std::forward<Args>(args)...) {}
ref_type ref_
reference set

Member Function Documentation

template<typename Tag>
const_iterator edm::AssociationMap< Tag >::begin ( void  ) const
inline
template<typename Tag>
static short edm::AssociationMap< Tag >::Class_Version ( )
inlinestatic

Definition at line 237 of file AssociationMap.h.

239 :
template<typename Tag>
void edm::AssociationMap< Tag >::clear ( void  )
inline
template<typename Tag>
bool edm::AssociationMap< Tag >::empty ( ) const
inline

return true if empty

Definition at line 152 of file AssociationMap.h.

Referenced by Vispa.Gui.VispaWidget.TextField::setAutosizeFont(), and Vispa.Gui.VispaWidget.TextField::setAutotruncate().

152 { return map_.empty(); }
map_type map_
index map
template<typename Tag>
const_iterator edm::AssociationMap< Tag >::end ( void  ) const
inline

last iterator over the map (read only)

Definition at line 163 of file AssociationMap.h.

Referenced by SiStripGainFromData::algoAnalyze(), reco::JetTrackMatch< reco::GenJetCollection >::allJets(), MultiTrackValidatorGenPs::analyze(), MultiTrackValidator::analyze(), TrackerSeedValidator::analyze(), ValidationMisalignedTracker::analyze(), SiPixelHitEfficiencySource::analyze(), SiPixelTrackResidualSource::analyze(), TkConvValidator::analyze(), TestTrackHits::analyze(), PhotonValidator::analyze(), MuonTrackValidator::analyze(), FWTrackProxyBuilderFullFramework::build(), calculateVertexSharedTracks(), Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), edm::AssociationMap< edm::OneToMany< reco::BasicJetCollection, reco::TrackCollection > >::find(), PrimaryVertexAnalyzer4PUSlimmed::getRecoPVs(), PrimaryVertexAnalyzer4PUSlimmed::getSimPVs(), muon::getTevRefitTrack(), noPuUtils::isVertexAssociated(), noPuUtils::isVertexAssociated_fast(), PrimaryVertexAnalyzer4PUSlimmed::matchReco2SimVertices(), PrimaryVertexAnalyzer4PUSlimmed::matchRecoTrack2SimSignal(), PrimaryVertexAnalyzer4PUSlimmed::matchSim2RecoVertices(), HLTEgammaCaloIsolFilterPairs::PassCaloIsolation(), MCTrackMatcher::produce(), ShallowSimTracksProducer::produce(), NuclearInteractionEDProducer::produce(), TrackAlgoCompareUtil::produce(), noPuUtils::reversePFCandToVertexAssociation(), DAFTrackProducerAlgorithm::runWithCandidate(), PF_PU_AssoMapAlgos::SortAssociationMap(), PFCand_AssoMapAlgos::SortPFCandAssociationMap(), and tevOptimizedTMR().

163 { return const_iterator(this, map_.end()); }
friend struct const_iterator
map_type map_
index map
template<typename Tag>
size_type edm::AssociationMap< Tag >::erase ( const key_type k)
inline

erase the element whose key is k

Definition at line 170 of file AssociationMap.h.

170  {
171  index_type i = k.key();
172  transientMap_.erase(i);
173  return map_.erase(i);
174  }
int i
Definition: DBlmapReader.cc:9
Tag::index_type index_type
index type
internal_transient_map_type transientMap_
transient reference map
map_type map_
index map
template<typename Tag>
const_iterator edm::AssociationMap< Tag >::find ( const key_type k) const
inline

find element with specified reference key

Definition at line 165 of file AssociationMap.h.

Referenced by BeautifulSoup.Tag::__getattr__(), MultiTrackValidatorGenPs::analyze(), MultiTrackValidator::analyze(), TrackerSeedValidator::analyze(), ValidationMisalignedTracker::analyze(), TkConvValidator::analyze(), TestTrackHits::analyze(), PhotonValidator::analyze(), MuonTrackValidator::analyze(), calculateVertexSharedTracks(), pat::ElectronSelector::electronID_(), edm::AssociationMap< edm::OneToMany< reco::BasicJetCollection, reco::TrackCollection > >::find(), BeautifulSoup.Tag::firstText(), PrimaryVertexAnalyzer4PUSlimmed::getRecoPVs(), PrimaryVertexAnalyzer4PUSlimmed::getSimPVs(), muon::getTevRefitTrack(), noPuUtils::isVertexAssociated_fast(), PrimaryVertexAnalyzer4PUSlimmed::matchReco2SimVertices(), PrimaryVertexAnalyzer4PUSlimmed::matchRecoTrack2SimSignal(), PrimaryVertexAnalyzer4PUSlimmed::matchSim2RecoVertices(), HLTEgammaCaloIsolFilterPairs::PassCaloIsolation(), MCTrackMatcher::produce(), HFRecoEcalCandidateAlgo::produce(), NuclearInteractionEDProducer::produce(), TrackAlgoCompareUtil::produce(), and tevOptimizedTMR().

165  {
166  if (ref_.key.id() != k.id()) return end();
167  return find(k.key());
168  }
const_iterator end() const
last iterator over the map (read only)
const_iterator find(const key_type &k) const
find element with specified reference key
ref_type ref_
reference set
template<typename Tag>
const_iterator edm::AssociationMap< Tag >::find ( size_type  i) const
inlineprivate

find element with index i

Definition at line 247 of file AssociationMap.h.

Referenced by BeautifulSoup.Tag::__getattr__(), and BeautifulSoup.Tag::firstText().

247  {
248  typename map_type::const_iterator f = map_.find(i);
249  if (f == map_.end()) return end();
250  return const_iterator(this, f);
251  }
int i
Definition: DBlmapReader.cc:9
friend struct const_iterator
const_iterator end() const
last iterator over the map (read only)
double f[11][100]
map_type map_
index map
template<typename Tag>
const value_type& edm::AssociationMap< Tag >::get ( size_type  i) const
inlineprivate

return value_typeelement with key i

Definition at line 253 of file AssociationMap.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), edm::AssociationMap< Tag >::const_iterator::operator*(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

253  {
254  typename internal_transient_map_type::const_iterator tf = transientMap_.find(i);
255  if (tf == transientMap_.end()) {
256  typename map_type::const_iterator f = map_.find(i);
257  if (f == map_.end())
258  Exception::throwThis(edm::errors::InvalidReference, "can't find reference in AssociationMap at position ", i);
259  value_type v(key_type(ref_.key, i), Tag::val(ref_, f->second));
260  std::pair<typename internal_transient_map_type::const_iterator, bool> ins =
261  transientMap_.insert(std::make_pair(i, v));
262  return ins.first->second;
263  } else {
264  return tf->second;
265  }
266  }
int i
Definition: DBlmapReader.cc:9
internal_transient_map_type transientMap_
transient reference map
helpers::KeyVal< key_type, internal_val_type > value_type
type returned by dereferenced iterator, also can be inserted
Tag::key_type key_type
insert key type
ref_type ref_
reference set
static void throwThis(Code category, char const *message0="", char const *message1="", char const *message2="", char const *message3="", char const *message4="")
tuple ins
Definition: cuy.py:312
double f[11][100]
map_type map_
index map
template<typename Tag>
void edm::AssociationMap< Tag >::insert ( const key_type k,
const data_type v 
)
inline

insert an association

Definition at line 154 of file AssociationMap.h.

Referenced by BeautifulSoup.PageElement::_invert(), TrackGenAssociatorByChi2Impl::associateGenToReco(), TrackGenAssociatorByChi2Impl::associateRecoToGen(), VertexAssociatorByTracks::associateRecoToSim(), VertexAssociatorByPositionAndTracks::associateRecoToSim(), TrackAssociatorByHitsImpl::associateRecoToSim(), TrackAssociatorByPositionImpl::associateRecoToSim(), TrackAssociatorByChi2Impl::associateRecoToSim(), QuickTrackAssociatorByHitsImpl::associateRecoToSim(), QuickTrackAssociatorByHitsImpl::associateRecoToSimImplementation(), VertexAssociatorByTracks::associateSimToReco(), VertexAssociatorByPositionAndTracks::associateSimToReco(), TrackAssociatorByHitsImpl::associateSimToReco(), TrackAssociatorByPositionImpl::associateSimToReco(), TrackAssociatorByChi2Impl::associateSimToReco(), QuickTrackAssociatorByHitsImpl::associateSimToReco(), QuickTrackAssociatorByHitsImpl::associateSimToRecoImplementation(), reco::JetTrackMatch< reco::GenJetCollection >::insert(), CosmicMuonLinksProducer::mapTracks(), EgammaHLTCombinedIsolationProducer::produce(), EgammaHLTPFChargedIsolationProducer::produce(), EgammaHLTPFNeutralIsolationProducer::produce(), EgammaHLTClusterShapeProducer::produce(), EgammaHLTElectronCombinedIsolationProducer::produce(), EgammaHLTPFPhotonIsolationProducer::produce(), HLTEcalPFClusterIsolationProducer< T1 >::produce(), EgammaHLTEcalRecIsolationProducer::produce(), HLTHcalPFClusterIsolationProducer< T1 >::produce(), EgammaHLTElectronDetaDphiProducer::produce(), EgammaHLTElectronTrackIsolationProducers::produce(), EgammaHLTHcalIsolationDoubleConeProducers::produce(), EgammaHLTHcalIsolationProducersRegional::produce(), EgammaHLTR9IDProducer::produce(), EgammaHLTBcHcalIsolationProducersRegional::produce(), EgammaHLTPhotonTrackIsolationProducersRegional::produce(), EgammaHLTR9Producer::produce(), EgammaHLTEcalIsolationProducersRegional::produce(), EgammaHLTGsfTrackVarProducer::produce(), NuclearTrackCorrector::produce(), and noPuUtils::reversePFCandToVertexAssociation().

154  {
155  Tag::insert(ref_, map_, k, v);
156  }
ref_type ref_
reference set
bool insert(Storage &iStorage, ItemType *iItem, const IdTag &iIdTag)
Definition: HCMethods.h:49
map_type map_
index map
template<typename Tag>
void edm::AssociationMap< Tag >::insert ( const value_type kv)
inline

Definition at line 157 of file AssociationMap.h.

Referenced by BeautifulSoup.PageElement::_invert().

157  {
158  Tag::insert(ref_, map_, kv.key, kv.val);
159  }
ref_type ref_
reference set
bool insert(Storage &iStorage, ItemType *iItem, const IdTag &iIdTag)
Definition: HCMethods.h:49
map_type map_
index map
template<typename Tag>
Tag::transient_key_vector edm::AssociationMap< Tag >::keys ( )
inline

fill and return a transient key vector required for ROOT interactive usage

Definition at line 213 of file AssociationMap.h.

Referenced by psClasses.queueList::__init__(), psClasses.queueList::smallestQueue(), and psClasses.queueList::thinerQueue().

213  {
214  return Tag::transientKeyVector( ref_, map_ );
215  }
ref_type ref_
reference set
map_type map_
index map
template<typename Tag>
Tag::transient_map_type edm::AssociationMap< Tag >::map ( )
inline

fill and return a transient map required for ROOT interactive usage

Definition at line 208 of file AssociationMap.h.

208  {
209  return Tag::transientMap( ref_, map_ );
210  }
ref_type ref_
reference set
map_type map_
index map
template<typename Tag>
size_type edm::AssociationMap< Tag >::numberOfAssociations ( const key_type k) const
inline

number of associations to a key

Definition at line 188 of file AssociationMap.h.

Referenced by VertexAssociatorByTracks::associateRecoToSim(), and VertexAssociatorByTracks::associateSimToReco().

188  {
189  if (ref_.key.id() != k.id()) return 0;
190  typename map_type::const_iterator f = map_.find(k.key());
191  if (f == map_.end()) return 0;
192  return Tag::size(f->second);
193  }
ref_type ref_
reference set
double f[11][100]
map_type map_
index map
tuple size
Write out results.
template<typename Tag>
template<typename K >
size_type edm::AssociationMap< Tag >::numberOfAssociations ( const K &  k) const
inline

Definition at line 196 of file AssociationMap.h.

196  {
197  if (ref_.key.id() != k.id()) return 0;
198  typename map_type::const_iterator f = map_.find(k.key());
199  if (f == map_.end()) return 0;
200  return Tag::size(f->second);
201  }
ref_type ref_
reference set
double f[11][100]
map_type map_
index map
tuple size
Write out results.
template<typename Tag>
const result_type& edm::AssociationMap< Tag >::operator[] ( const key_type k) const
inline

find element with specified reference key

Definition at line 176 of file AssociationMap.h.

176  {
177  helpers::checkRef(ref_.key, k);
178  return get(k.key()).val;
179  }
ref_type ref_
reference set
void checkRef(const RP &rp, const R &r)
throw if r hasn&#39;t the same id as rp
template<typename Tag>
template<typename K >
const result_type& edm::AssociationMap< Tag >::operator[] ( const K &  k) const
inline

Definition at line 182 of file AssociationMap.h.

182  {
183  helpers::checkRef(ref_.key,k);
184  return get(k.key()).val;
185  }
ref_type ref_
reference set
void checkRef(const RP &rp, const R &r)
throw if r hasn&#39;t the same id as rp
template<typename Tag>
void edm::AssociationMap< Tag >::post_insert ( )
inline
template<typename Tag>
const ref_type& edm::AssociationMap< Tag >::refProd ( ) const
inline

return ref-prod structure

Definition at line 204 of file AssociationMap.h.

Referenced by NuclearTrackCorrector::produce().

204 { return ref_; }
ref_type ref_
reference set
template<typename Tag>
size_type edm::AssociationMap< Tag >::size ( void  ) const
inline
template<typename Tag>
Tag::transient_val_vector edm::AssociationMap< Tag >::values ( )
inline

fill and return a transient key vector required for ROOT interactive usage

Definition at line 218 of file AssociationMap.h.

218  {
219  return Tag::transientValVector( ref_, map_ );
220  }
ref_type ref_
reference set
map_type map_
index map

Friends And Related Function Documentation

template<typename Tag>
friend struct const_iterator
friend
template<typename Tag>
friend struct Find
friend

Definition at line 268 of file AssociationMap.h.

template<typename Tag>
template<typename , typename , typename >
friend class OneToMany
friend

Definition at line 272 of file AssociationMap.h.

template<typename Tag>
template<typename , typename , typename , typename >
friend class OneToManyWithQuality
friend

Definition at line 273 of file AssociationMap.h.

template<typename Tag>
template<typename , typename , typename >
friend class OneToOne
friend

Definition at line 271 of file AssociationMap.h.

template<typename Tag>
template<typename , typename , typename >
friend class OneToValue
friend

Definition at line 270 of file AssociationMap.h.

template<typename Tag>
friend struct refhelper::FindTrait< self, value_type >
friend

Definition at line 269 of file AssociationMap.h.

Member Data Documentation

template<typename Tag>
map_type edm::AssociationMap< Tag >::map_
private
template<typename Tag>
ref_type edm::AssociationMap< Tag >::ref_
private
template<typename Tag>
internal_transient_map_type edm::AssociationMap< Tag >::transientMap_
mutableprivate