Cache is a generic caching storage class. More...

#include <Kernel/Cache.h>

Public Member Functions
	Cache ()
	No-arg Constructor.

	Cache (const Cache< KEYTYPE, VALUETYPE > &src)
	Copy constructor (mutex cannot be copied)

void	clear ()
	Clears the cache.

bool	getCache (const KEYTYPE &key, VALUETYPE &value) const
	Attempts to retrieve a value from the cache, with optional cache stats tracking.

int	hitCount ()
	total number of times the cache has contained the requested information

double	hitRatio ()
	total number of times the cache has contained the requested information/the total number of requests

int	missCount ()
	total number of times the cache has contained the requested information

Cache< KEYTYPE, VALUETYPE > &	operator= (const Cache< KEYTYPE, VALUETYPE > &rhs)
	Copy-assignment operator as we have a non-default copy constructor.

void	removeCache (const KEYTYPE &key)
	Attempts to remove a value from the cache.

void	setCache (const KEYTYPE &key, const VALUETYPE &value)
	Inserts/updates a cached value with the given key.

int	size ()
	The number of cache entries.

Private Types
using	CacheMapConstIterator = typename std::map< KEYTYPE, VALUETYPE >::const_iterator
	const_iterator typedef

using	CacheMapIterator = typename std::map< KEYTYPE, VALUETYPE >::iterator
	iterator typedef

Private Member Functions
bool	getCacheNoStats (const KEYTYPE key, VALUETYPE &value) const
	Attempts to retrieve a value from the cache.

Private Attributes
int	m_cacheHit
	total number of times the cache has contained the requested information

std::map< KEYTYPE, VALUETYPE >	m_cacheMap
	internal cache map

int	m_cacheMiss
	total number of times the cache has not contained the requested information

std::mutex	m_mutex
	internal mutex

Detailed Description

template<class KEYTYPE, class VALUETYPE>
class Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >

Cache is a generic caching storage class.

Author: Nick Draper, Tessella Support Services plc

Date: 20/10/2009

Definition at line 27 of file Cache.h.

Member Typedef Documentation

◆ CacheMapConstIterator

template<class KEYTYPE , class VALUETYPE >

using Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::CacheMapConstIterator = typename std::map<KEYTYPE, VALUETYPE>::const_iterator

private

const_iterator typedef

Definition at line 156 of file Cache.h.

◆ CacheMapIterator

template<class KEYTYPE , class VALUETYPE >

using Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::CacheMapIterator = typename std::map<KEYTYPE, VALUETYPE>::iterator

private

iterator typedef

Definition at line 154 of file Cache.h.

Constructor & Destructor Documentation

◆ Cache() [1/2]

template<class KEYTYPE , class VALUETYPE >

Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::Cache ( )

inline

No-arg Constructor.

Definition at line 30 of file Cache.h.

◆ Cache() [2/2]

template<class KEYTYPE , class VALUETYPE >

Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::Cache ( const Cache< KEYTYPE, VALUETYPE > & src )

inline

Copy constructor (mutex cannot be copied)

Parameters

src	The object that this object shall be constructed from.

Definition at line 36 of file Cache.h.

Member Function Documentation

◆ clear()

template<class KEYTYPE , class VALUETYPE >

void Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::clear ( )

inline

Clears the cache.

Definition at line 56 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheHit, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMiss, and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_mutex.

◆ getCache()

template<class KEYTYPE , class VALUETYPE >

bool Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCache	(	const KEYTYPE &	key,
		VALUETYPE &	value
	)		const

inline

Attempts to retrieve a value from the cache, with optional cache stats tracking.

See also: USE_CACHE_STATS compiler define

Parameters

key	The key for the requested value
value	An output reference for the value, set to the curretn value if found, otherwise it is untouched

Returns: True if the value was found, false otherwise

