mCRL2
Loading...
Searching...
No Matches
mcrl2::utilities::replacement_policy< Map > Class Template Referenceabstract

An interface to implement a replacement policy for the fixed_size_cache. More...

#include <cache_policy.h>

Inheritance diagram for mcrl2::utilities::replacement_policy< Map >:
mcrl2::utilities::fifo_policy< Map > mcrl2::utilities::no_policy< Map >

Public Types

using key_type = typename Map::key_type
 
using map_type = Map
 

Protected Member Functions

virtual void clear ()=0
 Called whenever the underlying cache is cleared.
 
virtual void inserted (const key_type &key)=0
 Called whenever a new element has been inserted into the cache.
 
virtual Map::iterator replacement_candidate (Map &map)=0
 
virtual void touch (const key_type &key)=0
 Called whenever an element was found in the cache.
 

Detailed Description

template<typename Map>
class mcrl2::utilities::replacement_policy< Map >

An interface to implement a replacement policy for the fixed_size_cache.

Definition at line 24 of file cache_policy.h.

Member Typedef Documentation

◆ key_type

template<typename Map >
using mcrl2::utilities::replacement_policy< Map >::key_type = typename Map::key_type

Definition at line 27 of file cache_policy.h.

◆ map_type

template<typename Map >
using mcrl2::utilities::replacement_policy< Map >::map_type = Map

Definition at line 28 of file cache_policy.h.

Member Function Documentation

◆ clear()

template<typename Map >
virtual void mcrl2::utilities::replacement_policy< Map >::clear ( )
protectedpure virtual

Called whenever the underlying cache is cleared.

Implemented in mcrl2::utilities::no_policy< Map >, and mcrl2::utilities::fifo_policy< Map >.

◆ inserted()

template<typename Map >
virtual void mcrl2::utilities::replacement_policy< Map >::inserted ( const key_type key)
protectedpure virtual

Called whenever a new element has been inserted into the cache.

Implemented in mcrl2::utilities::no_policy< Map >, and mcrl2::utilities::fifo_policy< Map >.

◆ replacement_candidate()

template<typename Map >
virtual Map::iterator mcrl2::utilities::replacement_policy< Map >::replacement_candidate ( Map &  map)
protectedpure virtual
Returns
An iterator to the key that should be replaced when the cache is full.

Implemented in mcrl2::utilities::no_policy< Map >, and mcrl2::utilities::fifo_policy< Map >.

◆ touch()

template<typename Map >
virtual void mcrl2::utilities::replacement_policy< Map >::touch ( const key_type key)
protectedpure virtual

Called whenever an element was found in the cache.

Implemented in mcrl2::utilities::no_policy< Map >, and mcrl2::utilities::fifo_policy< Map >.


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