mirror of
https://github.com/boostorg/fusion.git
synced 2025-07-19 23:32:17 +02:00
117 lines
8.1 KiB
HTML
117 lines
8.1 KiB
HTML
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
<title>distance</title>
|
||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
|
||
<link rel="start" href="../../../index.html" title="Chapter 1. Fusion 2.0">
|
||
<link rel="up" href="../functions.html" title="Functions">
|
||
<link rel="prev" href="prior.html" title="prior">
|
||
<link rel="next" href="advance.html" title="advance">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table cellpadding="2" width="100%">
|
||
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
|
||
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
|
||
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
|
||
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
|
||
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
|
||
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
|
||
</table>
|
||
<hr>
|
||
<div class="spirit-nav">
|
||
<a accesskey="p" href="prior.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="advance.html"><img src="../../../images/next.png" alt="Next"></a>
|
||
</div>
|
||
<div class="section" lang="en">
|
||
<div class="titlepage"><div><div><h4 class="title">
|
||
<a name="fusion.iterators.functions.distance"></a><a href="distance.html" title="distance">distance</a></h4></div></div></div>
|
||
<a name="fusion.iterators.functions.distance.description"></a><h5>
|
||
<a name="id463589"></a>
|
||
<a href="distance.html#fusion.iterators.functions.distance.description">Description</a>
|
||
</h5>
|
||
<p>
|
||
Returns the distance between 2 iterators.
|
||
</p>
|
||
<a name="fusion.iterators.functions.distance.synopsis"></a><h5>
|
||
<a name="id463618"></a>
|
||
<a href="distance.html#fusion.iterators.functions.distance.synopsis">Synopsis</a>
|
||
</h5>
|
||
<pre class="programlisting">
|
||
<span class="keyword">template</span><span class="special"><</span>
|
||
<span class="keyword">typename</span> <span class="identifier">I</span><span class="special">,</span>
|
||
<span class="keyword">typename</span> <span class="identifier">J</span>
|
||
<span class="special">></span>
|
||
<span class="keyword">typename</span> <a href="../metafunctions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></tt></a><span class="special"><</span><span class="identifier">I</span><span class="special">,</span> <span class="identifier">J</span><span class="special">>::</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">&</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">J</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">j</span><span class="special">);</span>
|
||
</pre>
|
||
<div class="informaltable">
|
||
<h4>
|
||
<a name="id463823"></a>
|
||
<span class="table-title">Parameters</span>
|
||
</h4>
|
||
<table class="table">
|
||
<colgroup>
|
||
<col>
|
||
<col>
|
||
<col>
|
||
</colgroup>
|
||
<thead><tr>
|
||
<th>Parameter</th>
|
||
<th>Requirement</th>
|
||
<th>Description</th>
|
||
</tr></thead>
|
||
<tbody><tr>
|
||
<td>
|
||
<tt class="computeroutput"><span class="identifier">i</span></tt>, <tt class="computeroutput"><span class="identifier">j</span></tt>
|
||
</td>
|
||
<td>Models of <a href="../concepts/forward_iterator.html" title="Forward
|
||
Iterator">Forward Iterator</a>
|
||
into the same sequence</td>
|
||
<td>The start and end points of
|
||
the distance to be measured</td>
|
||
</tr></tbody>
|
||
</table>
|
||
</div>
|
||
<a name="fusion.iterators.functions.distance.expression_semantics"></a><h5>
|
||
<a name="id463911"></a>
|
||
<a href="distance.html#fusion.iterators.functions.distance.expression_semantics">Expression
|
||
Semantics</a>
|
||
</h5>
|
||
<pre class="programlisting">
|
||
<a href="distance.html" title="distance"><tt class="computeroutput"><span class="identifier">distance</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">,</span><span class="identifier">j</span><span class="special">);</span>
|
||
</pre>
|
||
<p>
|
||
<span class="bold"><b>Return type</b></span>: <tt class="computeroutput"><span class="keyword">int</span></tt>
|
||
</p>
|
||
<p>
|
||
<span class="bold"><b>Semantics</b></span>: Returns the distance between
|
||
iterators <tt class="computeroutput"><span class="identifier">i</span></tt> and <tt class="computeroutput"><span class="identifier">j</span></tt>.
|
||
</p>
|
||
<a name="fusion.iterators.functions.distance.header"></a><h5>
|
||
<a name="id464036"></a>
|
||
<a href="distance.html#fusion.iterators.functions.distance.header">Header</a>
|
||
</h5>
|
||
<pre class="programlisting">
|
||
<span class="preprocessor">#include</span> <span class="special"><</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">></span>
|
||
</pre>
|
||
<a name="fusion.iterators.functions.distance.example"></a><h5>
|
||
<a name="id464130"></a>
|
||
<a href="distance.html#fusion.iterators.functions.distance.example">Example</a>
|
||
</h5>
|
||
<pre class="programlisting">
|
||
<span class="keyword">typedef</span> <a href="../../sequences/containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special"><</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">></span> <span class="identifier">vec</span><span class="special">;</span>
|
||
|
||
<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>
|
||
<span class="identifier">assert</span><span class="special">(</span><a href="distance.html" title="distance"><tt class="computeroutput"><span class="identifier">distance</span></tt></a><span class="special">(</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">),</span> <a href="next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></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>
|
||
</pre>
|
||
</div>
|
||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||
<td align="left"></td>
|
||
<td align="right"><small>Copyright © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
|
||
</tr></table>
|
||
<hr>
|
||
<div class="spirit-nav">
|
||
<a accesskey="p" href="prior.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="advance.html"><img src="../../../images/next.png" alt="Next"></a>
|
||
</div>
|
||
</body>
|
||
</html>
|