G4TAtomicHitsMap< T > Class Template Reference

#include <G4TAtomicHitsMap.hh>

Inheritance diagram for G4TAtomicHitsMap< T >:

Collaboration diagram for G4TAtomicHitsMap< T >:

Public Types
typedef G4atomic< T >	value_type
typedef value_type *	mapped_type
typedef std::map< G4int, mapped_type >	container_type
typedef container_type::iterator	iterator
typedef container_type::const_iterator	const_iterator

Public Member Functions
	G4TAtomicHitsMap ()
	G4TAtomicHitsMap (G4String detName, G4String colNam)
virtual	~G4TAtomicHitsMap ()
G4int	operator== (const G4TAtomicHitsMap< T > &right) const
G4TAtomicHitsMap< T > &	operator+= (const G4TAtomicHitsMap< T > &right) const
G4TAtomicHitsMap< T > &	operator+= (const G4THitsMap< T > &right) const
virtual void	DrawAllHits ()
virtual void	PrintAllHits ()
value_type *	operator[] (G4int key) const
container_type *	GetMap () const
G4int	add (const G4int &key, value_type *&aHit) const
G4int	add (const G4int &key, T &aHit) const
G4int	set (const G4int &key, value_type *&aHit) const
G4int	set (const G4int &key, T &aHit) const
G4int	entries () const
void	clear ()
virtual G4VHit *	GetHit (size_t) const
virtual size_t	GetSize () const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
iterator	find (G4int p)
const_iterator	find (G4int p) const
Public Member Functions inherited from G4VHitsCollection
	G4VHitsCollection ()
	G4VHitsCollection (G4String detName, G4String colNam)
virtual	~G4VHitsCollection ()
G4int	operator== (const G4VHitsCollection &right) const
G4String	GetName ()
G4String	GetSDname ()
	G4VHitsCollection ()
	G4VHitsCollection (G4String detName, G4String colNam)
virtual	~G4VHitsCollection ()
G4int	operator== (const G4VHitsCollection &right) const
G4String	GetName ()
G4String	GetSDname ()
	G4VHitsCollection ()
	G4VHitsCollection (G4String detName, G4String colNam)
virtual	~G4VHitsCollection ()
G4int	operator== (const G4VHitsCollection &right) const
G4String &	GetName ()
G4String &	GetSDname ()
void	SetColID (G4int i)
G4int	GetColID () const

Additional Inherited Members
Protected Attributes inherited from G4VHitsCollection
G4String	collectionName
G4String	SDname
G4int	colID

Detailed Description

template<typename T>
class G4TAtomicHitsMap< T >

This is an implementation of G4THitsMap<T> where the underlying type is G4atomic<T>, not just T. A static assert is provided to ensure that T is fundamental. This class should be used in lieu of G4THitsMap<T> when memory is a concern. Atomics are thread-safe and generally faster that mutexes (as long as the STL implementation is lock-free) but the synchronization does not come without a cost. If performance is the primary concern, use G4THitsMap<T> in thread-local instances.

Definition at line 73 of file G4TAtomicHitsMap.hh.

Member Typedef Documentation

template<typename T>

typedef container_type::const_iterator G4TAtomicHitsMap< T >::const_iterator

Definition at line 84 of file G4TAtomicHitsMap.hh.

template<typename T>

typedef std::map<G4int, mapped_type> G4TAtomicHitsMap< T >::container_type

Definition at line 82 of file G4TAtomicHitsMap.hh.

template<typename T>

typedef container_type::iterator G4TAtomicHitsMap< T >::iterator

Definition at line 83 of file G4TAtomicHitsMap.hh.

template<typename T>

typedef value_type* G4TAtomicHitsMap< T >::mapped_type

Definition at line 81 of file G4TAtomicHitsMap.hh.

template<typename T>

typedef G4atomic<T> G4TAtomicHitsMap< T >::value_type

Definition at line 77 of file G4TAtomicHitsMap.hh.

Constructor & Destructor Documentation

template<typename T >

G4TAtomicHitsMap< T >::G4TAtomicHitsMap

(

)

