#include <PtrVectorBase.h>

Inheritance diagram for edm::PtrVectorBase:

Public Types
typedef unsigned long	key_type

typedef key_type	size_type

Public Member Functions
size_type	capacity () const
	Capacity of the RefVector. More...

void	clear ()
	Clear the PtrVector. More...

bool	empty () const
	Is the RefVector empty. More...

bool	hasCache () const

ProductID	id () const
	Accessor for product ID. More...

bool	isAvailable () const

bool	isNonnull () const
	Checks for non-null. More...

bool	isNull () const
	Checks for null. More...

bool	isTransient () const

bool	operator! () const
	Checks for null. More...

bool	operator== (PtrVectorBase const &iRHS) const

void const *	product () const

EDProductGetter const *	productGetter () const
	Accessor for product getter. More...

	PtrVectorBase (const PtrVectorBase &)

	PtrVectorBase (ProductID const &productID, void const prodPtr=nullptr, EDProductGetter const prodGetter=nullptr)

void	reserve (size_type n)
	Reserve space for RefVector. More...

void	setProductGetter (EDProductGetter *iGetter) const

size_type	size () const
	Size of the RefVector. More...

virtual	~PtrVectorBase ()

Protected Member Functions
template<typename TPtr >
TPtr	makePtr (std::vector< void const * >::const_iterator const iIt) const

template<typename TPtr >
TPtr	makePtr (unsigned long iIndex) const

	PtrVectorBase ()

void	push_back_base (RefCore const &core, key_type iKey, void const *iData)

void	swap (PtrVectorBase &other)
	swap More...

std::vector< void const * >::const_iterator	void_begin () const

std::vector< void const * >::const_iterator	void_end () const

Private Member Functions
bool	checkCachedItems () const

void	getProduct_ () const

PtrVectorBase &	operator= (const PtrVectorBase &)=delete

virtual std::type_info const &	typeInfo () const

Static Private Member Functions
static const std::vector< void const * > &	emptyCache ()

Private Attributes
std::atomic< std::vector< void const * > * >	cachedItems_

RefCore	core_

std::vector< key_type >	indicies_

Detailed Description

Description: Base class for PtrVector

Usage: This class defines the common behavior for the PtrVector template class instances

Definition at line 32 of file PtrVectorBase.h.

Member Typedef Documentation

◆ key_type

typedef unsigned long edm::PtrVectorBase::key_type

Definition at line 34 of file PtrVectorBase.h.

◆ size_type

typedef key_type edm::PtrVectorBase::size_type

Definition at line 35 of file PtrVectorBase.h.

Constructor & Destructor Documentation

◆ PtrVectorBase() [1/3]

edm::PtrVectorBase::PtrVectorBase	(	ProductID const &	productID,
		void const *	prodPtr = `nullptr`,
		EDProductGetter const *	prodGetter = `nullptr`
	)

inlineexplicit

Definition at line 37 of file PtrVectorBase.h.

40 : core_(productID, prodPtr, prodGetter, false), indicies_(), cachedItems_(nullptr) {}

◆ PtrVectorBase() [2/3]

edm::PtrVectorBase::PtrVectorBase ( const PtrVectorBase & iOther )

Definition at line 39 of file PtrVectorBase.cc.

       : core_(iOther.core_), indicies_(iOther.indicies_), cachedItems_(nullptr) {
     auto cache = iOther.cachedItems_.load();
     if (cache) {
       cachedItems_.store(new std::vector<void const*>(*cache));
     }
   }

References utilities::cache(), and cachedItems_.

◆ ~PtrVectorBase()

edm::PtrVectorBase::~PtrVectorBase ( )

virtual

Definition at line 37 of file PtrVectorBase.cc.

37 { delete cachedItems_.load(); }

References cachedItems_.

◆ PtrVectorBase() [3/3]

edm::PtrVectorBase::PtrVectorBase ( )

protected

Definition at line 35 of file PtrVectorBase.cc.

35 : cachedItems_(nullptr) {}

