• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>distance</title>
5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../index.html" title="Chapter 1. Fusion 2.2">
8<link rel="up" href="../metafunctions.html" title="Metafunctions">
9<link rel="prev" href="equal_to.html" title="equal_to">
10<link rel="next" href="advance.html" title="advance">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="equal_to.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../metafunctions.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="advance.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="fusion.iterator.metafunctions.distance"></a><a class="link" href="distance.html" title="distance">distance</a>
28</h4></div></div></div>
29<h6>
30<a name="fusion.iterator.metafunctions.distance.h0"></a>
31          <span class="phrase"><a name="fusion.iterator.metafunctions.distance.description"></a></span><a class="link" href="distance.html#fusion.iterator.metafunctions.distance.description">Description</a>
32        </h6>
33<p>
34          Returns the distance between two iterators.
35        </p>
36<h6>
37<a name="fusion.iterator.metafunctions.distance.h1"></a>
38          <span class="phrase"><a name="fusion.iterator.metafunctions.distance.synopsis"></a></span><a class="link" href="distance.html#fusion.iterator.metafunctions.distance.synopsis">Synopsis</a>
39        </h6>
40<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
41    <span class="keyword">typename</span> <span class="identifier">I</span><span class="special">,</span>
42    <span class="keyword">typename</span> <span class="identifier">J</span>
43    <span class="special">&gt;</span>
44<span class="keyword">struct</span> <span class="identifier">distance</span>
45<span class="special">{</span>
46    <span class="keyword">typedef</span> <span class="emphasis"><em>unspecified</em></span> <span class="identifier">type</span><span class="special">;</span>
47<span class="special">};</span>
48</pre>
49<div class="table">
50<a name="fusion.iterator.metafunctions.distance.t0"></a><p class="title"><b>Table 1.16. Parameters</b></p>
51<div class="table-contents"><table class="table" summary="Parameters">
52<colgroup>
53<col>
54<col>
55<col>
56</colgroup>
57<thead><tr>
58<th>
59                  <p>
60                    Parameter
61                  </p>
62                </th>
63<th>
64                  <p>
65                    Requirement
66                  </p>
67                </th>
68<th>
69                  <p>
70                    Description
71                  </p>
72                </th>
73</tr></thead>
74<tbody><tr>
75<td>
76                  <p>
77                    <code class="computeroutput"><span class="identifier">I</span></code>, <code class="computeroutput"><span class="identifier">J</span></code>
78                  </p>
79                </td>
80<td>
81                  <p>
82                    Models of <a class="link" href="../concepts/forward_iterator.html" title="Forward Iterator">Forward
83                    Iterator</a> into the same sequence
84                  </p>
85                </td>
86<td>
87                  <p>
88                    The start and end points of the distance to be measured
89                  </p>
90                </td>
91</tr></tbody>
92</table></div>
93</div>
94<br class="table-break"><h6>
95<a name="fusion.iterator.metafunctions.distance.h2"></a>
96          <span class="phrase"><a name="fusion.iterator.metafunctions.distance.expression_semantics"></a></span><a class="link" href="distance.html#fusion.iterator.metafunctions.distance.expression_semantics">Expression
97          Semantics</a>
98        </h6>
99<pre class="programlisting"><a class="link" href="distance.html" title="distance"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span> <span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span>
100</pre>
101<p>
102          <span class="bold"><strong>Return type</strong></span>: A model of <a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
103          Integral Constant</a>.
104        </p>
105<p>
106          <span class="bold"><strong>Semantics</strong></span>: Returns the distance between
107          iterators of types <code class="computeroutput"><span class="identifier">I</span></code> and
108          <code class="computeroutput"><span class="identifier">J</span></code>.
109        </p>
110<h6>
111<a name="fusion.iterator.metafunctions.distance.h3"></a>
112          <span class="phrase"><a name="fusion.iterator.metafunctions.distance.header"></a></span><a class="link" href="distance.html#fusion.iterator.metafunctions.distance.header">Header</a>
113        </h6>
114<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">iterator</span><span class="special">/</span><span class="identifier">distance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
115<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">distance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
116</pre>
117<h6>
118<a name="fusion.iterator.metafunctions.distance.h4"></a>
119          <span class="phrase"><a name="fusion.iterator.metafunctions.distance.example"></a></span><a class="link" href="distance.html#fusion.iterator.metafunctions.distance.example">Example</a>
120        </h6>
121<pre class="programlisting"><span class="keyword">typedef</span> <a class="link" href="../../container/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">double</span><span class="special">,</span><span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
122<span class="keyword">typedef</span> <a class="link" href="../../sequence/intrinsic/metafunctions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">vec</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">first</span><span class="special">;</span>
123<span class="keyword">typedef</span> <a class="link" href="next.html" title="next"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">next</span></code></a><span class="special">&lt;</span><span class="identifier">first</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">second</span><span class="special">;</span>
124<span class="keyword">typedef</span> <a class="link" href="next.html" title="next"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">next</span></code></a><span class="special">&lt;</span><span class="identifier">second</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">third</span><span class="special">;</span>
125<span class="keyword">typedef</span> <a class="link" href="distance.html" title="distance"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></code></a><span class="special">&lt;</span><span class="identifier">first</span><span class="special">,</span><span class="identifier">third</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">dist</span><span class="special">;</span>
126
127<span class="identifier">BOOST_MPL_ASSERT_RELATION</span><span class="special">(</span><span class="identifier">dist</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <span class="special">==,</span> <span class="number">2</span><span class="special">);</span>
128</pre>
129</div>
130<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
131<td align="left"></td>
132<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
133      Dan Marsden, Tobias Schwinger<p>
134        Distributed under the Boost Software License, Version 1.0. (See accompanying
135        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
136      </p>
137</div></td>
138</tr></table>
139<hr>
140<div class="spirit-nav">
141<a accesskey="p" href="equal_to.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../metafunctions.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="advance.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
142</div>
143</body>
144</html>
145