Definition at line 155 of file G4TAtomicHitsMap.hh.

  : theCollection(new container_type),
    fMutex(G4MUTEX_INITIALIZER)
{ }

template<typename T >

G4TAtomicHitsMap< T >::G4TAtomicHitsMap	(	G4String	detName,
		G4String	colNam
	)

Definition at line 161 of file G4TAtomicHitsMap.hh.

  : G4VHitsCollection(detName,colNam),
    theCollection(new container_type),
    fMutex(G4MUTEX_INITIALIZER)
{ }

template<typename T >

G4TAtomicHitsMap< T >::~G4TAtomicHitsMap ( )

virtual

Definition at line 169 of file G4TAtomicHitsMap.hh.

{
  for(auto itr = theCollection->begin(); itr != theCollection->end(); itr++)
      delete itr->second;

  delete theCollection;
  G4MUTEXDESTROY(fMutex);
}

Member Function Documentation

template<typename T >

G4int G4TAtomicHitsMap< T >::add ( const G4int &  key, value_type *&  aHit  ) const

inline

Definition at line 225 of file G4TAtomicHitsMap.hh.

{
  if(theCollection->find(key) != theCollection->end())
    *(*theCollection)[key] += *aHit;
  else
  {
    G4AutoLock l(&fMutex);
    (*theCollection)[key] = aHit;
  }
  G4AutoLock l(&fMutex);
  return theCollection->size();
}

template<typename T >

G4int G4TAtomicHitsMap< T >::add ( const G4int &  key, T &  aHit  ) const

inline

Definition at line 240 of file G4TAtomicHitsMap.hh.

{

  if(theCollection->find(key) != theCollection->end())
    *(*theCollection)[key] += aHit;
  else
  {
    value_type* hit = new value_type;
    *hit = aHit;
    G4AutoLock l(&fMutex);
    (*theCollection)[key] = hit;
  }
  G4AutoLock l(&fMutex);
  return theCollection->size();
}

template<typename T>

iterator G4TAtomicHitsMap< T >::begin ( )

inline

Definition at line 135 of file G4TAtomicHitsMap.hh.

{ return theCollection->begin(); }

template<typename T>

const_iterator G4TAtomicHitsMap< T >::begin ( ) const

inline

Definition at line 138 of file G4TAtomicHitsMap.hh.

{ return theCollection->begin(); }

template<typename T>

const_iterator G4TAtomicHitsMap< T >::cbegin ( ) const

inline

Definition at line 141 of file G4TAtomicHitsMap.hh.

{ return theCollection->cbegin(); }

template<typename T>

const_iterator G4TAtomicHitsMap< T >::cend ( ) const

inline

Definition at line 142 of file G4TAtomicHitsMap.hh.

{ return theCollection->cend(); }

template<typename T >

void G4TAtomicHitsMap< T >::clear ( void  )

inline

Definition at line 296 of file G4TAtomicHitsMap.hh.

{
  G4AutoLock l(&fMutex);

  for(auto itr = theCollection->begin(); itr != theCollection->end(); itr++)
    delete itr->second;

  theCollection->clear();

}

template<typename T >

void G4TAtomicHitsMap< T >::DrawAllHits ( )

virtual

Reimplemented from G4VHitsCollection.

Definition at line 285 of file G4TAtomicHitsMap.hh.

{ }

template<typename T>

iterator G4TAtomicHitsMap< T >::end ( )

inline

Definition at line 136 of file G4TAtomicHitsMap.hh.

{ return theCollection->end(); }

Here is the caller graph for this function:

template<typename T>

const_iterator G4TAtomicHitsMap< T >::end ( ) const

inline

Definition at line 139 of file G4TAtomicHitsMap.hh.

{ return theCollection->end(); }

template<typename T>

G4int G4TAtomicHitsMap< T >::entries ( ) const

inline

Definition at line 120 of file G4TAtomicHitsMap.hh.

  {
    return theCollection->size();
  }

template<typename T>

iterator G4TAtomicHitsMap< T >::find ( G4int  p )

inline

Definition at line 144 of file G4TAtomicHitsMap.hh.

{ return theCollection->find(p); }

template<typename T>

const_iterator G4TAtomicHitsMap< T >::find ( G4int  p ) const

