• 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="../functions.html" title="Functions">
9<link rel="prev" href="prior.html" title="prior">
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="prior.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.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.functions.distance"></a><a class="link" href="distance.html" title="distance">distance</a>
28</h4></div></div></div>
29<h6>
30<a name="fusion.iterator.functions.distance.h0"></a>
31          <span class="phrase"><a name="fusion.iterator.functions.distance.description"></a></span><a class="link" href="distance.html#fusion.iterator.functions.distance.description">Description</a>
32        </h6>
33<p>
34          Returns the distance between 2 iterators.
35        </p>
36<h6>
37<a name="fusion.iterator.functions.distance.h1"></a>
38          <span class="phrase"><a name="fusion.iterator.functions.distance.synopsis"></a></span><a class="link" href="distance.html#fusion.iterator.functions.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">typename</span> <a class="link" href="../metafunctions/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> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">J</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">j</span><span class="special">);</span>
45</pre>
46<div class="table">
47<a name="fusion.iterator.functions.distance.t0"></a><p class="title"><b>Table 1.4. Parameters</b></p>
48<div class="table-contents"><table class="table" summary="Parameters">
49<colgroup>
50<col>
51<col>
52<col>
53</colgroup>
54<thead><tr>
55<th>
56                  <p>
57                    Parameter
58                  </p>
59                </th>
60<th>
61                  <p>
62                    Requirement
63                  </p>
64                </th>
65<th>
66                  <p>
67                    Description
68                  </p>
69                </th>
70</tr></thead>
71<tbody><tr>
72<td>
73                  <p>
74                    <code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
75                  </p>
76                </td>
77<td>
78                  <p>
79                    Models of <a class="link" href="../concepts/forward_iterator.html" title="Forward Iterator">Forward
80                    Iterator</a> into the same sequence
81                  </p>
82                </td>
83<td>
84                  <p>
85                    The start and end points of the distance to be measured
86                  </p>
87                </td>
88</tr></tbody>
89</table></div>
90</div>
91<br class="table-break"><h6>
92<a name="fusion.iterator.functions.distance.h2"></a>
93          <span class="phrase"><a name="fusion.iterator.functions.distance.expression_semantics"></a></span><a class="link" href="distance.html#fusion.iterator.functions.distance.expression_semantics">Expression
94          Semantics</a>
95        </h6>
96<pre class="programlisting"><a class="link" href="distance.html" title="distance"><code class="computeroutput"><span class="identifier">distance</span></code></a><span class="special">(</span><span class="identifier">i</span><span class="special">,</span><span class="identifier">j</span><span class="special">);</span>
97</pre>
98<p>
99          <span class="bold"><strong>Return type</strong></span>: <code class="computeroutput"><span class="keyword">int</span></code>
100        </p>
101<p>
102          <span class="bold"><strong>Semantics</strong></span>: Returns the distance between
103          iterators <code class="computeroutput"><span class="identifier">i</span></code> and <code class="computeroutput"><span class="identifier">j</span></code>.
104        </p>
105<h6>
106<a name="fusion.iterator.functions.distance.h3"></a>
107          <span class="phrase"><a name="fusion.iterator.functions.distance.header"></a></span><a class="link" href="distance.html#fusion.iterator.functions.distance.header">Header</a>
108        </h6>
109<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>
110<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>
111</pre>
112<h6>
113<a name="fusion.iterator.functions.distance.h4"></a>
114          <span class="phrase"><a name="fusion.iterator.functions.distance.example"></a></span><a class="link" href="distance.html#fusion.iterator.functions.distance.example">Example</a>
115        </h6>
116<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">int</span><span class="special">,</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
117
118<span class="identifier">vec</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">);</span>
119<span class="identifier">assert</span><span class="special">(</span><a class="link" href="distance.html" title="distance"><code class="computeroutput"><span class="identifier">distance</span></code></a><span class="special">(</span><a class="link" href="../../sequence/intrinsic/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">),</span> <a class="link" href="next.html" title="next"><code class="computeroutput"><span class="identifier">next</span></code></a><span class="special">(</span><a class="link" href="next.html" title="next"><code class="computeroutput"><span class="identifier">next</span></code></a><span class="special">(</span><a class="link" href="../../sequence/intrinsic/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">))))</span> <span class="special">==</span> <span class="number">2</span><span class="special">);</span>
120</pre>
121</div>
122<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
123<td align="left"></td>
124<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
125      Dan Marsden, Tobias Schwinger<p>
126        Distributed under the Boost Software License, Version 1.0. (See accompanying
127        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>)
128      </p>
129</div></td>
130</tr></table>
131<hr>
132<div class="spirit-nav">
133<a accesskey="p" href="prior.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.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>
134</div>
135</body>
136</html>
137