Cache< K, V > 模板类 参考

#include <cache.h>

类 Cache< K, V > 继承关系图:

Public 类型
using	kv_pair = std::pair< K, V >
using	iterator = typename std::list< kv_pair >::iterator
using	const_iterator = typename std::list< kv_pair >::const_iterator

Public 成员函数
	Cache (size_t capacity)
	creates a cache that can hold capacity elements 更多...
V *	insert (const K &key, V &&value)
	Inserts value under key in the cache 更多...
V *	insert (const K &key, const V &value)
	Inserts value under key in the cache 更多...
void	remove (const K &key)
	Removes entry key from the cache. 更多...
V *	find (const K &key)
	Finds a value in the cache given the corresponding key. 更多...
size_t	size () const
	Returns the number of values stored in the cache. 更多...
size_t	capacity () const
	Returns the maximum number of values that can be stored in the cache. 更多...
uint64_t	hits () const
	Returns how many of the find() calls did find a value in the cache. 更多...
uint64_t	misses () const
	Returns how many of the find() calls did not found a value in the cache. 更多...
void	clear ()
	Clears all values in the cache. 更多...
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const

Private 成员函数
void	resize ()

Private 属性
size_t	m_capacity
std::list< kv_pair >	m_cacheItemList
std::unordered_map< K, iterator >	m_cacheItemMap
uint64_t	m_hits =0
uint64_t	m_misses =0

详细描述

template<typename K, typename V>
class Cache< K, V >

Fixed size cache for value type V using keys of type K.

When the maximum capacity has reached, the least recently used value is removed from the cache (LRU strategy).

在文件 cache.h 第 30 行定义.

成员类型定义说明

const_iterator

template<typename K , typename V >

using Cache< K, V >::const_iterator = typename std::list<kv_pair>::const_iterator

在文件 cache.h 第 48 行定义.

iterator

template<typename K , typename V >

using Cache< K, V >::iterator = typename std::list<kv_pair>::iterator

在文件 cache.h 第 47 行定义.

kv_pair

template<typename K , typename V >

using Cache< K, V >::kv_pair = std::pair<K,V>

在文件 cache.h 第 46 行定义.

构造及析构函数说明

Cache()

template<typename K , typename V >

Cache< K, V >::Cache ( size_t  capacity )

inline

creates a cache that can hold capacity elements

