ParticleExtraInfoMap Class Reference

Internal class to store string -> index maps for extra info stored in Particle. More...

#include <ParticleExtraInfoMap.h>

Inheritance diagram for ParticleExtraInfoMap:

Public Types
typedef std::map< std::string, unsigned int >	IndexMap
	string -> index map.

Public Member Functions
const IndexMap &	getMap (unsigned int mapID) const
	Return reference to map with given ID.
unsigned int	getIndex (unsigned int mapID, const std::string &name) const
	Find index for name in the given map, or return 0 if not found.
unsigned int	getMapForNewVar (const std::string &name)
	Return map ID to a map that has 'name' as first entry.
unsigned int	getMapForNewVar (const std::string &name, unsigned int oldMapID, unsigned int insertIndex)
	Return map ID to a map that has 'name' at place 'insertIndex' and is compatible with previous map (in oldMapID)
unsigned int	getNMaps () const
	How many maps do we use?

Private Member Functions
	ClassDef (ParticleExtraInfoMap, 1)
	Internal class to store string -> index maps for user-defined variables in Particle.

Static Private Member Functions
static bool	isCompatible (const IndexMap &oldMap, const IndexMap &map, unsigned int insertIndex)
	check if all entries in 'oldMap' prior to insertIndex are found in 'map' (with same idx).

Private Attributes
std::vector< IndexMap >	m_maps
	List of string -> index maps.

Detailed Description

Internal class to store string -> index maps for extra info stored in Particle.

An object of this class is used to store all strings used to identify the values added using Particle::addExtraInfo() and keeps Particles fairly light (only values and a map ID are stored directly). The necessary indirection is handled automatically by Particle::getExtraInfo().

Modules registering a StoreArray<Particle> should always register a StoreObjPtr<ParticleExtraInfoMap> to allow storing additional information.

Definition at line 29 of file ParticleExtraInfoMap.h.

Member Typedef Documentation

IndexMap

typedef std::map<std::string, unsigned int> IndexMap

string -> index map.

Definition at line 32 of file ParticleExtraInfoMap.h.

Constructor & Destructor Documentation

ParticleExtraInfoMap()

ParticleExtraInfoMap ( )

inline

Definition at line 34 of file ParticleExtraInfoMap.h.

: TObject() { }

Member Function Documentation

getIndex()

unsigned int getIndex	(	unsigned int	mapID,
		const std::string &	name
	)		const

Find index for name in the given map, or return 0 if not found.

Definition at line 14 of file ParticleExtraInfoMap.cc.

{
  const IndexMap& map = m_maps[mapID];
 
  auto it = map.find(name);
  if (it == map.end())
    return 0;
  else
    return it->second;
}

getMap()

const IndexMap & getMap ( unsigned int  mapID ) const

inline

Return reference to map with given ID.

Definition at line 37 of file ParticleExtraInfoMap.h.

{ return m_maps[mapID]; }

getMapForNewVar() [1/2]

unsigned int getMapForNewVar

(

const std::string &

name

)

Return map ID to a map that has 'name' as first entry.

Creates a new map if necessary.

Definition at line 25 of file ParticleExtraInfoMap.cc.

{
  const unsigned int insertIndex = 1; //0 reserved
  for (unsigned int iMap = 0; iMap < m_maps.size(); iMap++) {
    const auto it = m_maps[iMap].find(name);
    if (it != m_maps[iMap].end() and it->second == insertIndex)
      return iMap;
  }
  //nothing found, add new map
  IndexMap map;
  map[name] = insertIndex;
  m_maps.push_back(map);
 
  //return new index
  return m_maps.size() - 1;
}

getMapForNewVar() [2/2]

unsigned int getMapForNewVar	(	const std::string &	name,
		unsigned int	oldMapID,
		unsigned int	insertIndex
	)

Return map ID to a map that has 'name' at place 'insertIndex' and is compatible with previous map (in oldMapID)

Will reuse old map or another existing map if compatible, creates a new map if necessary.

Definition at line 42 of file ParticleExtraInfoMap.cc.

{
  const IndexMap& oldMap = m_maps[oldMapID];
 
  //first check if old map can be reused
  const unsigned int lastIndexInOldMap = oldMap.size(); //+1 because of reserved 0 index
  if (lastIndexInOldMap + 1 == insertIndex) {
    //we can make oldMap fit by adding one entry
    m_maps[oldMapID][name] = insertIndex;
    return oldMapID;
  }
  auto oldMapIter = oldMap.find(name);
  if (oldMapIter != oldMap.end()) {
    if (oldMapIter->second == insertIndex) {
      return oldMapID; //nothing to do
    }
  }
 
  for (unsigned int iMap = 0; iMap < m_maps.size(); iMap++) {
    const IndexMap& map = m_maps[iMap];
    const auto it = map.find(name);
    if (it != map.end() and it->second == insertIndex) {
      //seems promising
      if (isCompatible(oldMap, map, insertIndex)) {
        //compatible with oldMap, can be used
        return iMap;
      }
    }
  }
 
  //nothing found, add new map (copy all entries prior to insertIndex from oldMap)
  IndexMap map;
  for (const auto& pair : oldMap) {
    if (pair.second < insertIndex)
      map[pair.first] = pair.second;
  }
  map[name] = insertIndex;
  m_maps.push_back(map);
 
  //return new index
  return m_maps.size() - 1;
}

getNMaps()

unsigned int getNMaps ( ) const

inline

How many maps do we use?

Definition at line 55 of file ParticleExtraInfoMap.h.

{ return m_maps.size(); }

isCompatible()

bool isCompatible ( const IndexMap &  oldMap, const IndexMap &  map, unsigned int  insertIndex  )

staticprivate

check if all entries in 'oldMap' prior to insertIndex are found in 'map' (with same idx).

Definition at line 85 of file ParticleExtraInfoMap.cc.

{
  for (const auto& pair : oldMap) {
    if (pair.second < insertIndex) {
      const auto it = map.find(pair.first);
      if (it == map.end() or it->second != pair.second) {
        //mismatch
        return false;
      }
    }
  }
  return true;
}

Member Data Documentation

m_maps

std::vector<IndexMap> m_maps

private

List of string -> index maps.

Definition at line 61 of file ParticleExtraInfoMap.h.

---

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

• analysis/dataobjects/include/ParticleExtraInfoMap.h
• analysis/dataobjects/src/ParticleExtraInfoMap.cc