apollo::common::util::LRUCache< K, V > 模板类 参考

#include <lru_cache.h>

apollo::common::util::LRUCache< K, V > 的协作图:

Public 成员函数
	LRUCache (const size_t capacity=kDefaultCapacity)
	~LRUCache ()
void	GetCache (std::map< K, V > *cache)
V &	operator[] (const K &key)
void	GetAllSilently (std::vector< V * > *ret)
template<typename VV >
bool	Put (const K &key, VV &&val)
template<typename VV >
bool	Update (const K &key, VV &&val)
template<typename VV >
bool	UpdateSilently (const K &key, VV *val)
template<typename VV >
bool	Add (const K &key, VV *val)
template<typename VV >
bool	PutAndGetObsolete (const K &key, VV *val, K *obs)
template<typename VV >
bool	AddAndGetObsolete (const K &key, VV *val, K *obs)
V *	GetSilently (const K &key)
V *	Get (const K &key)
bool	GetCopySilently (const K &key, V *const val)
bool	GetCopy (const K &key, V *const val)
size_t	size ()
bool	Full ()
bool	Empty ()
size_t	capacity ()
Node< K, V > *	First ()
Node< K, V > *	Last ()
bool	Contains (const K &key)
bool	Prioritize (const K &key)
void	Clear ()
bool	Remove (const K &key)
bool	ChangeCapacity (const size_t capacity)

详细描述

template<class K, class V>
class apollo::common::util::LRUCache< K, V >

在文件 lru_cache.h 第 43 行定义.

构造及析构函数说明

LRUCache()

template<class K , class V >

apollo::common::util::LRUCache< K, V >::LRUCache ( const size_t  capacity = kDefaultCapacity )

inlineexplicit

在文件 lru_cache.h 第 45 行定义.

      : capacity_(capacity), head_(), tail_() {
    Init();
  }

~LRUCache()

template<class K , class V >

apollo::common::util::LRUCache< K, V >::~LRUCache ( )

inline

在文件 lru_cache.h 第 50 行定义.

{ Clear(); }

成员函数说明

Add()

template<class K , class V >

template<typename VV >

bool apollo::common::util::LRUCache< K, V >::Add ( const K &  key, VV *  val  )

inline

在文件 lru_cache.h 第 112 行定义.

                                  {
    K tmp;
    return Update(key, std::forward<VV>(*val), &tmp, true, false);
  }

AddAndGetObsolete()

template<class K , class V >

template<typename VV >

bool apollo::common::util::LRUCache< K, V >::AddAndGetObsolete ( const K &  key, VV *  val, K *  obs  )

inline

在文件 lru_cache.h 第 123 行定义.

                                                        {
    return Update(key, std::forward<VV>(*val), obs, true, false);
  }

capacity()

template<class K , class V >

size_t apollo::common::util::LRUCache< K, V >::capacity ( )

inline

在文件 lru_cache.h 第 143 行定义.

{ return capacity_; }

ChangeCapacity()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::ChangeCapacity ( const size_t  capacity )

inline

在文件 lru_cache.h 第 185 行定义.

                                             {
    if (size() > capacity) {
      return false;
    }
    capacity_ = capacity;
    return true;
  }

Clear()

template<class K , class V >

void apollo::common::util::LRUCache< K, V >::Clear ( )

inline

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

               {
    map_.clear();
    Init();
  }

Contains()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::Contains ( const K &  key )

inline

在文件 lru_cache.h 第 159 行定义.

{ return map_.find(key) != map_.end(); }

Empty()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::Empty ( )

inline

在文件 lru_cache.h 第 141 行定义.

{ return size() == 0; }

First()

template<class K , class V >

Node< K, V > * apollo::common::util::LRUCache< K, V >::First ( )

inline

在文件 lru_cache.h 第 145 行定义.

                      {
    if (size()) {
      return head_.next;
    }
    return nullptr;
  }

Full()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::Full ( )

inline

在文件 lru_cache.h 第 139 行定义.

{ return size() > 0 && size() >= capacity_; }

Get()

template<class K , class V >

V * apollo::common::util::LRUCache< K, V >::Get ( const K &  key )

inline

