DResourcePool< DType > Class Template Reference

#include <DResourcePool.h>

Inheritance diagram for DResourcePool< DType >:

Public Member Functions
	DResourcePool (void)
	DResourcePool (size_t locGetBatchSize, size_t locNumToAllocateAtOnce, size_t locMaxLocalPoolSize)
	DResourcePool (size_t locGetBatchSize, size_t locNumToAllocateAtOnce, size_t locMaxLocalPoolSize, size_t locMaxSharedPoolSize, size_t locDebugLevel)
	~DResourcePool (void)
void	Set_ControlParams (size_t locGetBatchSize, size_t locNumToAllocateAtOnce, size_t locMaxLocalPoolSize)
void	Set_ControlParams (size_t locGetBatchSize, size_t locNumToAllocateAtOnce, size_t locMaxLocalPoolSize, size_t locMaxSharedPoolSize, size_t locDebugLevel)
DType *	Get_Resource (void)
shared_ptr< DType >	Get_SharedResource (void)
void	Recycle (const DType *locResource)
void	Recycle (vector< const DType * > &locResources)
void	Recycle (DType *locResource)
void	Recycle (vector< DType * > &locResources)
size_t	Get_SharedPoolSize (void) const
size_t	Get_PoolSize (void) const
size_t	Get_NumObjectsAllThreads (void) const

Static Public Member Functions
static constexpr unsigned int	Get_CacheLineSize (void)

Private Member Functions
template<typename RType >
std::enable_if < std::is_base_of< DResettable, RType >::value, void >::type	Release_Resources (DResettable *locResource)
template<typename RType >
std::enable_if < std::is_base_of< DResettable, RType >::value, void >::type	Reset (DResettable *locResource)
template<typename RType >
std::enable_if <!std::is_base_of< DResettable, RType >::value, void >::type	Release_Resources (RType *locResource)
template<typename RType >
std::enable_if <!std::is_base_of< DResettable, RType >::value, void >::type	Reset (RType *locResource)
void	Get_Resources_StaticPool (void)
void	Recycle_Resources_StaticPool (vector< DType * > &locResources)

Private Attributes
size_t	dDebugLevel = 0
size_t	dGetBatchSize = 100
size_t	dNumToAllocateAtOnce = 20
size_t	dMaxLocalPoolSize = 2000
vector< DType * >	dResourcePool_Local

Static Private Attributes
static mutex	dSharedPoolMutex
static vector< DType * >	dResourcePool_Shared = {}
static size_t	dMaxSharedPoolSize
static size_t	dPoolCounter {0}
static atomic< size_t >	dObjectCounter {0}

Detailed Description

template<typename DType>
class DResourcePool< DType >

Definition at line 94 of file DResourcePool.h.

Constructor & Destructor Documentation

template<typename DType >

DResourcePool< DType >::DResourcePool

(

void

)

Definition at line 210 of file DResourcePool.h.

template<typename DType >

DResourcePool< DType >::DResourcePool	(	size_t	locGetBatchSize,
		size_t	locNumToAllocateAtOnce,
		size_t	locMaxLocalPoolSize
	)

Definition at line 205 of file DResourcePool.h.

References DResourcePool< DType >::Set_ControlParams().

template<typename DType >

DResourcePool< DType >::DResourcePool	(	size_t	locGetBatchSize,
		size_t	locNumToAllocateAtOnce,
		size_t	locMaxLocalPoolSize,
		size_t	locMaxSharedPoolSize,
		size_t	locDebugLevel
	)

Definition at line 200 of file DResourcePool.h.

References DResourcePool< DType >::Set_ControlParams().

template<typename DType >

DResourcePool< DType >::~DResourcePool

(

void

)

Definition at line 224 of file DResourcePool.h.

Member Function Documentation

template<typename DType>

static constexpr unsigned int DResourcePool< DType >::Get_CacheLineSize ( void  )

inlinestatic

Returns the cache line size for the processor of the target platform.

The cache line size is useful for creating a buffer to make sure that a variable accessed by multiple threads does not share the cache line it is on. This is useful for variables that may be written-to by one of the threads, because the thread will acquire locked access to the entire cache line. This blocks other threads from operating on the other data stored on the cache line. Note that it is also important to align the shared data as well. See http://www.drdobbs.com/parallel/eliminate-false-sharing/217500206?pgno=4 for more details.

Definition at line 125 of file DResourcePool.h.

template<typename DType>

size_t DResourcePool< DType >::Get_NumObjectsAllThreads ( void  ) const

inline

Definition at line 123 of file DResourcePool.h.

Referenced by DBeamPhoton_factory::Get_NumObjectsAllThreads(), DNeutralParticleHypothesis_factory::Get_NumObjectsAllThreads(), DHistogramAction_ObjectMemory::Perform_Action(), DAnalysis::DParticleComboCreator::Reset(), and DAnalysis::DSourceComboer::Reset_NewEvent().

template<typename DType>

size_t DResourcePool< DType >::Get_PoolSize ( void  ) const

inline

Definition at line 122 of file DResourcePool.h.

template<typename DType >

DType * DResourcePool< DType >::Get_Resource

(

void

)

Definition at line 259 of file DResourcePool.h.

Referenced by DAnalysis::DParticleComboCreator::Build_KinematicData(), DAnalysis::DParticleComboCreator::Build_ParticleCombo(), DAnalysis::DSourceComboVertexer::Construct_DecayingParticle_InvariantMass(), DAnalysis::DSourceComboVertexer::Construct_DecayingParticle_MissingMass(), DBeamPhoton_factory::Get_Resource(), and DNeutralParticleHypothesis_factory::Get_Resource().

