Cache thinning decisions for converters. More...

#include <ThinningCache.h>

Collaboration diagram for SG::ThinningCache:

Public Member Functions
bool	empty () const
	Test to see if there's any thinning defined. More...

const ThinningDecisionBase *	thinning (const std::string &key) const
	Return thinning for `key`. More...

const ThinningDecisionBase *	thinning (const sgkey_t sgkey) const
	Return thinning for `sgkey`. More...

void	addThinning (const std::string &key, const std::vector< sgkey_t > &sgkeys, const ThinningDecisionBase *thinning, bool unique=false)
	Add thinning information for one object. More...

const ITrigNavigationThinningSvc *	trigNavigationThinningSvc () const
	Return the TrigNavigation helper for this stream, or nullptr. More...

void	setTrigNavigationThinningSvc (const ITrigNavigationThinningSvc *thinning)
	Set the TrigNavigation helper for this stream. More...

void	lockOwned ()
	Lock all the `ThinningDecisionBase` objects that we own. More...

void	setVetoed (const std::string &key, const CxxUtils::ConcurrentBitset &vetoed)
	Set vetoed variable information one object. More...

void	setCompression (const std::string &key, const ThinningInfo::compression_map_t &compression)
	Set lossy float compression information for the object. More...

const ThinningInfo *	thinningInfo (const std::string &key) const
	Return thinning information for `key`. More...

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

Private Types
typedef std::unordered_map< std::string, ThinningInfo >	map_t
	Mapping by string SG key. More...

typedef SGKeyMap< ThinningInfo >	sgmap_t
	Mapping by hashed SG key. More...

Private Member Functions
void	merge (ThinningInfo &info, const std::vector< sgkey_t > &sgkeys, const ThinningDecisionBase &thinning)
	Merge a new thinning request into an existing one via AND. More...

Private Attributes
map_t	m_map

sgmap_t	m_sgmap

std::vector< std::unique_ptr< ThinningDecisionBase > >	m_owned
	List of decision objects we've copied in order to handle merges. More...

const ITrigNavigationThinningSvc *	m_trigNavigationThinningSvc = nullptr
	Optional TrigNavigation thinning helper for this stream. More...

Detailed Description

Cache thinning decisions for converters.

This class caches thinning decisions for a single stream for the use of converters. ThinningDecision objects may be looked up by SG key, either as a string or as a hashed value.

While writing is in progress, a pointer to the current cache is saved in the EventContext. Converters can find it there.

Definition at line 47 of file ThinningCache.h.

Member Typedef Documentation

◆ map_t

typedef std::unordered_map<std::string, ThinningInfo> SG::ThinningCache::map_t

private

Mapping by string SG key.

Definition at line 152 of file ThinningCache.h.

◆ sgmap_t

typedef SGKeyMap<ThinningInfo> SG::ThinningCache::sgmap_t

private

Mapping by hashed SG key.

Definition at line 156 of file ThinningCache.h.

Member Function Documentation

◆ addThinning()

void SG::ThinningCache::addThinning	(	const std::string &	key,
		const std::vector< sgkey_t > &	sgkeys,
		const ThinningDecisionBase *	thinning,
		bool	unique = `false`
	)

Add thinning information for one object.

Parameters

key	SG string key of the object being added.
sgkeys	SG hashed keys of the object being added.
thinning	Thinning information for the object.
unique	If true, the object must not already be listed in the cache.

If there is already thinning information in the cache for the object identified by key:

If unique is false, the new thinning request will be merged with the existing one via AND.
If unique is true, an exception will be thrown.

Definition at line 77 of file ThinningCache.cxx.

 {
   if (!thinning) return;
  
   {
     ThinningInfo& info = m_map[key];
     if (info.m_decision) {
       if (!unique) {
         merge (info, sgkeys, *thinning);
         return;
       }
       throw std::runtime_error ("Duplicated thinning definition");
     }
     else {
       info.m_decision = thinning;
     }
   }
  
   for (sgkey_t sgkey : sgkeys) {
     ThinningInfo& info = m_sgmap[sgkey];
     if (info.m_decision) {
       throw std::runtime_error ("Duplicated thinning definition");
     }
     info.m_decision = thinning;
   }
 }

◆ clear()

void SG::ThinningCache::clear ( )

Clear the cache.

Definition at line 186 of file ThinningCache.cxx.

 {
   m_map.clear();
   m_sgmap.clear();
   m_owned.clear();
   m_trigNavigationThinningSvc = nullptr;
 }

◆ empty()

bool SG::ThinningCache::empty ( ) const

Test to see if there's any thinning defined.

Definition at line 22 of file ThinningCache.cxx.

 {
   return m_map.empty();
 }

◆ lockOwned()

void SG::ThinningCache::lockOwned ( )

Lock all the ThinningDecisionBase objects that we own.

This should be called after all thinning objects have been added, but before the cache is installed in the EventContext.

Definition at line 134 of file ThinningCache.cxx.

 {
   for (const std::unique_ptr<ThinningDecisionBase>& dec : m_owned) {
     dec->buildIndexMap();
   }
 }

◆ merge()

void SG::ThinningCache::merge	(	ThinningInfo &	info,
		const std::vector< sgkey_t > &	sgkeys,
		const ThinningDecisionBase &	thinning
	)

private

Merge a new thinning request into an existing one via AND.

Parameters

info	`ThinningInfo` with existing decision.
sgkeys	SG hashed keys of the object being added.
thinning	New thinning decision.

The new thinning decision will be combined with the old one via AND.

