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 tbb::concurrent_unordered_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_type &	operator[] (const key_type &k) const
	find element with specified reference key More...
template<typename K >
const result_type &	operator[] (const K &k) const
void	post_insert ()
	post insert action More...
const ref_type &	refProd () 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_type &	get (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 48 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 60 of file AssociationMap.h.

template<typename Tag>

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

index type

Definition at line 56 of file AssociationMap.h.

template<typename Tag>

typedef tbb::concurrent_unordered_map<index_type, value_type> edm::AssociationMap< Tag >::internal_transient_map_type

transient map type

Definition at line 72 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 51 of file AssociationMap.h.

template<typename Tag>

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

insert key type

Definition at line 58 of file AssociationMap.h.

template<typename Tag>

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

map type

Definition at line 64 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 62 of file AssociationMap.h.

template<typename Tag>

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

type return by operator[]

Definition at line 70 of file AssociationMap.h.

template<typename Tag>

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

self type

Definition at line 54 of file AssociationMap.h.

template<typename Tag>

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

size type

Definition at line 66 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 68 of file AssociationMap.h.

Constructor & Destructor Documentation

template<typename Tag>

edm::AssociationMap< Tag >::AssociationMap ( )

inline

default constructor

Definition at line 98 of file AssociationMap.h.

template<typename Tag>

edm::AssociationMap< Tag >::AssociationMap ( EDProductGetter const *  getter )

inlineexplicit

Definition at line 104 of file AssociationMap.h.

template<typename Tag>

edm::AssociationMap< Tag >::AssociationMap ( const ref_type &  ref )

inlineexplicit

Definition at line 109 of file AssociationMap.h.

template<typename Tag>

template<typename... Args>

edm::AssociationMap< Tag >::AssociationMap ( Args...  args )

inline

Definition at line 142 of file AssociationMap.h.

Member Function Documentation

template<typename Tag>

const_iterator edm::AssociationMap< Tag >::begin ( void  ) const

inline

first iterator over the map (read only)

Definition at line 158 of file AssociationMap.h.

Referenced by reco::JetTrackMatch< reco::GenJetCollection >::allJets(), noPuUtils::isVertexAssociated(), noPuUtils::isVertexAssociated_fast(), ShallowSimTracksProducer::produce(), and noPuUtils::reversePFCandToVertexAssociation().

template<typename Tag>

static short edm::AssociationMap< Tag >::Class_Version ( )

inlinestatic

Definition at line 234 of file AssociationMap.h.

template<typename Tag>

void edm::AssociationMap< Tag >::clear ( void  )

inline

clear map

Definition at line 145 of file AssociationMap.h.

Referenced by Vispa.Views.WidgetView.WidgetView::closeEvent(), Vispa.Share.FindAlgorithm.FindAlgorithm::findUsingFindDialog(), and Vispa.Views.WidgetView.WidgetView::setDataObjects().

template<typename Tag>

bool edm::AssociationMap< Tag >::empty ( ) const

inline

return true if empty

Definition at line 149 of file AssociationMap.h.

template<typename Tag>

const_iterator edm::AssociationMap< Tag >::end ( void  ) const

inline

last iterator over the map (read only)

Definition at line 160 of file AssociationMap.h.

Referenced by reco::JetTrackMatch< reco::GenJetCollection >::allJets(), calculateVertexSharedTracks(), noPuUtils::isVertexAssociated(), noPuUtils::isVertexAssociated_fast(), ShallowSimTracksProducer::produce(), MCTrackMatcher::produce(), and noPuUtils::reversePFCandToVertexAssociation().

template<typename Tag>

size_type edm::AssociationMap< Tag >::erase ( const key_type &  k )

inline

erase the element whose key is k

Definition at line 167 of file AssociationMap.h.

template<typename Tag>

const_iterator edm::AssociationMap< Tag >::find ( const key_type &  k ) const

inline

find element with specified reference key

Definition at line 162 of file AssociationMap.h.

Referenced by calculateVertexSharedTracks(), pat::ElectronSelector::electronID_(), noPuUtils::isVertexAssociated_fast(), MCTrackMatcher::produce(), and HFRecoEcalCandidateAlgo::produce().

template<typename Tag>

const_iterator edm::AssociationMap< Tag >::find ( size_type  i ) const

inlineprivate

find element with index i

Definition at line 244 of file AssociationMap.h.

template<typename Tag>

const value_type& edm::AssociationMap< Tag >::get ( size_type  i ) const

inlineprivate

return value_typeelement with key i

Definition at line 250 of file AssociationMap.h.

Referenced by Options.Options::__getitem__().

template<typename Tag>

void edm::AssociationMap< Tag >::insert ( const key_type &  k, const data_type &  v  )

inline

insert an association

Definition at line 151 of file AssociationMap.h.

Referenced by TrackGenAssociatorByChi2Impl::associateGenToReco(), TrackGenAssociatorByChi2Impl::associateRecoToGen(), reco::JetTrackMatch< reco::GenJetCollection >::insert(), CosmicMuonLinksProducer::mapTracks(), EgammaHLTCombinedIsolationProducer::produce(), EgammaHLTElectronCombinedIsolationProducer::produce(), EgammaHLTClusterShapeProducer::produce(), EgammaHLTHcalIsolationDoubleConeProducers::produce(), EgammaHLTR9IDProducer::produce(), EgammaHLTPhotonTrackIsolationProducersRegional::produce(), EgammaHLTR9Producer::produce(), EgammaHLTEcalIsolationProducersRegional::produce(), and noPuUtils::reversePFCandToVertexAssociation().

template<typename Tag>

void edm::AssociationMap< Tag >::insert ( const value_type &  kv )

inline

Definition at line 154 of file AssociationMap.h.

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 210 of file AssociationMap.h.

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 205 of file AssociationMap.h.

template<typename Tag>

size_type edm::AssociationMap< Tag >::numberOfAssociations ( const key_type &  k ) const

inline

number of associations to a key

Definition at line 185 of file AssociationMap.h.

template<typename Tag>

template<typename K >

size_type edm::AssociationMap< Tag >::numberOfAssociations ( const K &  k ) const

inline

Definition at line 193 of file AssociationMap.h.

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 173 of file AssociationMap.h.

template<typename Tag>

template<typename K >

const result_type& edm::AssociationMap< Tag >::operator[] ( const K &  k ) const

inline

Definition at line 179 of file AssociationMap.h.

template<typename Tag>

void edm::AssociationMap< Tag >::post_insert ( )

inline

post insert action

Definition at line 219 of file AssociationMap.h.

Referenced by TrackGenAssociatorByChi2Impl::associateGenToReco(), and TrackGenAssociatorByChi2Impl::associateRecoToGen().

template<typename Tag>

const ref_type& edm::AssociationMap< Tag >::refProd ( ) const

inline

return ref-prod structure

Definition at line 201 of file AssociationMap.h.

template<typename Tag>

size_type edm::AssociationMap< Tag >::size ( void  ) const

inline

map size

Definition at line 147 of file AssociationMap.h.

Referenced by CosmicMuonLinksProducer::produce().

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 215 of file AssociationMap.h.

Friends And Related Function Documentation

template<typename Tag>

friend struct const_iterator

friend

Definition at line 264 of file AssociationMap.h.

Referenced by ShallowSimTracksProducer::produce().

template<typename Tag>

friend struct Find

friend

Definition at line 265 of file AssociationMap.h.

template<typename Tag>

template<typename , typename , typename >

friend class OneToMany

friend

Definition at line 269 of file AssociationMap.h.

template<typename Tag>

template<typename , typename , typename , typename >

friend class OneToManyWithQuality

friend

Definition at line 270 of file AssociationMap.h.

template<typename Tag>

template<typename , typename , typename >

friend class OneToOne

friend

Definition at line 268 of file AssociationMap.h.

template<typename Tag>

template<typename , typename , typename >

friend class OneToValue

friend

Definition at line 267 of file AssociationMap.h.

template<typename Tag>

friend struct refhelper::FindTrait< self, value_type >

friend

Definition at line 266 of file AssociationMap.h.

Member Data Documentation

template<typename Tag>

map_type edm::AssociationMap< Tag >::map_

private

index map

Definition at line 240 of file AssociationMap.h.

template<typename Tag>

ref_type edm::AssociationMap< Tag >::ref_

private

reference set

Definition at line 238 of file AssociationMap.h.

template<typename Tag>

internal_transient_map_type edm::AssociationMap< Tag >::transientMap_

mutableprivate

transient reference map

Definition at line 242 of file AssociationMap.h.