boost_mpl/doc/refmanual/iterator-category.html

<?xml version="1.0" encoding="utf-8" ?>
<!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" xml:lang="en" lang="en">
<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
<title>The MPL Reference Manual: iterator_category</title>
<link rel="stylesheet" href="../style.css" type="text/css" />
</head>
<body class="docframe refmanual">
<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./deref.html" class="navigation-link">Prev</a>&nbsp;<a href="./algorithms.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./deref.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterator-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./iterators.html" class="navigation-link">Iterators</a> / <a href="./iterator-metafunctions.html" class="navigation-link">Iterator Metafunctions</a> / <a href="./iterator-category.html" class="navigation-link">iterator_category</a></td>
</tr></table><div class="header-separator"></div>
<div class="section" id="iterator-category">
<h1><a class="toc-backref" href="./iterator-metafunctions.html#id387" name="iterator-category">iterator_category</a></h1>
<div class="section" id="iterator-iterator-synopsis">
<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
<pre class="literal-block">
template&lt;
      typename Iterator
    &gt;
struct <a href="./iterator-category.html" class="identifier">iterator_category</a>
{
    typedef typename Iterator::category type;
};
</pre>
</div>
<div class="section" id="iterator-iterator-description">
<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
<p>Returns one of the following iterator category tags:</p>
<ul class="simple">
<li><tt class="literal"><span class="pre">forward_iterator_tag</span></tt></li>
<li><tt class="literal"><span class="pre">bidirectional_iterator_tag</span></tt></li>
<li><tt class="literal"><span class="pre">random_access_iterator_tag</span></tt></li>
</ul>
</div>
<div class="section" id="iterator-iterator-header">
<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
<pre class="literal-block">
#include &lt;<a href="../../../../boost/mpl/iterator_category.hpp" class="header">boost/mpl/iterator_category.hpp</a>&gt;
#include &lt;<a href="../../../../boost/mpl/iterator_tags.hpp" class="header">boost/mpl/iterator_tags.hpp</a>&gt;
</pre>
</div>
<div class="section" id="iterator-iterator-parameters">
<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
<table border="1" class="table">
<colgroup>
<col width="19%" />
<col width="28%" />
<col width="53%" />
</colgroup>
<thead valign="bottom">
<tr><th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="literal"><span class="pre">Iterator</span></tt></td>
<td><a class="reference" href="./forward-iterator.html">Forward Iterator</a></td>
<td>The iterator to obtain a category for.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="iterator-iterator-expression-semantics">
<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
<p>For any <a class="reference" href="./forward-iterator.html">Forward Iterator</a>s <tt class="literal"><span class="pre">iter</span></tt>:</p>
<pre class="literal-block">
typedef <a href="./iterator-category.html" class="identifier">iterator_category</a>&lt;iter&gt;::type tag; 
</pre>
<table class="field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference" href="./integral-constant.html">Integral Constant</a>.</td>
</tr>
<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><tt class="literal"><span class="pre">tag</span></tt> is <tt class="literal"><span class="pre">forward_iterator_tag</span></tt> if <tt class="literal"><span class="pre">iter</span></tt> is a model of <a class="reference" href="./forward-iterator.html">Forward Iterator</a>, 
<tt class="literal"><span class="pre">bidirectional_iterator_tag</span></tt> if <tt class="literal"><span class="pre">iter</span></tt> is a model of <a class="reference" href="./bidirectional-iterator.html">Bidirectional Iterator</a>,
or <tt class="literal"><span class="pre">random_access_iterator_tag</span></tt> if <tt class="literal"><span class="pre">iter</span></tt> is a model of <a class="reference" href="./random-access-iterator.html">Random Access Iterator</a>;</td>
</tr>
<tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><dl class="first last">
<dt><tt class="literal"><span class="pre">forward_iterator_tag::value</span> <span class="pre">&lt;</span> <span class="pre">bidirectional_iterator_tag::value</span></tt>,</dt>
<dd><tt class="literal"><span class="pre">bidirectional_iterator_tag::value</span> <span class="pre">&lt;</span> <span class="pre">random_access_iterator_tag::value</span></tt>.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="iterator-complexity">
<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
<p>Amortized constant time.</p>
</div>
<div class="section" id="iterator-iterator-example">
<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
<pre class="literal-block">
template&lt; typename Tag, typename Iterator &gt;
struct algorithm_impl
{
    // <em>O(n)</em> implementation
};

template&lt; typename Iterator &gt;
struct algorithm_impl&lt;random_access_iterator_tag,Iterator&gt;
{
    // <em>O(1)</em> implementation
};

template&lt; typename Iterator &gt;
struct algorithm
    : algorithm_impl&lt;
          <a href="./iterator-category.html" class="identifier">iterator_category</a>&lt;Iterator&gt;::type
        , Iterator
        >
{
};
</pre>
</div>
<div class="section" id="iterator-iterator-see-also">
<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
<p><a class="reference" href="./iterators.html">Iterators</a>, <a class="refentry reference" href="./begin.html"><tt class="refentry literal"><span class="pre">begin</span></tt></a> / <a class="refentry reference" href="./end.html"><tt class="refentry literal"><span class="pre">end</span></tt></a>, <a class="refentry reference" href="./advance.html"><tt class="refentry literal"><span class="pre">advance</span></tt></a>, <a class="refentry reference" href="./distance.html"><tt class="refentry literal"><span class="pre">distance</span></tt></a>, <a class="refentry reference" href="./next.html"><tt class="refentry literal"><span class="pre">next</span></tt></a></p>
<!-- modtime: November 15, 2004 04:57:09 +0000 -->
</div>
</div>

<div class="footer-separator"></div>
<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./deref.html" class="navigation-link">Prev</a>&nbsp;<a href="./algorithms.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./deref.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterator-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
</tr></table></body>
</html>