在文件 lru_cache.h 第 129 行定义.

{ return Get(key, false); }

GetAllSilently()

template<class K , class V >

void apollo::common::util::LRUCache< K, V >::GetAllSilently ( std::vector< V * > *  ret )

inline

在文件 lru_cache.h 第 69 行定义.

                                          {
    for (auto it = map_.begin(); it != map_.end(); ++it) {
      ret->push_back(&it->second.val);
    }
  }

GetCache()

template<class K , class V >

void apollo::common::util::LRUCache< K, V >::GetCache ( std::map< K, V > *  cache )

inline

在文件 lru_cache.h 第 52 行定义.

                                     {
    for (auto it = map_.begin(); it != map_.end(); ++it) {
      cache->emplace(it->first, it->second.val);
    }
  }

GetCopy()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::GetCopy ( const K &  key, V *const  val  )

inline

在文件 lru_cache.h 第 135 行定义.

{ return GetCopy(key, val, false); }

GetCopySilently()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::GetCopySilently ( const K &  key, V *const  val  )

inline

在文件 lru_cache.h 第 131 行定义.

                                                   {
    return GetCopy(key, val, true);
  }

GetSilently()

template<class K , class V >

V * apollo::common::util::LRUCache< K, V >::GetSilently ( const K &  key )

inline

在文件 lru_cache.h 第 127 行定义.

{ return Get(key, true); }

Last()

template<class K , class V >

Node< K, V > * apollo::common::util::LRUCache< K, V >::Last ( )

inline

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

                     {
    if (size()) {
      return tail_.prev;
    }
    return nullptr;
  }

operator[]()

template<class K , class V >

V & apollo::common::util::LRUCache< K, V >::operator[] ( const K &  key )

inline

在文件 lru_cache.h 第 58 行定义.

                              {
    if (!Contains(key)) {
      K obsolete;
      GetObsolete(&obsolete);
    }
    return map_[key].val;
  }

Prioritize()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::Prioritize ( const K &  key )

inline

在文件 lru_cache.h 第 161 行定义.

                                {
    if (Contains(key)) {
      auto* node = &map_[key];
      Detach(node);
      Attach(node);
      return true;
    }
    return false;
  }

Put()

template<class K , class V >

template<typename VV >

bool apollo::common::util::LRUCache< K, V >::Put ( const K &  key, VV &&  val  )

inline

在文件 lru_cache.h 第 79 行定义.

                                   {
    K tmp;
    return Update(key, std::forward<VV>(val), &tmp, false, false);
  }

PutAndGetObsolete()

template<class K , class V >

template<typename VV >

bool apollo::common::util::LRUCache< K, V >::PutAndGetObsolete ( const K &  key, VV *  val, K *  obs  )

inline

在文件 lru_cache.h 第 118 行定义.

                                                        {
    return Update(key, std::forward<VV>(*val), obs, false, false);
  }

Remove()

template<class K , class V >

bool apollo::common::util::LRUCache< K, V >::Remove ( const K &  key )

inline

在文件 lru_cache.h 第 176 行定义.

                            {
    if (!Contains(key)) {
      return false;
    }
    auto* node = &map_[key];
    Detach(node);
    return true;
  }

size()

template<class K , class V >

size_t apollo::common::util::LRUCache< K, V >::size ( )

inline

在文件 lru_cache.h 第 137 行定义.

{ return size_; }

Update()

template<class K , class V >

template<typename VV >

bool apollo::common::util::LRUCache< K, V >::Update ( const K &  key, VV &&  val  )

inline

在文件 lru_cache.h 第 88 行定义.

                                      {
    if (!Contains(key)) {
      return false;
    }
    K tmp;
    return Update(key, std::forward<VV>(val), &tmp, true, false);
  }

UpdateSilently()

template<class K , class V >

template<typename VV >

bool apollo::common::util::LRUCache< K, V >::UpdateSilently ( const K &  key, VV *  val  )

inline

在文件 lru_cache.h 第 100 行定义.

                                             {
    if (!Contains(key)) {
      return false;
    }
    K tmp;
    return Update(key, std::forward<VV>(*val), &tmp, true, true);
  }

---

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

• modules/common/util/lru_cache.h