Member Function Documentation

◆ capacity()

size_type edm::PtrVectorBase::capacity ( ) const

inline

Capacity of the RefVector.

Definition at line 76 of file PtrVectorBase.h.

76 { return indicies_.capacity(); }

References indicies_.

◆ checkCachedItems()

bool edm::PtrVectorBase::checkCachedItems ( ) const

private

Definition at line 156 of file PtrVectorBase.cc.

                                              {
     auto tmp = cachedItems_.load();
     if (not tmp) {
       return false;
     }
     for (auto item : *tmp) {
       if (item == nullptr) {
         throw Exception(errors::InvalidReference)
             << "Asked for data from a PtrVector which refers to a non-existent product with ProductID " << id() << "\n";
       }
     }
     return true;
   }

References cachedItems_, Exception, id(), edm::errors::InvalidReference, B2GTnPMonitor_cfi::item, and createJobs::tmp.

Referenced by void_begin(), and void_end().

◆ clear()

void edm::PtrVectorBase::clear ( void )

inline

Clear the PtrVector.

Definition at line 79 of file PtrVectorBase.h.

                  {
       core_ = RefCore();
       indicies_.clear();
       if (cachedItems_) {
         delete cachedItems_.load();
         cachedItems_.store(nullptr);
       }
     }

References cachedItems_, core_, and indicies_.

Referenced by ConvertedPhotonProducer::buildCollections(), BremRecoveryClusterAlgo::makeIslandSuperClusters(), HiBremRecoveryClusterAlgo::makeIslandSuperClusters(), Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), ReducedEGProducer::relinkCaloClusters(), reco::PFSuperCluster::reset(), and BeautifulSoup.Tag::setString().

◆ empty()

bool edm::PtrVectorBase::empty ( ) const

inline

Is the RefVector empty.

Definition at line 70 of file PtrVectorBase.h.

70 { return indicies_.empty(); }

References indicies_.

Referenced by Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), and ReducedEGProducer::relinkCaloClusters().

◆ emptyCache()

const std::vector< void const * > & edm::PtrVectorBase::emptyCache ( )

staticprivate

Definition at line 186 of file PtrVectorBase.cc.

186 { return s_emptyCache; }

References edm::s_emptyCache.

Referenced by void_begin(), and void_end().

◆ getProduct_()

void edm::PtrVectorBase::getProduct_ ( ) const

private

Definition at line 105 of file PtrVectorBase.cc.

                                         {
     if (hasCache()) {
       return;
     }
     if (indicies_.empty()) {
       return;
     }
     //NOTE: Another thread could be getting the data
     auto tmpProductGetter = productGetter();
     if (nullptr == tmpProductGetter) {
       throw Exception(errors::LogicError) << "Tried to get data for a PtrVector which has no EDProductGetter\n";
     }
     WrapperBase const* product = tmpProductGetter->getIt(id());
  
     auto tmpCachedItems = std::make_unique<std::vector<void const*>>();
  
     if (product != nullptr) {
       product->fillPtrVector(typeInfo(), indicies_, *tmpCachedItems);
  
       std::vector<void const*>* expected = nullptr;
       if (cachedItems_.compare_exchange_strong(expected, tmpCachedItems.get())) {
         //we were the first thread to change the value
         tmpCachedItems.release();
       }
  
       return;
     }
  
     tmpCachedItems->resize(indicies_.size(), nullptr);
  
     std::vector<unsigned int> thinnedKeys;
     thinnedKeys.assign(indicies_.begin(), indicies_.end());
     std::vector<WrapperBase const*> wrappers(indicies_.size(), nullptr);
     tmpProductGetter->getThinnedProducts(id(), wrappers, thinnedKeys);
     unsigned int nWrappers = wrappers.size();
     assert(wrappers.size() == indicies_.size());
     assert(wrappers.size() == tmpCachedItems->size());
     for (unsigned k = 0; k < nWrappers; ++k) {
       if (wrappers[k] != nullptr) {
         wrappers[k]->setPtr(typeInfo(), thinnedKeys[k], (*tmpCachedItems)[k]);
       }
     }
     {
       std::vector<void const*>* expected = nullptr;
       if (cachedItems_.compare_exchange_strong(expected, tmpCachedItems.get())) {
         //we were the first thread to change the value
         tmpCachedItems.release();
       }
     }
   }