Definition at line 203 of file ThinningCache.cxx.

 {
   // The existing thinning object.
   ThinningDecisionBase* oldThinning = nullptr;
  
   // Look for the existing object in our list of owned decision objects.
   // If we don't find it, then we'll need to make a copy of the existing
   // decision so that we can modify it.
   // We expect this to be relatively rare and the number of such objects
   // to be small, so just use a linear search.
   auto ownedIt = std::find_if (m_owned.begin(), m_owned.end(),
                                [old = info.m_decision]
                                (const std::unique_ptr<SG::ThinningDecisionBase>& p)
                                { return p.get() == old; });
  
   if (ownedIt != m_owned.end()) {
     // We already own the existing decision.  We can just use it.
     oldThinning = ownedIt->get();
   }
   else {
     // We need to make a copy of the existing decision and enter it into the maps.
     m_owned.push_back (std::make_unique<SG::ThinningDecisionBase> (info.m_decision->size()));
     oldThinning = m_owned.back().get();
     oldThinning->thin (*info.m_decision);
     info.m_decision = oldThinning;
  
     for (sgkey_t sgkey : sgkeys) {
       m_sgmap[sgkey].m_decision = oldThinning;
     }
   }
  
   // Merge the decisions.
   oldThinning->thin (thinning, SG::ThinningDecisionBase::Op::And);
 }

◆ setCompression()

void SG::ThinningCache::setCompression	(	const std::string &	key,
		const ThinningInfo::compression_map_t &	compression
	)

Set lossy float compression information for the object.

Parameters

key	SG string key of the object being added.
compression	Map of compression levels to variables for this object.

Definition at line 160 of file ThinningCache.cxx.

 {
   m_map[key].m_compression = compression;
 }

◆ setTrigNavigationThinningSvc()

void SG::ThinningCache::setTrigNavigationThinningSvc ( const ITrigNavigationThinningSvc * thinning )

Set the TrigNavigation helper for this stream.

Parameters

thinning TrigNavigation helper.

Definition at line 122 of file ThinningCache.cxx.

 {
   m_trigNavigationThinningSvc = thinning;
 }

◆ setVetoed()

void SG::ThinningCache::setVetoed	(	const std::string &	key,
		const CxxUtils::ConcurrentBitset &	vetoed
	)

Set vetoed variable information one object.

Set selected variable information one object.

Parameters

key	SG string key of the object being added.
vetoed	Set of vetoed variables for this object.
key	SG string key of the object being added.
sgkeys	SG hashed keys of the object being added.
vetoed	Set of vetoed variables for this object.

Definition at line 148 of file ThinningCache.cxx.

 {
   m_map[key].m_vetoed = vetoed;
 }

◆ thinning() [1/2]

const ThinningDecisionBase * SG::ThinningCache::thinning ( const sgkey_t sgkey ) const

Return thinning for sgkey.

Parameters

key	SG key for which to return thinning.

Return thinning defined for sgkey. Returns nullptr if that object is not thinned.

Definition at line 54 of file ThinningCache.cxx.

 {
   auto it = m_sgmap.find (sgkey);
   if (it != m_sgmap.end()) {
     return it->second.m_decision;
   }
   return nullptr;
 }

◆ thinning() [2/2]

const ThinningDecisionBase * SG::ThinningCache::thinning ( const std::string & key ) const

Return thinning for key.

Parameters

key	SG key for which to return thinning.

Return thinning defined for key. Returns nullptr if that object is not thinned.

Definition at line 36 of file ThinningCache.cxx.

 {
   auto it = m_map.find (key);
   if (it != m_map.end()) {
     return it->second.m_decision;
   }
   return nullptr;
 }

◆ thinningInfo()

const ThinningInfo * SG::ThinningCache::thinningInfo ( const std::string & key ) const

Return thinning information for key.

Parameters

key	SG key for which to return selected variables.

Return thinning information key, or nullptr.

Definition at line 173 of file ThinningCache.cxx.

 {
   auto it = m_map.find (key);
   if (it != m_map.end()) {
     return &it->second;
   }
   return nullptr;
 }

◆ trigNavigationThinningSvc()

const ITrigNavigationThinningSvc * SG::ThinningCache::trigNavigationThinningSvc ( ) const

Return the TrigNavigation helper for this stream, or nullptr.

Definition at line 112 of file ThinningCache.cxx.

 {
   return m_trigNavigationThinningSvc;
 }

Member Data Documentation

◆ m_map

map_t SG::ThinningCache::m_map

private

Definition at line 153 of file ThinningCache.h.

◆ m_owned

std::vector<std::unique_ptr<ThinningDecisionBase> > SG::ThinningCache::m_owned

private

List of decision objects we've copied in order to handle merges.

Definition at line 160 of file ThinningCache.h.

◆ m_sgmap

sgmap_t SG::ThinningCache::m_sgmap

private

Definition at line 157 of file ThinningCache.h.

◆ m_trigNavigationThinningSvc

const ITrigNavigationThinningSvc* SG::ThinningCache::m_trigNavigationThinningSvc = nullptr

private

Optional TrigNavigation thinning helper for this stream.

Definition at line 163 of file ThinningCache.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_t

◆ sgmap_t

Member Function Documentation

◆ addThinning()

◆ clear()

◆ empty()

◆ lockOwned()

◆ merge()

◆ setCompression()

◆ setTrigNavigationThinningSvc()

◆ setVetoed()

◆ thinning() [1/2]

◆ thinning() [2/2]

◆ thinningInfo()

◆ trigNavigationThinningSvc()

Member Data Documentation

◆ m_map

◆ m_owned

◆ m_sgmap

◆ m_trigNavigationThinningSvc