template<typename DType >

void DResourcePool< DType >::Get_Resources_StaticPool ( void  )

private

Definition at line 345 of file DResourcePool.h.

template<typename DType >

size_t DResourcePool< DType >::Get_SharedPoolSize

(

void

)

const

Definition at line 388 of file DResourcePool.h.

template<typename DType >

shared_ptr< DType > DResourcePool< DType >::Get_SharedResource

(

void

)

Definition at line 302 of file DResourcePool.h.

template<typename DType>

void DResourcePool< DType >::Recycle ( const DType *  locResource )

inline

Definition at line 114 of file DResourcePool.h.

Referenced by DAnalysisResults_factory::evnt(), DChargedTrackHypothesis_factory::evnt(), DResourcePool< DChargedTrackHypothesis::DTimingInfo >::Recycle(), DNeutralParticleHypothesis_factory::Recycle_Hypotheses(), DNeutralParticleHypothesis_factory::Recycle_Hypothesis(), DBeamPhoton_factory::Recycle_Resource(), DBeamPhoton_factory::Recycle_Resources(), DAnalysis::DParticleComboCreator::Reset(), DAnalysis::DSourceComboVertexer::Reset(), and DAnalysis::DSourceComboer::Reset_NewEvent().

template<typename DType>

void DResourcePool< DType >::Recycle

(

vector< const DType * > &

locResources

)

Definition at line 307 of file DResourcePool.h.

template<typename DType>

void DResourcePool< DType >::Recycle

(

DType *

locResource

)

Definition at line 335 of file DResourcePool.h.

template<typename DType>

void DResourcePool< DType >::Recycle

(

vector< DType * > &

locResources

)

Definition at line 319 of file DResourcePool.h.

template<typename DType>

void DResourcePool< DType >::Recycle_Resources_StaticPool ( vector< DType * > &  locResources )

private

Definition at line 361 of file DResourcePool.h.

template<typename DType>

template<typename RType >

std::enable_if<std::is_base_of<DResettable, RType>::value, void>::type DResourcePool< DType >::Release_Resources ( DResettable *  locResource )

inlineprivate

Definition at line 141 of file DResourcePool.h.

template<typename DType>

template<typename RType >

std::enable_if<!std::is_base_of<DResettable, RType>::value, void>::type DResourcePool< DType >::Release_Resources ( RType *  locResource )

inlineprivate

Definition at line 145 of file DResourcePool.h.

template<typename DType>

template<typename RType >

std::enable_if<std::is_base_of<DResettable, RType>::value, void>::type DResourcePool< DType >::Reset ( DResettable *  locResource )

inlineprivate

Definition at line 142 of file DResourcePool.h.

template<typename DType>

template<typename RType >

std::enable_if<!std::is_base_of<DResettable, RType>::value, void>::type DResourcePool< DType >::Reset ( RType *  locResource )

inlineprivate

Definition at line 146 of file DResourcePool.h.

template<typename DType >

void DResourcePool< DType >::Set_ControlParams	(	size_t	locGetBatchSize,
		size_t	locNumToAllocateAtOnce,
		size_t	locMaxLocalPoolSize
	)

Definition at line 295 of file DResourcePool.h.

Referenced by DBeamPhoton_factory::DBeamPhoton_factory(), DAnalysis::DParticleComboCreator::DParticleComboCreator(), DResourcePool< DType >::DResourcePool(), DAnalysis::DSourceComboer::DSourceComboer(), DAnalysisResults_factory::init(), DChargedTrackHypothesis_factory::init(), and DNeutralParticleHypothesis_factory::init().

template<typename DType >

void DResourcePool< DType >::Set_ControlParams	(	size_t	locGetBatchSize,
		size_t	locNumToAllocateAtOnce,
		size_t	locMaxLocalPoolSize,
		size_t	locMaxSharedPoolSize,
		size_t	locDebugLevel
	)

Definition at line 282 of file DResourcePool.h.

Member Data Documentation

template<typename DType>

size_t DResourcePool< DType >::dDebugLevel = 0

private

Definition at line 152 of file DResourcePool.h.

template<typename DType>

size_t DResourcePool< DType >::dGetBatchSize = 100

private

Definition at line 153 of file DResourcePool.h.

template<typename DType>

size_t DResourcePool< DType >::dMaxLocalPoolSize = 2000

private

Definition at line 155 of file DResourcePool.h.

template<typename DType>

size_t DResourcePool< DType >::dMaxSharedPoolSize

staticprivate

Definition at line 161 of file DResourcePool.h.

template<typename DType>

size_t DResourcePool< DType >::dNumToAllocateAtOnce = 20

private

Definition at line 154 of file DResourcePool.h.

template<typename DType>

atomic< size_t > DResourcePool< DType >::dObjectCounter {0}

staticprivate

Definition at line 163 of file DResourcePool.h.

template<typename DType>

size_t DResourcePool< DType >::dPoolCounter {0}

staticprivate

Definition at line 162 of file DResourcePool.h.

template<typename DType>

vector<DType*> DResourcePool< DType >::dResourcePool_Local

private

Definition at line 156 of file DResourcePool.h.

template<typename DType>

vector< DType * > DResourcePool< DType >::dResourcePool_Shared = {}

staticprivate

Definition at line 160 of file DResourcePool.h.

template<typename DType>

mutex DResourcePool< DType >::dSharedPoolMutex

staticprivate

Definition at line 159 of file DResourcePool.h.

---

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

• DResourcePool.h