References cms::cuda::assert(), cachedItems_, Exception, hasCache(), indicies_, dqmdumpme::k, edm::errors::LogicError, product(), productGetter(), and typeInfo().

Referenced by isAvailable(), void_begin(), and void_end().

◆ hasCache()

bool edm::PtrVectorBase::hasCache ( ) const

inline

Definition at line 63 of file PtrVectorBase.h.

63 { return cachedItems_; }

References cachedItems_.

Referenced by getProduct_(), isAvailable(), and makePtr().

◆ id()

ProductID edm::PtrVectorBase::id ( ) const

inline

Accessor for product ID.

Definition at line 58 of file PtrVectorBase.h.

58 { return core_.id(); }

References core_, and edm::RefCore::id().

Referenced by checkCachedItems().

◆ isAvailable()

bool edm::PtrVectorBase::isAvailable ( ) const

True if the data is in memory or is available in the Event No type checking is done.

Definition at line 83 of file PtrVectorBase.cc.

                                         {
     if (indicies_.empty()) {
       return core_.isAvailable();
     }
     if (!hasCache()) {
       if (!id().isValid() || productGetter() == nullptr) {
         return false;
       }
       getProduct_();
     }
     auto tmpCachedItems = cachedItems_.load();
     for (auto ptr : *tmpCachedItems) {
       if (ptr == nullptr) {
         return false;
       }
     }
     return true;
   }

References cachedItems_, core_, getProduct_(), hasCache(), indicies_, edm::RefCore::isAvailable(), sistrip::SpyUtilities::isValid(), and productGetter().

◆ isNonnull()

bool edm::PtrVectorBase::isNonnull ( ) const

inline

Checks for non-null.

Definition at line 52 of file PtrVectorBase.h.

52 { return core_.isNonnull(); }

References core_, and edm::RefCore::isNonnull().

Referenced by isNull().

◆ isNull()

bool edm::PtrVectorBase::isNull ( ) const

inline

Checks for null.

Definition at line 48 of file PtrVectorBase.h.

48 { return !isNonnull(); }

References isNonnull().

Referenced by operator!().

◆ isTransient()

bool edm::PtrVectorBase::isTransient ( ) const

inline

Definition at line 102 of file PtrVectorBase.h.

102 { return core_.isTransient(); }

References core_, and edm::RefCore::isTransient().

Referenced by makePtr().

◆ makePtr() [1/2]

template<typename TPtr >

TPtr edm::PtrVectorBase::makePtr ( std::vector< void const * >::const_iterator const iIt ) const

inlineprotected

Definition at line 142 of file PtrVectorBase.h.

                                                                        {
       if (isTransient()) {
         return TPtr(reinterpret_cast<typename TPtr::value_type const*>(*iIt), indicies_[iIt - (*cachedItems_).begin()]);
       }
       if (hasCache() && (*iIt != nullptr || productGetter() == nullptr)) {
         return TPtr(this->id(),
                     reinterpret_cast<typename TPtr::value_type const*>(*iIt),
                     indicies_[iIt - (*cachedItems_).begin()]);
       }
       return TPtr(this->id(), indicies_[iIt - (*cachedItems_).begin()], productGetter());
     }

References hasCache(), indicies_, isTransient(), and productGetter().

◆ makePtr() [2/2]

template<typename TPtr >

TPtr edm::PtrVectorBase::makePtr ( unsigned long iIndex ) const

inlineprotected