在文件 cache.h 第 51 行定义.

    {

成员函数说明

begin() [1/2]

template<typename K , typename V >

iterator Cache< K, V >::begin ( )

inline

在文件 cache.h 第 150 行定义.

begin() [2/2]

template<typename K , typename V >

const_iterator Cache< K, V >::begin ( ) const

inline

在文件 cache.h 第 152 行定义.

capacity()

template<typename K , typename V >

size_t Cache< K, V >::capacity ( ) const

inline

Returns the maximum number of values that can be stored in the cache.

在文件 cache.h 第 126 行定义.

    {
      return m_misses;
    }
 

clear()

template<typename K , typename V >

void Cache< K, V >::clear ( )

inline

Clears all values in the cache.

在文件 cache.h 第 144 行定义.

    {
      if (m_cacheItemMap.size() > m_capacity)
      {
        auto last_it = m_cacheItemList.end();
        --last_it;

被这些函数引用 parseInput().

end() [1/2]

template<typename K , typename V >

iterator Cache< K, V >::end ( )

inline

在文件 cache.h 第 151 行定义.

end() [2/2]

template<typename K , typename V >

const_iterator Cache< K, V >::end ( ) const

inline

在文件 cache.h 第 153 行定义.

find()

template<typename K , typename V >

V* Cache< K, V >::find ( const K &  key )

inline

Finds a value in the cache given the corresponding key.

返回

a pointer to the value or nullptr if the key is not found in the cache

注解

The hit and miss counters are updated, see hits() and misses().

在文件 cache.h 第 99 行定义.

      {
        m_misses++;
      }
      return nullptr;
    }
 
    //! Returns the number of values stored in the cache.
    size_t size() const
    {
      return m_cacheItemMap.size();
    }
 
    //! Returns the maximum number of values that can be stored in the cache.
    size_t capacity() const
    {
      return m_capacity;
    }
 

被这些函数引用 SymbolResolver::Private::getResolvedClassRec().

hits()

template<typename K , typename V >

uint64_t Cache< K, V >::hits ( ) const

inline

Returns how many of the find() calls did find a value in the cache.

在文件 cache.h 第 132 行定义.

    {
      m_cacheItemMap.clear();
      m_cacheItemList.clear();
    }

insert() [1/2]

template<typename K , typename V >

V* Cache< K, V >::insert ( const K &  key, const V &  value  )

inline

Inserts value under key in the cache

在文件 cache.h 第 70 行定义.

    {
      // remove item if it already exists
      auto it = m_cacheItemMap.find(key);
      if (it != m_cacheItemMap.end())
      {
        m_cacheItemList.erase(it->second);
        m_cacheItemMap.erase(it);
      }
    }

insert() [2/2]

template<typename K , typename V >

V* Cache< K, V >::insert ( const K &  key, V &&  value  )

inline

Inserts value under key in the cache

在文件 cache.h 第 56 行定义.

    {
      // remove item if it already exists
      remove(key);
      // store new item
      m_cacheItemList.push_front(kv_pair(key,value));
      V *result = &m_cacheItemList.front().second;
      m_cacheItemMap[key] = m_cacheItemList.begin();
      // remove least recently used item if cache is full
      resize();
      return result;

被这些函数引用 SymbolResolver::Private::getResolvedClassRec().

misses()

template<typename K , typename V >

uint64_t Cache< K, V >::misses ( ) const

inline

Returns how many of the find() calls did not found a value in the cache.

在文件 cache.h 第 138 行定义.

                                 { return m_cacheItemList.end();    }
    const_iterator begin() const { return m_cacheItemList.cbegin(); }
    const_iterator end() const   { return m_cacheItemList.cend();   }
 

remove()

template<typename K , typename V >

void Cache< K, V >::remove ( const K &  key )

inline

Removes entry key from the cache.

注解

this invalidates any iterators

在文件 cache.h 第 85 行定义.

    {
      auto it = m_cacheItemMap.find(key);
      if (it != m_cacheItemMap.end())
      {
        // move the item to the front of the list
        m_cacheItemList.splice(m_cacheItemList.begin(),
                               m_cacheItemList,
                               it->second);

被这些函数引用 flushCachedTemplateRelations(), flushUnresolvedRelations() , 以及 Cache< std::string, LookupInfo >::insert().

resize()

template<typename K , typename V >

void Cache< K, V >::resize ( )

inlineprivate

在文件 cache.h 第 156 行定义.

被这些函数引用 Cache< std::string, LookupInfo >::insert().

size()

template<typename K , typename V >

size_t Cache< K, V >::size ( ) const

inline

Returns the number of values stored in the cache.

在文件 cache.h 第 120 行定义.

    {
      return m_hits;
    }
 

类成员变量说明

m_cacheItemList

template<typename K , typename V >

std::list<kv_pair> Cache< K, V >::m_cacheItemList

private

在文件 cache.h 第 168 行定义.

被这些函数引用 Cache< std::string, LookupInfo >::clear(), Cache< std::string, LookupInfo >::hits(), Cache< std::string, LookupInfo >::insert(), Cache< std::string, LookupInfo >::misses() , 以及 Cache< std::string, LookupInfo >::remove().

m_cacheItemMap

template<typename K , typename V >

std::unordered_map<K,iterator> Cache< K, V >::m_cacheItemMap

private

在文件 cache.h 第 170 行定义.

被这些函数引用 Cache< std::string, LookupInfo >::clear(), Cache< std::string, LookupInfo >::hits(), Cache< std::string, LookupInfo >::insert() , 以及 Cache< std::string, LookupInfo >::remove().

m_capacity

template<typename K , typename V >

size_t Cache< K, V >::m_capacity

private

在文件 cache.h 第 166 行定义.

被这些函数引用 Cache< std::string, LookupInfo >::clear().

m_hits

template<typename K , typename V >

uint64_t Cache< K, V >::m_hits =0

private

在文件 cache.h 第 171 行定义.

被这些函数引用 Cache< std::string, LookupInfo >::remove() , 以及 Cache< std::string, LookupInfo >::size().

m_misses

template<typename K , typename V >

uint64_t Cache< K, V >::m_misses =0

private

在文件 cache.h 第 172 行定义.

被这些函数引用 Cache< std::string, LookupInfo >::capacity() , 以及 Cache< std::string, LookupInfo >::find().

---

该类的文档由以下文件生成:

• src/cache.h