addressable_priority_queue< KeyType, PriorityType, Cmp > Class Template Reference

Detailed Description

template<typename KeyType, typename PriorityType, class Cmp = std::less<PriorityType>>
class foxxll::addressable_priority_queue< KeyType, PriorityType, Cmp >

An internal priority queue that allows removing elements addressed with (a copy of) themselves.

Template Parameters

KeyType	Type of contained elements.
PriorityType	Type of Priority.

Definition at line 113 of file addressable_queues.hpp.

Inheritance diagram for addressable_priority_queue< KeyType, PriorityType, Cmp >:

#include <addressable_queues.hpp>

Classes
struct	cmp

Public Types
using	handle = meta_iterator
	Type of handle to an entry. For use with insert and remove. More...

Public Member Functions
	addressable_priority_queue ()
	Create an empty queue. More...
	~addressable_priority_queue ()
bool	empty () const
bool	erase (const KeyType &e)
void	erase (handle i)
std::pair< handle, bool >	insert (const KeyType &e, const PriorityType o)
KeyType	pop ()
const KeyType &	top () const

Private Types
using	container_iterator = typename container_type::iterator
using	container_type = std::set< std::pair< PriorityType, KeyType >, cmp >
using	meta_iterator = typename meta_type::iterator
using	meta_type = std::map< KeyType, container_iterator >

Private Attributes
meta_type	meta
container_type	vals

Member Typedef Documentation

container_iterator

using container_iterator = typename container_type::iterator

private

Definition at line 127 of file addressable_queues.hpp.

container_type

using container_type = std::set<std::pair<PriorityType, KeyType>, cmp>

private

Definition at line 126 of file addressable_queues.hpp.

handle

using handle = meta_iterator

Type of handle to an entry. For use with insert and remove.

Definition at line 136 of file addressable_queues.hpp.

meta_iterator

using meta_iterator = typename meta_type::iterator

private

Definition at line 129 of file addressable_queues.hpp.

meta_type

using meta_type = std::map<KeyType, container_iterator>

private

Definition at line 128 of file addressable_queues.hpp.

Constructor & Destructor Documentation

addressable_priority_queue()

addressable_priority_queue ( )

inline

Create an empty queue.

Definition at line 139 of file addressable_queues.hpp.

~addressable_priority_queue()

~addressable_priority_queue ( )

inline

Definition at line 140 of file addressable_queues.hpp.

Member Function Documentation

empty()

bool empty ( ) const

inline

Check if queue is empty.

Returns

If queue is empty.

Definition at line 144 of file addressable_queues.hpp.

Referenced by block_scheduler_algorithm_offline_lfd< SwappableBlockType >::evictable_blocks_empty(), block_scheduler_algorithm_offline_lfd< SwappableBlockType >::get_free_internal_block(), and block_scheduler_algorithm_offline_lfd< SwappableBlockType >::~block_scheduler_algorithm_offline_lfd().

erase() [1/2]

bool erase ( const KeyType &  e )

inline

Erase element from the queue.

Parameters

e	Element to remove.

Returns

If element was in.

Definition at line 167 of file addressable_queues.hpp.

Referenced by block_scheduler_algorithm_offline_lfd< SwappableBlockType >::acquire(), block_scheduler_algorithm_offline_lfd< SwappableBlockType >::deinitialize(), and block_scheduler_algorithm_offline_lfd< SwappableBlockType >::extract_external_block().

erase() [2/2]

void erase ( handle  i )

inline

Erase element from the queue.

Parameters

i	Iterator to element to remove.

Definition at line 179 of file addressable_queues.hpp.

insert()

std::pair<handle, bool> insert ( const KeyType &  e, const PriorityType  o  )

inline

Insert new element. If the element is already in, it's priority is updated.

Parameters

e	Element to insert.
o	Priority of element.

Returns

pair<handle, bool> Iterator to element; if element was newly inserted.

Definition at line 151 of file addressable_queues.hpp.

Referenced by block_scheduler_algorithm_offline_lfd< SwappableBlockType >::init(), and block_scheduler_algorithm_offline_lfd< SwappableBlockType >::release().

pop()

KeyType pop ( )

inline

Remove top (= min) element from the queue.

Returns

Top element.

Definition at line 192 of file addressable_queues.hpp.

Referenced by block_scheduler_algorithm_offline_lfd< SwappableBlockType >::evictable_blocks_pop(), block_scheduler_algorithm_offline_lfd< SwappableBlockType >::get_free_internal_block(), and block_scheduler_algorithm_offline_lfd< SwappableBlockType >::~block_scheduler_algorithm_offline_lfd().

top()

const KeyType& top ( ) const

inline

Access top (= min) element in the queue.

Returns

Const reference to top element.

Definition at line 187 of file addressable_queues.hpp.

Member Data Documentation

meta

meta_type meta

private

Definition at line 132 of file addressable_queues.hpp.

vals

container_type vals

private

Definition at line 131 of file addressable_queues.hpp.

---

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

• extlib/foxxll/foxxll/common/addressable_queues.hpp