guarded_iterator< RandomAccessIterator, Comparator > Class Template Reference

Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons. More...

#include <multiway_merge.hpp>

Public Types
using	self_type = guarded_iterator< RandomAccessIterator, Comparator >
	Our own type. More...
using	value_type = typename std::iterator_traits< RandomAccessIterator >::value_type
	Value type of the iterator. More...

Public Member Functions
	guarded_iterator (RandomAccessIterator begin, RandomAccessIterator end, Comparator &comp)
	Constructor. More...
self_type &	operator++ ()
	Pre-increment operator. More...
value_type &	operator* ()
	Dereference operator. More...
RandomAccessIterator &	iterator ()
	Convert to wrapped iterator. More...

Protected Attributes
RandomAccessIterator	current
	Current iterator position. More...
RandomAccessIterator	end_
	End iterator of the sequence. More...
Comparator &	comp_
	Comparator. More...

Friends
bool	operator< (self_type &bi1, self_type &bi2)
	Compare two elements referenced by guarded iterators. More...
bool	operator<= (self_type &bi1, self_type &bi2)
	Compare two elements referenced by guarded iterators. More...

Detailed Description

template<typename RandomAccessIterator, typename Comparator>
class tlx::multiway_merge_detail::guarded_iterator< RandomAccessIterator, Comparator >

Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons.

Deriving from RandomAccessIterator is not possible since RandomAccessIterator need not be a class.

Definition at line 54 of file multiway_merge.hpp.

Member Typedef Documentation

using self_type = guarded_iterator<RandomAccessIterator, Comparator>

Our own type.

Definition at line 58 of file multiway_merge.hpp.

using value_type = typename std::iterator_traits<RandomAccessIterator>::value_type

Value type of the iterator.

Definition at line 62 of file multiway_merge.hpp.

Constructor & Destructor Documentation

guarded_iterator ( RandomAccessIterator  begin, RandomAccessIterator  end, Comparator &  comp  )

inline

Constructor.

Sets iterator to beginning of sequence.

Parameters

begin	Begin iterator of sequence.
end	End iterator of sequence.
comp	Comparator provided for associated overloaded compare operators.

Definition at line 80 of file multiway_merge.hpp.

Member Function Documentation

RandomAccessIterator& iterator ( )

inline

Convert to wrapped iterator.

Returns

Wrapped iterator.

Definition at line 106 of file multiway_merge.hpp.

value_type& operator* ( )

inline

Dereference operator.

Returns

Referenced element.

Definition at line 98 of file multiway_merge.hpp.

self_type& operator++ ( )

inline

Pre-increment operator.

Returns

This.

Definition at line 89 of file multiway_merge.hpp.

Friends And Related Function Documentation

bool operator< ( self_type &  bi1, self_type &  bi2  )

friend

Compare two elements referenced by guarded iterators.

Parameters

bi1	First iterator.
bi2	Second iterator.

Returns

True if less.

Definition at line 116 of file multiway_merge.hpp.

bool operator<= ( self_type &  bi1, self_type &  bi2  )

friend

Compare two elements referenced by guarded iterators.

Parameters

bi1	First iterator.
bi2	Second iterator.

Returns

True if less equal.

Definition at line 130 of file multiway_merge.hpp.

Member Data Documentation

Comparator& comp_

protected

Comparator.

Definition at line 70 of file multiway_merge.hpp.

RandomAccessIterator current

protected

Current iterator position.

Definition at line 66 of file multiway_merge.hpp.

RandomAccessIterator end_

protected

End iterator of the sequence.

Definition at line 68 of file multiway_merge.hpp.

---

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

• tlx/algorithm/multiway_merge.hpp