Definition at line 130 of file PtrVectorBase.h.

                                              {
       if (isTransient()) {
         return TPtr(reinterpret_cast<typename TPtr::value_type const*>((*cachedItems_)[iIndex]), indicies_[iIndex]);
       }
       if (hasCache() && ((*cachedItems_)[iIndex] != nullptr || productGetter() == nullptr)) {
         return TPtr(
             this->id(), reinterpret_cast<typename TPtr::value_type const*>((*cachedItems_)[iIndex]), indicies_[iIndex]);
       }
       return TPtr(this->id(), indicies_[iIndex], productGetter());
     }

References cachedItems_, hasCache(), indicies_, isTransient(), and productGetter().

◆ operator!()

bool edm::PtrVectorBase::operator! ( ) const

inline

Checks for null.

Definition at line 55 of file PtrVectorBase.h.

55 { return isNull(); }

References isNull().

◆ operator=()

PtrVectorBase& edm::PtrVectorBase::operator= ( const PtrVectorBase & )

privatedelete

◆ operator==()

bool edm::PtrVectorBase::operator== ( PtrVectorBase const & iRHS ) const

Definition at line 170 of file PtrVectorBase.cc.

                                                                 {
     if (core_ != iRHS.core_) {
       return false;
     }
     if (indicies_.size() != iRHS.indicies_.size()) {
       return false;
     }
     return std::equal(indicies_.begin(), indicies_.end(), iRHS.indicies_.begin());
   }

References core_, cond::serialization::equal(), and indicies_.

◆ product()

void const* edm::PtrVectorBase::product ( ) const

inline

Definition at line 104 of file PtrVectorBase.h.

104 { return nullptr; }

Referenced by getProduct_().

◆ productGetter()

EDProductGetter const* edm::PtrVectorBase::productGetter ( ) const

inline

Accessor for product getter.

Definition at line 61 of file PtrVectorBase.h.

61 { return core_.productGetter(); }

References core_, and edm::RefCore::productGetter().

Referenced by getProduct_(), isAvailable(), makePtr(), PATObjectCrossLinker::matchElectronToPhoton(), and PATObjectCrossLinker::matchOneToMany().

◆ push_back_base()

void edm::PtrVectorBase::push_back_base	(	RefCore const &	core,
		key_type	iKey,
		void const *	iData
	)

protected

Definition at line 62 of file PtrVectorBase.cc.

                                                                                           {
     core_.pushBackItem(core, false);
     //Did we already push a 'non-cached' Ptr into the container or is this a 'non-cached' Ptr?
     if (not cachedItems_ and indicies_.empty()) {
       cachedItems_.store(new std::vector<void const*>());
       (*cachedItems_).reserve(indicies_.capacity());
     }
     auto tmpCachedItems = cachedItems_.load();
     if (tmpCachedItems and (indicies_.size() == (*tmpCachedItems).size())) {
       if (iData) {
         tmpCachedItems->push_back(iData);
       } else if (key_traits<key_type>::value == iKey) {
         tmpCachedItems->push_back(nullptr);
       } else {
         delete tmpCachedItems;
         cachedItems_.store(nullptr);
       }
     }
     indicies_.push_back(iKey);
   }

References cachedItems_, core_, indicies_, and edm::RefCore::pushBackItem().

Referenced by edm::PtrVector< reco::CaloCluster >::push_back().

◆ reserve()

void edm::PtrVectorBase::reserve ( size_type n )

inline

Reserve space for RefVector.

Definition at line 93 of file PtrVectorBase.h.

                               {
       indicies_.reserve(n);
       if (cachedItems_) {
         (*cachedItems_).reserve(n);
       }
     }

References cachedItems_, indicies_, and dqmiodumpmetadata::n.

Referenced by Multi5x5SuperClusterProducer::getClusterPtrVector(), and HGCalLayerClusterProducer::produce().

◆ setProductGetter()

void edm::PtrVectorBase::setProductGetter ( EDProductGetter * iGetter ) const

inline

Definition at line 100 of file PtrVectorBase.h.

100 { core_.setProductGetter(iGetter); }

References core_, and edm::RefCore::setProductGetter().

◆ size()

size_type edm::PtrVectorBase::size ( void ) const

inline

