apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache > 模板类 参考

The data structure of the LRUCache. 更多...

#include <base_map_cache.h>

apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache > 的协作图:

Public 类型
using	DestroyFunc = std::function< bool(Element *)>

Public 成员函数
	MapNodeCache (unsigned int capacity, const DestroyFunc &destroy_func)
	The constructor.
	~MapNodeCache ()
	The destructor.
bool	Get (const Key &key, Element **value)
	Find element for key if it exists in the cache.
bool	GetSilent (const Key &key, Element **value)
	Find element for key if it exists in the cache.
Element *	Put (const Key &key, Element *value)
	Caches element for key.
Element *	Remove (const Key &key)
	Remove element for key.
Element *	ClearOne ()
	Remove the Least Recently Used element in the cache.
bool	IsExist (const Key &key)
	Find element for key in the cache.
bool	ChangeCapacity (int capacity)
	Change cache's max capacity.
unsigned int	Size ()
	return cache's in use.
unsigned	Capacity ()
	return cache's max capacity.

静态 Public 成员函数
static bool	CacheL1Destroy (Element *value)
static bool	CacheL2Destroy (Element *value)

详细描述

template<class Key, class Element, class MapLRUCache = LRUCache<Key, Element>>
class apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >

The data structure of the LRUCache.

在文件 base_map_cache.h 第 33 行定义.

成员类型定义说明

DestroyFunc

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

using apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::DestroyFunc = std::function<bool(Element*)>

在文件 base_map_cache.h 第 35 行定义.

构造及析构函数说明

MapNodeCache()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::MapNodeCache ( unsigned int  capacity, const DestroyFunc &  destroy_func  )

inline

The constructor.

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

      : destroy_func_(destroy_func), lru_map_nodes_(capacity) {}

~MapNodeCache()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::~MapNodeCache ( )

inline

The destructor.

在文件 base_map_cache.h 第 49 行定义.

{}

成员函数说明

CacheL1Destroy()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

static bool apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::CacheL1Destroy ( Element *  value )

inlinestatic

在文件 base_map_cache.h 第 36 行定义.

                                             {
    value->SetIsReserved(false);
    return true;
  }

CacheL2Destroy()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

static bool apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::CacheL2Destroy ( Element *  value )

inlinestatic

在文件 base_map_cache.h 第 40 行定义.

                                             {
    return !(value->GetIsReserved());
  }

Capacity()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

unsigned apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::Capacity ( )

inline

return cache's max capacity.

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

{ return lru_map_nodes_.capacity(); }

ChangeCapacity()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

bool apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::ChangeCapacity ( int  capacity )

inline

Change cache's max capacity.

New capacity must be larger than size in use.

在文件 base_map_cache.h 第 73 行定义.

                                    {
    return lru_map_nodes_.ChangeCapacity(capacity);
  }

ClearOne()

template<class Key , class Element , class MapLRUCache >

Element * apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::ClearOne

(

)

Remove the Least Recently Used element in the cache.

return the removed element or null.

在文件 base_map_cache.h 第 155 行定义.

                                                           {
  auto* node_remove = lru_map_nodes_.Last();
  if (!node_remove) {
    return nullptr;
  }
  while (node_remove != lru_map_nodes_.First()) {
    if (destroy_func_(node_remove->val)) {
      lru_map_nodes_.Remove(node_remove->key);
      return node_remove->val;
    }
    node_remove = node_remove->prev;
  }
  if (node_remove == lru_map_nodes_.First() &&
      destroy_func_(node_remove->val)) {
    lru_map_nodes_.Remove(node_remove->key);
    return node_remove->val;
  }
  return nullptr;
}

Get()

template<class Key , class Element , class MapLRUCache >

bool apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::Get	(	const Key &	key,
		Element **	value
	)

Find element for key if it exists in the cache.

If not exist, return false.

在文件 base_map_cache.h 第 91 行定义.

                                                                   {
  auto value_ptr = lru_map_nodes_.Get(key);
  if (!value_ptr) {
    return false;
  }
  *value = *value_ptr;
  return true;
}

GetSilent()

template<class Key , class Element , class MapLRUCache >

bool apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::GetSilent	(	const Key &	key,
		Element **	value
	)

Find element for key if it exists in the cache.

If not exist, return false. This function is thread safe, but don't change position of element in LRU queue.

在文件 base_map_cache.h 第 102 行定义.

                                                                         {
  auto value_ptr = lru_map_nodes_.GetSilently(key);
  if (!value_ptr) {
    return false;
  }
  *value = *value_ptr;
  return true;
}

IsExist()

template<class Key , class Element , class MapLRUCache >

bool apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::IsExist

(

const Key &

key

)

Find element for key in the cache.

If it exists, move it to the head of queue.

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

                                                                    {
  return lru_map_nodes_.Prioritize(key);
}

Put()

template<class Key , class Element , class MapLRUCache >

Element * apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::Put	(	const Key &	key,
		Element *	value
	)

Caches element for key.

If cache is full, return the removed element, otherwise return null.

在文件 base_map_cache.h 第 113 行定义.

                                                                      {
  if (value == nullptr) {
    AINFO << "LRUCache Warning: put a NULL";
    return nullptr;
  }
 
  auto* value_ptr = lru_map_nodes_.Get(key);
  Element* node_remove = nullptr;
  if (value_ptr) {
    node_remove = *value_ptr;
    if (destroy_func_(node_remove)) {
      *value_ptr = value;
    } else {
      node_remove = value;
    }
    return node_remove;
  }
 
  if (lru_map_nodes_.size() >= lru_map_nodes_.capacity()) {
    auto* node = lru_map_nodes_.Last();
    node_remove = node->val;
    Key key_tmp;
    lru_map_nodes_.PutAndGetObsolete(key, &value, &key_tmp);
    return node_remove;
  }
 
  lru_map_nodes_.Put(key, std::move(value));
  return node_remove;
}

Remove()

template<class Key , class Element , class MapLRUCache >

Element * apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::Remove

(

const Key &

key

)

Remove element for key.

if it exist in the cache, return the element, otherwise return null.

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

                                                                       {
  auto* node_remove = lru_map_nodes_.GetSilently(key);
  if (node_remove && lru_map_nodes_.Remove(key)) {
    return *node_remove;
  }
 
  return nullptr;
}

Size()

template<class Key , class Element , class MapLRUCache = LRUCache<Key, Element>>

unsigned int apollo::localization::msf::MapNodeCache< Key, Element, MapLRUCache >::Size ( )

inline

return cache's in use.

在文件 base_map_cache.h 第 77 行定义.

{ return lru_map_nodes_.size(); }

---

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

• modules/localization/msf/common/util/base_map_cache.h