<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libstdc++: __gnu_parallel::_GuardedIterator< _RAIter, _Compare > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libstdc++</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00124.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">__gnu_parallel::_GuardedIterator< _RAIter, _Compare > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="__gnu_parallel::_GuardedIterator" -->
<p>_Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons.
<a href="a00124.html#details">More...</a></p>
<p><a href="a01580.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="a00124.html#ae5f70394d5c15f471216c6483d846b1c">_GuardedIterator</a> (_RAIter __begin, _RAIter __end, _Compare &__comp)
<li><a class="el" href="a00124.html#aaa63e1e4c5f2ad032d7deac8dbd8d2d6">operator _RAIter</a> ()
<li>std::iterator_traits< _RAIter ><br class="typebreak"/>
::value_type & <a class="el" href="a00124.html#a89e62967a92648f52f3da16144bf9b75">operator*</a> ()
<li><a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, <br class="typebreak"/>
_Compare > & <a class="el" href="a00124.html#ab5ee82c060324ccc10d02831a5270a7c">operator++</a> ()
</ul>
<h2><a name="friends"></a>
Friends</h2>
<ul>
<li>bool <a class="el" href="a00124.html#a2bf5c5fcb9aba7fef572a48701d84f9d">operator<</a> (<a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > &__bi1, <a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > &__bi2)
<li>bool <a class="el" href="a00124.html#a406eb3652a303e46bd225a4046401bf4">operator<=</a> (<a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > &__bi1, <a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > &__bi2)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename _RAIter, typename _Compare><br/>
class __gnu_parallel::_GuardedIterator< _RAIter, _Compare ></h3>
<p>_Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons. </p>
<p>The implicit supremum comes with a performance cost.</p>
<p>Deriving from _RAIter is not possible since _RAIter need not be a class. </p>
<p>Definition at line <a class="el" href="a00953_source.html#l00066">66</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae5f70394d5c15f471216c6483d846b1c"></a><!-- doxytag: member="__gnu_parallel::_GuardedIterator::_GuardedIterator" ref="ae5f70394d5c15f471216c6483d846b1c" args="(_RAIter __begin, _RAIter __end, _Compare &__comp)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RAIter , typename _Compare > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00124.html">__gnu_parallel::_GuardedIterator</a>< _RAIter, _Compare >::<a class="el" href="a00124.html">_GuardedIterator</a> </td>
<td>(</td>
<td class="paramtype">_RAIter </td>
<td class="paramname"><em>__begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_RAIter </td>
<td class="paramname"><em>__end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_Compare & </td>
<td class="paramname"><em>__comp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. Sets iterator to beginning of sequence. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">__begin</td><td>Begin iterator of sequence. </td></tr>
<tr><td class="paramname">__end</td><td>End iterator of sequence. </td></tr>
<tr><td class="paramname">__comp</td><td>Comparator provided for associated overloaded compare operators. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00953_source.html#l00084">84</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaa63e1e4c5f2ad032d7deac8dbd8d2d6"></a><!-- doxytag: member="__gnu_parallel::_GuardedIterator::operator _RAIter" ref="aaa63e1e4c5f2ad032d7deac8dbd8d2d6" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RAIter , typename _Compare > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00124.html">__gnu_parallel::_GuardedIterator</a>< _RAIter, _Compare >::operator _RAIter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert to wrapped iterator. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Wrapped iterator. </dd></dl>
<p>Definition at line <a class="el" href="a00953_source.html#l00105">105</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div>
</div>
<a class="anchor" id="a89e62967a92648f52f3da16144bf9b75"></a><!-- doxytag: member="__gnu_parallel::_GuardedIterator::operator*" ref="a89e62967a92648f52f3da16144bf9b75" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RAIter , typename _Compare > </div>
<table class="memname">
<tr>
<td class="memname">std::iterator_traits<_RAIter>::value_type& <a class="el" href="a00124.html">__gnu_parallel::_GuardedIterator</a>< _RAIter, _Compare >::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dereference operator. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Referenced element. </dd></dl>
<p>Definition at line <a class="el" href="a00953_source.html#l00100">100</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab5ee82c060324ccc10d02831a5270a7c"></a><!-- doxytag: member="__gnu_parallel::_GuardedIterator::operator++" ref="ab5ee82c060324ccc10d02831a5270a7c" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RAIter , typename _Compare > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00124.html">_GuardedIterator</a><_RAIter, _Compare>& <a class="el" href="a00124.html">__gnu_parallel::_GuardedIterator</a>< _RAIter, _Compare >::operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pre-increment operator. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>This. </dd></dl>
<p>Definition at line <a class="el" href="a00953_source.html#l00091">91</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a2bf5c5fcb9aba7fef572a48701d84f9d"></a><!-- doxytag: member="__gnu_parallel::_GuardedIterator::operator<" ref="a2bf5c5fcb9aba7fef572a48701d84f9d" args="(_GuardedIterator< _RAIter, _Compare > &__bi1, _GuardedIterator< _RAIter, _Compare > &__bi2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RAIter , typename _Compare > </div>
<table class="memname">
<tr>
<td class="memname">bool operator< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > & </td>
<td class="paramname"><em>__bi1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > & </td>
<td class="paramname"><em>__bi2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare two elements referenced by guarded iterators. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">__bi1</td><td>First iterator. </td></tr>
<tr><td class="paramname">__bi2</td><td>Second iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if less. </dd></dl>
<p>Definition at line <a class="el" href="a00953_source.html#l00113">113</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div>
</div>
<a class="anchor" id="a406eb3652a303e46bd225a4046401bf4"></a><!-- doxytag: member="__gnu_parallel::_GuardedIterator::operator<=" ref="a406eb3652a303e46bd225a4046401bf4" args="(_GuardedIterator< _RAIter, _Compare > &__bi1, _GuardedIterator< _RAIter, _Compare > &__bi2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RAIter , typename _Compare > </div>
<table class="memname">
<tr>
<td class="memname">bool operator<= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > & </td>
<td class="paramname"><em>__bi1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00124.html">_GuardedIterator</a>< _RAIter, _Compare > & </td>
<td class="paramname"><em>__bi2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare two elements referenced by guarded iterators. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">__bi1</td><td>First iterator. </td></tr>
<tr><td class="paramname">__bi2</td><td>Second iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if less equal. </dd></dl>
<p>Definition at line <a class="el" href="a00953_source.html#l00128">128</a> of file <a class="el" href="a00953_source.html">multiway_merge.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00953_source.html">multiway_merge.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a01131.html">__gnu_parallel</a> </li>
<li class="navelem"><a class="el" href="a00124.html">_GuardedIterator</a> </li>
<li class="footer">Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
</body>
</html>
