gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp > Class Template Reference

Sorted priority queue reverse iterator. More...

#include <agrum/base/core/sortedPriorityQueue.h>

Inherits SharedAVLTreeIterator< Val, SortedPriorityQueue< Val, int, std::less< Val > >::TreeCmp >.

Collaboration diagram for gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >:

Public Types
using	iterator_category = std::bidirectional_iterator_tag
	Types for STL compliance.
using	value_type = Val
	Types for STL compliance.
using	reference = value_type&
	Types for STL compliance.
using	const_reference = const value_type&
	Types for STL compliance.
using	pointer = value_type*
	Types for STL compliance.
using	const_pointer = const value_type*
	Types for STL compliance.
using	TreeCmp = typename SortedPriorityQueue< Val, Priority, Cmp >::TreeCmp
	Types for STL compliance.

Public Member Functions
Constructors / Destructors
	SortedPriorityQueueReverseIterator (const SortedPriorityQueue< Val, Priority, Cmp > &queue, const bool rbegin=true) noexcept
	constructor for rbegin iterators
	SortedPriorityQueueReverseIterator (const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &from) noexcept
	copy constructor
	SortedPriorityQueueReverseIterator (SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &&from) noexcept
	move constructor
	~SortedPriorityQueueReverseIterator () noexcept
	destructor
Operators
SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &	operator= (const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &from) noexcept
	copy operator
SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &	operator= (SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &&from) noexcept
	move operator
bool	operator== (const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &from) const
	indicates whether two iterator point to the same element
bool	operator!= (const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &from) const
	indicates whether two iterator point to different element
SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &	operator++ () noexcept
	move to the next element in the queue
SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &	operator+= (const Size k) noexcept
	move to the next k element
SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &	operator-- () noexcept
	move to the preceding element in the queue
SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &	operator-= (const Size k) noexcept
	move to the preceding k element
const_reference	operator* () const
	returns the value pointed to by the iterator
const_pointer	operator-> () const
	returns a pointer on the value pointed to by the iterator
Accessors / Modifiers
const_reference	value () const
	alias for operator*
const Priority &	priority () const
	returns the priority of the element pointed to by the iterator

Protected Types
using	TreeIterator = SharedAVLTreeIterator< Val, typename SortedPriorityQueue< Val, Priority, Cmp >::TreeCmp >

Protected Attributes
friend	SortedPriorityQueue< Val, Priority, Cmp >
	allow sorted priority queues to access the content of the iterators

Detailed Description

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>
class gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >

Sorted priority queue reverse iterator.

Template Parameters

Val	The type of the elements stored into the queue.
Priority	The type of the priorities assigned to the elements.
Cmp	The function used for sorting the priorities.

Definition at line 883 of file sortedPriorityQueue.h.

Member Typedef Documentation

const_pointer

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::const_pointer = const value_type*

Types for STL compliance.

Definition at line 895 of file sortedPriorityQueue.h.

const_reference

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::const_reference = const value_type&

Types for STL compliance.

Definition at line 893 of file sortedPriorityQueue.h.

iterator_category

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::iterator_category = std::bidirectional_iterator_tag

Types for STL compliance.

Definition at line 890 of file sortedPriorityQueue.h.

pointer

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::pointer = value_type*

Types for STL compliance.

Definition at line 894 of file sortedPriorityQueue.h.

reference

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::reference = value_type&

Types for STL compliance.

Definition at line 892 of file sortedPriorityQueue.h.

TreeCmp

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::TreeCmp = typename SortedPriorityQueue< Val, Priority, Cmp >::TreeCmp

Types for STL compliance.

Definition at line 896 of file sortedPriorityQueue.h.

TreeIterator

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::TreeIterator = SharedAVLTreeIterator< Val, typename SortedPriorityQueue< Val, Priority, Cmp >::TreeCmp >

protected

Definition at line 1006 of file sortedPriorityQueue.h.

value_type

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

using gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::value_type = Val

Types for STL compliance.

Definition at line 891 of file sortedPriorityQueue.h.

Constructor & Destructor Documentation

SortedPriorityQueueReverseIterator() [1/3]

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::SortedPriorityQueueReverseIterator ( const SortedPriorityQueue< Val, Priority, Cmp > & queue, const bool rbegin = true )

explicitnoexcept

constructor for rbegin iterators

Parameters

queue	the sorted priority queue which parses the iterator
begin	if true, the iterator points to the lowest value in the queue, else it points to the highest value

SortedPriorityQueueReverseIterator() [2/3]

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::SortedPriorityQueueReverseIterator ( const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & from )

noexcept

copy constructor

SortedPriorityQueueReverseIterator() [3/3]

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::SortedPriorityQueueReverseIterator ( SortedPriorityQueueReverseIterator< Val, Priority, Cmp > && from )

noexcept

move constructor

~SortedPriorityQueueReverseIterator()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::~SortedPriorityQueueReverseIterator ( )

noexcept

destructor

Member Function Documentation

operator!=()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

bool gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator!=

(

const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &

from

)

const

indicates whether two iterator point to different element

operator*()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

const_reference gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator*

(

)

const

returns the value pointed to by the iterator

Returns

the value pointed to by the iterator, if the iterator actually points to an element

Exceptions

NotFound

is raised if the iterator points to nothing

operator++()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator++ ( )

noexcept

move to the next element in the queue

Warning

Applying this operator to an iterator equal to the rend iterator has no effect. In particular, it does not raise any exception.

operator+=()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator+= ( const Size k )

noexcept

move to the next k element

Warning

Applying this operator to an iterator equal to the rend iterator has no effect. In particular, it does not raise any exception.

operator--()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator-- ( )

noexcept

move to the preceding element in the queue

Warning

Applying this operator to an iterator equal to the rbegin iterator has no effect. In particular, it does not raise any exception.

operator-=()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator-= ( const Size k )

noexcept

move to the preceding k element

Warning

Applying this operator to an iterator equal to the rbegin iterator has no effect. In particular, it does not raise any exception.

operator->()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

const_pointer gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator->

(

)

const

returns a pointer on the value pointed to by the iterator

operator=() [1/2]

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator= ( const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & from )

noexcept

copy operator

operator=() [2/2]

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

SortedPriorityQueueReverseIterator< Val, Priority, Cmp > & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator= ( SortedPriorityQueueReverseIterator< Val, Priority, Cmp > && from )

noexcept

move operator

operator==()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

bool gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::operator==

(

const SortedPriorityQueueReverseIterator< Val, Priority, Cmp > &

from

)

const

indicates whether two iterator point to the same element

priority()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

const Priority & gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::priority ( ) const

nodiscard

returns the priority of the element pointed to by the iterator

Exceptions

NotFound

is raised if the iterator points to nothing

value()

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

const_reference gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::value ( ) const

nodiscard

alias for operator*

Exceptions

NotFound

is raised if the iterator points to nothing

Member Data Documentation

SortedPriorityQueue< Val, Priority, Cmp >

template<typename Val, typename Priority = int, typename Cmp = std::less< Val >>

friend gum::SortedPriorityQueueReverseIterator< Val, Priority, Cmp >::SortedPriorityQueue< Val, Priority, Cmp >

protected

allow sorted priority queues to access the content of the iterators

Definition at line 1004 of file sortedPriorityQueue.h.

---

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

• agrum/base/core/sortedPriorityQueue.h