Pyrogenesis: Cache< Key, Item, Manager, Divider > Class Template Reference

Pyrogenesis 13997

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

#include <cache_adt.h>

Public Member Functions
	Cache ()

void	add (const Key &key, const Item &item, size_t size, size_t cost)

void	remove (const Key &key)

bool	retrieve (const Key &key, Item &item, size_t *psize=0, bool refill_credit=true)

bool	peek (const Key &key, Item &item, size_t *psize=0)

bool	remove_least_valuable (Item pItem=0, size_t pSize=0)

bool	empty () const

Private Types
typedef CacheEntry< Item, Divider >	Entry

Private Attributes
std::list< Entry >	entries_awaiting_eviction

Manager< Key, Entry >	mgr

Detailed Description

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>
class Cache< Key, Item, Manager, Divider >

Definition at line 657 of file cache_adt.h.

Member Typedef Documentation

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

typedef CacheEntry<Item, Divider> Cache< Key, Item, Manager, Divider >::Entry

private

Definition at line 737 of file cache_adt.h.

Constructor & Destructor Documentation

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

Cache< Key, Item, Manager, Divider >::Cache ( )

inline

Definition at line 660 of file cache_adt.h.

Member Function Documentation

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

void Cache< Key, Item, Manager, Divider >::add	(	const Key &	key,
		const Item &	item,
		size_t	size,
		size_t	cost
	)

inline

Definition at line 662 of file cache_adt.h.

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

bool Cache< Key, Item, Manager, Divider >::empty ( ) const

inline

Definition at line 731 of file cache_adt.h.

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

bool Cache< Key, Item, Manager, Divider >::peek	(	const Key &	key,
		Item &	item,
		size_t *	psize = `0`
	)

inline

Definition at line 699 of file cache_adt.h.

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

void Cache< Key, Item, Manager, Divider >::remove ( const Key & key )

inline

Definition at line 671 of file cache_adt.h.

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

bool Cache< Key, Item, Manager, Divider >::remove_least_valuable	(	Item *	pItem = `0`,
		size_t *	pSize = `0`
	)

inline

Definition at line 706 of file cache_adt.h.

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

bool Cache< Key, Item, Manager, Divider >::retrieve	(	const Key &	key,
		Item &	item,
		size_t *	psize = `0`,
		bool	refill_credit = `true`
	)

inline

Definition at line 683 of file cache_adt.h.

Member Data Documentation

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

std::list<Entry> Cache< Key, Item, Manager, Divider >::entries_awaiting_eviction

private

Definition at line 740 of file cache_adt.h.

template<typename Key, typename Item, template< typename Key_, class Entry > class Manager = Landlord_Cached, class Divider = Divider_Naive>

Manager<Key, Entry> Cache< Key, Item, Manager, Divider >::mgr

private

Definition at line 742 of file cache_adt.h.

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

/home/sathyam/0ad.svn/source/lib/adts/cache_adt.h