inline

Definition at line 145 of file G4TAtomicHitsMap.hh.

{ return theCollection->find(p); }

template<typename T>

virtual G4VHit* G4TAtomicHitsMap< T >::GetHit ( size_t  ) const

inlinevirtual

Reimplemented from G4VHitsCollection.

Definition at line 128 of file G4TAtomicHitsMap.hh.

{return 0;}

template<typename T>

container_type* G4TAtomicHitsMap< T >::GetMap ( ) const

inline

Definition at line 109 of file G4TAtomicHitsMap.hh.

  { return theCollection; }

Here is the caller graph for this function:

template<typename T>

virtual size_t G4TAtomicHitsMap< T >::GetSize ( ) const

inlinevirtual

Reimplemented from G4VHitsCollection.

Definition at line 129 of file G4TAtomicHitsMap.hh.

  {
    return theCollection->size();
  }

template<typename T >

G4TAtomicHitsMap< T > & G4TAtomicHitsMap< T >::operator+=

(

const G4TAtomicHitsMap< T > &

right

)

const

Definition at line 186 of file G4TAtomicHitsMap.hh.

{
  for(auto itr = rhs.GetMap()->begin(); itr != rhs.GetMap()->end(); itr++)
    add(itr->first, *(itr->second));

  return (G4TAtomicHitsMap<T>&)(*this);
}

Here is the call graph for this function:

template<typename T >

G4TAtomicHitsMap< T > & G4TAtomicHitsMap< T >::operator+=

(

const G4THitsMap< T > &

right

)

const

Definition at line 196 of file G4TAtomicHitsMap.hh.

{
  for(auto itr = rhs.GetMap()->begin(); itr != rhs.GetMap()->end(); itr++)
    add(itr->first, *(itr->second));

  return (G4TAtomicHitsMap<T>&)(*this);
}

Here is the call graph for this function:

template<typename T >

G4int G4TAtomicHitsMap< T >::operator==

(

const G4TAtomicHitsMap< T > &

right

)

const

Definition at line 179 of file G4TAtomicHitsMap.hh.

{
  return (collectionName == right.collectionName);
}

template<typename T >

G4TAtomicHitsMap< T >::value_type * G4TAtomicHitsMap< T >::operator[] ( G4int  key ) const

inline

Definition at line 206 of file G4TAtomicHitsMap.hh.

{
  if(theCollection->find(key) != theCollection->end())
    return theCollection->find(key)->second;
  else
  {
    G4AutoLock l(&fMutex);
    if(theCollection->find(key) == theCollection->end())
    {
      value_type* ptr = new value_type;
      (*theCollection)[key] = ptr;
      return ptr;
    } else
      return theCollection->find(key)->second;
  }
}

template<typename T >

void G4TAtomicHitsMap< T >::PrintAllHits ( )

virtual

Reimplemented from G4VHitsCollection.

Definition at line 289 of file G4TAtomicHitsMap.hh.

{
  G4cout << "G4TAtomicHitsMap " << SDname << " / " << collectionName << " --- "
         << entries() << " entries" << G4endl;
}

template<typename T >

G4int G4TAtomicHitsMap< T >::set ( const G4int &  key, value_type *&  aHit  ) const

inline

Definition at line 258 of file G4TAtomicHitsMap.hh.

{
  if(theCollection->find(key) != theCollection->end())
      delete (*theCollection)[key]->second;

  (*theCollection)[key] = aHit;
  G4AutoLock l(&fMutex);
  return theCollection->size();
}

template<typename T >

G4int G4TAtomicHitsMap< T >::set ( const G4int &  key, T &  aHit  ) const

inline

Definition at line 270 of file G4TAtomicHitsMap.hh.

{
    if(theCollection->find(key) != theCollection->end())
        *(*theCollection)[key] = aHit;
    else
    {
      value_type* hit = new value_type;
      *hit = aHit;
      (*theCollection)[key] = hit;
    }
    G4AutoLock l(&fMutex);
    return theCollection->size();
}

---

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

• source/geant4.10.03.p02/examples/extended/parallel/ThreadsafeScorers/include/G4TAtomicHitsMap.hh