Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc > Class Template Reference

Specialization for node elements. More...

#include <ogdf/basic/PriorityQueue.h>

+ Inheritance diagram for ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc >:

Public Member Functions

 PrioritizedMapQueue (const Graph &G, const C &cmp=C(), int initialSize=-1)
 Creates a new queue with the given comparer. More...
 
void clear ()
 Removes all elements from this queue. More...
 
- Public Member Functions inherited from ogdf::pq_internal::PrioritizedArrayQueueBase< node, P, C, Impl, NodeArray< PrioritizedQueue< node, P, C, Impl >::Handle > >
void clear ()
 Removes all elements from this queue. More...
 
bool contains (const node &element) const
 Returns whether this queue contains that key. More...
 
void decrease (const node &element, const P &priority)
 Decreases the priority of the given element. More...
 
void pop ()
 Removes the topmost element from the queue. More...
 
const P & priority (const node &element) const
 
void push (const node &element, const P &priority)
 Adds a new element to the queue. More...
 
- Public Member Functions inherited from ogdf::pq_internal::PrioritizedQueue< node, P, C, Impl >
 PrioritizedQueue (const C &cmp=C(), int initialSize=128)
 
void decrease (Handle pos, const P &priority)
 
Handle push (const node &element, const P &priority)
 Pushes a new element with the respective priority to the queue. More...
 
const nodetopElement () const
 Returns the topmost element in the queue. More...
 
const P & topPriority () const
 Returns the priority of the topmost element in this queue. More...
 
- Public Member Functions inherited from ogdf::PriorityQueue< T, C, Impl >
 PriorityQueue (const C &cmp=C(), int initialSize=128)
 Creates empty priority queue. More...
 
 PriorityQueue (const PriorityQueue &other)
 Copy constructor. More...
 
template<class InputIt >
 PriorityQueue (InputIt first, InputIt last, const C &cmp=C())
 Creates priority queue with contents of the given range. More...
 
 PriorityQueue (PriorityQueue &&other)
 Move constructor. More...
 
 PriorityQueue (std::initializer_list< value_type > init, const C &cmp=C())
 Creates priority queue with contents of the given initializer list. More...
 
 ~PriorityQueue ()
 Destroys the underlying data structure. More...
 
void clear ()
 Removes all the entries from the queue. More...
 
void decrease (handle pos, const T &value)
 Decreases value of the element specified by handle to value. More...
 
bool empty () const
 Checks whether the queue is empty. More...
 
void merge (PriorityQueue &other)
 Merges in enqueued values of other queue. More...
 
PriorityQueueoperator= (PriorityQueue other)
 Copy and move assignment. More...
 
PriorityQueueoperator= (std::initializer_list< value_type > ilist)
 Assigns the priority queue contents of the given initializer list. More...
 
void pop ()
 Removes the top element from the heap. More...
 
handle push (const value_type &value)
 Inserts a new element with given value into the queue. More...
 
template<class InputIt >
void push (InputIt first, InputIt last)
 Inserts new elements specified by the given range. More...
 
void push (std::initializer_list< value_type > ilist)
 Inserts new elements specified by the given initializer list. More...
 
size_type size () const
 Returns the number of enqueued elements. More...
 
void swap (PriorityQueue &other)
 Swaps the contents. More...
 
const T & top () const
 Returns reference to the top element in the queue. More...
 
const T & value (handle pos) const
 Returns the priority of that handle. More...
 

Private Types

using Handle = typename PrioritizedQueue< node, P, C, Impl >::Handle
 
using SuperQueue = pq_internal::PrioritizedArrayQueueBase< node, P, C, Impl, NodeArray< Handle > >
 

Additional Inherited Members

- Public Types inherited from ogdf::pq_internal::PrioritizedQueue< node, P, C, Impl >
using Handle = typename SuperQueue::handle
 The type of handle for accessing the elements of this queue. More...
 
- Public Types inherited from ogdf::PriorityQueue< T, C, Impl >
using const_reference = const value_type &
 
using handle = typename SpecImpl::Handle
 
using reference = value_type &
 
using size_type = std::size_t
 
using value_type = T
 
- Protected Types inherited from ogdf::pq_internal::PrioritizedArrayQueueBase< node, P, C, Impl, NodeArray< PrioritizedQueue< node, P, C, Impl >::Handle > >
using Handle = typename PrioritizedQueue< node, P, C, Impl >::Handle
 
using SuperQueue = PrioritizedQueue< node, P, C, Impl >
 
- Protected Member Functions inherited from ogdf::pq_internal::PrioritizedArrayQueueBase< node, P, C, Impl, NodeArray< PrioritizedQueue< node, P, C, Impl >::Handle > >
 PrioritizedArrayQueueBase (const C &cmp, int initialSize, const NodeArray< PrioritizedQueue< node, P, C, Impl >::Handle > &map)
 
- Protected Attributes inherited from ogdf::pq_internal::PrioritizedArrayQueueBase< node, P, C, Impl, NodeArray< PrioritizedQueue< node, P, C, Impl >::Handle > >
NodeArray< PrioritizedQueue< node, P, C, Impl >::Handlem_handles
 

Detailed Description

template<typename P, class C, template< typename, class > class Impl, template< typename > class HashFunc>
class ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc >

Specialization for node elements.

Definition at line 525 of file PriorityQueue.h.

Member Typedef Documentation

◆ Handle

template<typename P , class C , template< typename, class > class Impl, template< typename > class HashFunc>
using ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc >::Handle = typename PrioritizedQueue<node, P, C, Impl>::Handle
private

Definition at line 528 of file PriorityQueue.h.

◆ SuperQueue

template<typename P , class C , template< typename, class > class Impl, template< typename > class HashFunc>
using ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc >::SuperQueue = pq_internal::PrioritizedArrayQueueBase<node, P, C, Impl, NodeArray<Handle> >
private

Definition at line 529 of file PriorityQueue.h.

Constructor & Destructor Documentation

◆ PrioritizedMapQueue()

template<typename P , class C , template< typename, class > class Impl, template< typename > class HashFunc>
ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc >::PrioritizedMapQueue ( const Graph G,
const C &  cmp = C(),
int  initialSize = -1 
)
inline

Creates a new queue with the given comparer.

Parameters
GThe graph containing the nodes that will be inserted.
cmpThe comparer to be used.
initialSizeThe initial capacity preference (ignored if not supported by underlying heap). Defaults to the initial number of nodes in the given Graph.

Definition at line 541 of file PriorityQueue.h.

Member Function Documentation

◆ clear()

template<typename P , class C , template< typename, class > class Impl, template< typename > class HashFunc>
void ogdf::PrioritizedMapQueue< node, P, C, Impl, HashFunc >::clear ( )
inline

Removes all elements from this queue.

Definition at line 547 of file PriorityQueue.h.


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