Definition at line 98 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCacheNoStats(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheHit, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMiss, PARALLEL_ATOMIC, and value.

◆ getCacheNoStats()

template<class KEYTYPE , class VALUETYPE >

bool Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCacheNoStats	(	const KEYTYPE	key,
		VALUETYPE &	value
	)		const

inlineprivate

Attempts to retrieve a value from the cache.

Parameters

key	The key for the requested value
value	An output reference for the value, set to the curretn value if found, otherwise it is untouched

Returns: True if the value was found, false otherwise

Definition at line 132 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_mutex, and value.

Referenced by Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCache().

◆ hitCount()

template<class KEYTYPE , class VALUETYPE >

int Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitCount ( )

inline

total number of times the cache has contained the requested information

Definition at line 67 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheHit.

◆ hitRatio()

template<class KEYTYPE , class VALUETYPE >

double Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitRatio ( )

inline

total number of times the cache has contained the requested information/the total number of requests

Definition at line 72 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitRatio(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheHit, and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMiss.

Referenced by Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitRatio().

◆ missCount()

template<class KEYTYPE , class VALUETYPE >

int Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::missCount ( )

inline

total number of times the cache has contained the requested information

Definition at line 69 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMiss.

◆ operator=()

template<class KEYTYPE , class VALUETYPE >

Cache< KEYTYPE, VALUETYPE > & Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::operator= ( const Cache< KEYTYPE, VALUETYPE > & rhs )

inline

Copy-assignment operator as we have a non-default copy constructor.

Parameters

rhs	The object that is on the RHS of the assignment

Definition at line 45 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheHit, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMiss, and rhs.

◆ removeCache()

template<class KEYTYPE , class VALUETYPE >

void Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::removeCache ( const KEYTYPE & key )

inline

Attempts to remove a value from the cache.

If the key does not exist, it does nothing

Parameters

key	The key whose value should be removed

Definition at line 119 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap, and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_mutex.

◆ setCache()

template<class KEYTYPE , class VALUETYPE >

void Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::setCache	(	const KEYTYPE &	key,
		const VALUETYPE &	value
	)

inline

Inserts/updates a cached value with the given key.

Parameters

key	The key
value	The new value for the key

Definition at line 85 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap, Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_mutex, and value.

◆ size()

template<class KEYTYPE , class VALUETYPE >

int Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::size ( )

inline

The number of cache entries.

Definition at line 64 of file Cache.h.

References Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap.

Member Data Documentation

◆ m_cacheHit

template<class KEYTYPE , class VALUETYPE >

int Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheHit

mutableprivate

total number of times the cache has contained the requested information

Definition at line 145 of file Cache.h.

Referenced by Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::clear(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCache(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitCount(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitRatio(), and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::operator=().

◆ m_cacheMap

template<class KEYTYPE , class VALUETYPE >

std::map<KEYTYPE, VALUETYPE> Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMap

private

internal cache map

Definition at line 150 of file Cache.h.

Referenced by Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::clear(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCacheNoStats(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::operator=(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::removeCache(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::setCache(), and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::size().

◆ m_cacheMiss

template<class KEYTYPE , class VALUETYPE >

int Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_cacheMiss

mutableprivate

total number of times the cache has not contained the requested information

Definition at line 148 of file Cache.h.

Referenced by Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::clear(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCache(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::hitRatio(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::missCount(), and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::operator=().

◆ m_mutex

template<class KEYTYPE , class VALUETYPE >

std::mutex Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::m_mutex

mutableprivate

internal mutex

Definition at line 152 of file Cache.h.

Referenced by Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::clear(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::getCacheNoStats(), Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::removeCache(), and Mantid::Kernel::Cache< KEYTYPE, VALUETYPE >::setCache().

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

Framework/API/inc/MantidAPI/LogManager.h
Framework/Kernel/inc/MantidKernel/Cache.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CacheMapConstIterator

◆ CacheMapIterator

Constructor & Destructor Documentation

◆ Cache() [1/2]

◆ Cache() [2/2]

Member Function Documentation

◆ clear()

◆ getCache()

◆ getCacheNoStats()

◆ hitCount()

◆ hitRatio()

◆ missCount()

◆ operator=()

◆ removeCache()

◆ setCache()

◆ size()

Member Data Documentation

◆ m_cacheHit

◆ m_cacheMap

◆ m_cacheMiss

◆ m_mutex