Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/deref.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 7.0 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: deref</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./prior.html" class="navigation-link">Prev</a>&nbsp;<a href="./iterator-category.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./prior.html" class="navigation-link">Back</a>&nbsp;<a href="./iterator-category.html" class="navigation-link">Along</a></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>
15<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="./deref.html" class="navigation-link">deref</a></td>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="deref">
18<h1><a class="toc-backref" href="./iterator-metafunctions.html#id386" name="deref">deref</a></h1>
19<div class="section" id="deref-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt;
23      typename Iterator
24    &gt;
25struct <a href="./deref.html" class="identifier">deref</a>
26{
27    typedef <em>unspecified</em> type;
28};
29</pre>
30</div>
31<div class="section" id="deref-description">
32<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
33<p>Dereferences an iterator.</p>
34</div>
35<div class="section" id="deref-header">
36<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
37<pre class="literal-block">
38#include &lt;<a href="../../../../boost/mpl/deref.hpp" class="header">boost/mpl/deref.hpp</a>&gt;
39</pre>
40</div>
41<div class="section" id="deref-parameters">
42<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
43<table border="1" class="table">
44<colgroup>
45<col width="19%" />
46<col width="35%" />
47<col width="45%" />
48</colgroup>
49<thead valign="bottom">
50<tr><th>Parameter</th>
51<th>Requirement</th>
52<th>Description</th>
53</tr>
54</thead>
55<tbody valign="top">
56<tr><td><tt class="literal"><span class="pre">Iterator</span></tt></td>
57<td><a class="reference" href="./forward-iterator.html">Forward Iterator</a></td>
58<td>The iterator to dereference.</td>
59</tr>
60</tbody>
61</table>
62</div>
63<div class="section" id="deref-expression-semantics">
64<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
65<p>For any <a class="reference" href="./forward-iterator.html">Forward Iterator</a>s <tt class="literal"><span class="pre">iter</span></tt>:</p>
66<pre class="literal-block">
67typedef <a href="./deref.html" class="identifier">deref</a>&lt;iter&gt;::type t;
68</pre>
69<table class="field-list" frame="void" rules="none">
70<col class="field-name" />
71<col class="field-body" />
72<tbody valign="top">
73<tr class="field"><th class="field-name">Return type:</th><td class="field-body">A type.</td>
74</tr>
75<tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><tt class="literal"><span class="pre">iter</span></tt> is dereferenceable.</td>
76</tr>
77<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">t</span></tt> is identical to the element referenced by <tt class="literal"><span class="pre">iter</span></tt>. If <tt class="literal"><span class="pre">iter</span></tt> is
78a user-defined iterator, the library-provided default implementation is
79equivalent to</p>
80<pre class="last literal-block">
81typedef iter::type t;
82</pre>
83</td>
84</tr>
85</tbody>
86</table>
87</div>
88<div class="section" id="deref-complexity">
89<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
90<p>Amortized constant time.</p>
91</div>
92<div class="section" id="deref-example">
93<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
94<pre class="literal-block">
95typedef <a href="./vector.html" class="identifier">vector</a>&lt;char,short,int,long&gt; types;
96typedef <a href="./begin.html" class="identifier">begin</a>&lt;types&gt;::type iter;
97
98<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./deref.html" class="identifier">deref</a>&lt;iter&gt;::type, char > ));
99</pre>
100</div>
101<div class="section" id="deref-see-also">
102<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
103<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="./next.html"><tt class="refentry literal"><span class="pre">next</span></tt></a></p>
104<!-- modtime: November 11, 2004 11:17:11 +0000 -->
105<!-- Iterators/Iterator Metafunctions//iterator_category |60 -->
106</div>
107</div>
108
109<div class="footer-separator"></div>
110<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./prior.html" class="navigation-link">Prev</a>&nbsp;<a href="./iterator-category.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./prior.html" class="navigation-link">Back</a>&nbsp;<a href="./iterator-category.html" class="navigation-link">Along</a></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>
111</tr></table></body>
112</html>
Note: See TracBrowser for help on using the repository browser.