◆ swap()

void edm::PtrVectorBase::swap ( PtrVectorBase & other )

protected

swap

Definition at line 56 of file PtrVectorBase.cc.

                                                {
     core_.swap(other.core_);
     indicies_.swap(other.indicies_);
     other.cachedItems_.store(cachedItems_.exchange(other.cachedItems_.load()));
   }

References cachedItems_, core_, indicies_, trackingPlots::other, and edm::RefCore::swap().

Referenced by edm::PtrVector< reco::CaloCluster >::swap().

◆ typeInfo()

virtual std::type_info const& edm::PtrVectorBase::typeInfo ( ) const

inlineprivatevirtual

Reimplemented in edm::PtrVector< T >, edm::PtrVector< reco::PFCluster >, edm::PtrVector< CaloCluster >, edm::PtrVector< Candidate >, and edm::PtrVector< reco::CaloCluster >.

Definition at line 157 of file PtrVectorBase.h.

                                                  {
       assert(false);
       return typeid(void);
     }

References cms::cuda::assert(), and funct::void.

Referenced by getProduct_().

◆ void_begin()

std::vector<void const*>::const_iterator edm::PtrVectorBase::void_begin ( ) const

inlineprotected

Definition at line 114 of file PtrVectorBase.h.

                                                             {
       getProduct_();
       if (not checkCachedItems()) {
         return emptyCache().begin();
       }
       return (*cachedItems_).begin();
     }

References checkCachedItems(), emptyCache(), and getProduct_().

Referenced by edm::PtrVector< reco::CaloCluster >::begin().

◆ void_end()

std::vector<void const*>::const_iterator edm::PtrVectorBase::void_end ( ) const

inlineprotected

Definition at line 121 of file PtrVectorBase.h.

                                                           {
       getProduct_();
       if (not checkCachedItems()) {
         return emptyCache().end();
       }
       return (*cachedItems_).end();
     }

References checkCachedItems(), emptyCache(), and getProduct_().

Referenced by edm::PtrVector< reco::CaloCluster >::end().

Member Data Documentation

◆ cachedItems_

std::atomic<std::vector<void const*>*> edm::PtrVectorBase::cachedItems_

mutableprivate

Definition at line 173 of file PtrVectorBase.h.

Referenced by checkCachedItems(), clear(), getProduct_(), hasCache(), isAvailable(), makePtr(), PtrVectorBase(), push_back_base(), reserve(), swap(), and ~PtrVectorBase().

◆ core_

RefCore edm::PtrVectorBase::core_

private

Definition at line 171 of file PtrVectorBase.h.

Referenced by clear(), id(), isAvailable(), isNonnull(), isTransient(), operator==(), productGetter(), push_back_base(), setProductGetter(), and swap().

◆ indicies_

std::vector<key_type> edm::PtrVectorBase::indicies_

private

Definition at line 172 of file PtrVectorBase.h.

Referenced by capacity(), clear(), empty(), getProduct_(), isAvailable(), makePtr(), operator==(), push_back_base(), reserve(), size(), and swap().

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ key_type

◆ size_type

Constructor & Destructor Documentation

◆ PtrVectorBase() [1/3]

◆ PtrVectorBase() [2/3]

◆ ~PtrVectorBase()

◆ PtrVectorBase() [3/3]

Member Function Documentation

◆ capacity()

◆ checkCachedItems()

◆ clear()

◆ empty()

◆ emptyCache()

◆ getProduct_()

◆ hasCache()

◆ id()

◆ isAvailable()

◆ isNonnull()

◆ isNull()

◆ isTransient()

◆ makePtr() [1/2]

◆ makePtr() [2/2]

◆ operator!()

◆ operator=()

◆ operator==()

◆ product()

◆ productGetter()

◆ push_back_base()

◆ reserve()

◆ setProductGetter()

◆ size()

◆ swap()

◆ typeInfo()

◆ void_begin()

◆ void_end()

Member Data Documentation

◆ cachedItems_

◆ core_

◆ indicies_