• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>swap</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="at_key.html" title="at_key">
10<link rel="next" href="../metafunctions.html" title="Metafunctions">
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="at_key.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="../metafunctions.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="fusion.sequence.intrinsic.functions.swap"></a><a class="link" href="swap.html" title="swap">swap</a>
28</h5></div></div></div>
29<h6>
30<a name="fusion.sequence.intrinsic.functions.swap.h0"></a>
31            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.swap.description"></a></span><a class="link" href="swap.html#fusion.sequence.intrinsic.functions.swap.description">Description</a>
32          </h6>
33<p>
34            Performs an element by element swap of the elements in 2 sequences.
35          </p>
36<h6>
37<a name="fusion.sequence.intrinsic.functions.swap.h1"></a>
38            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.swap.synopsis"></a></span><a class="link" href="swap.html#fusion.sequence.intrinsic.functions.swap.synopsis">Synopsis</a>
39          </h6>
40<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Seq1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Seq2</span><span class="special">&gt;</span>
41<span class="keyword">typename</span> <a class="link" href="../metafunctions/swap.html" title="swap"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">swap</span></code></a><span class="special">&lt;</span><span class="identifier">Seq1</span><span class="special">,</span> <span class="identifier">Seq2</span><span class="special">&gt;::</span><span class="identifier">type</span>
42<span class="identifier">swap</span><span class="special">(</span><span class="identifier">Seq1</span><span class="special">&amp;</span> <span class="identifier">seq1</span><span class="special">,</span> <span class="identifier">Seq2</span><span class="special">&amp;</span> <span class="identifier">seq2</span><span class="special">);</span>
43</pre>
44<h6>
45<a name="fusion.sequence.intrinsic.functions.swap.h2"></a>
46            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.swap.parameters"></a></span><a class="link" href="swap.html#fusion.sequence.intrinsic.functions.swap.parameters">Parameters</a>
47          </h6>
48<div class="informaltable"><table class="table">
49<colgroup>
50<col>
51<col>
52<col>
53</colgroup>
54<thead><tr>
55<th>
56                    <p>
57                      Parameters
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">seq1</span></code>, <code class="computeroutput"><span class="identifier">seq2</span></code>
75                    </p>
76                  </td>
77<td>
78                    <p>
79                      Models of <a class="link" href="../../concepts/forward_sequence.html" title="Forward Sequence">Forward
80                      Sequence</a>
81                    </p>
82                  </td>
83<td>
84                    <p>
85                      The sequences whose elements we wish to swap.
86                    </p>
87                  </td>
88</tr></tbody>
89</table></div>
90<h6>
91<a name="fusion.sequence.intrinsic.functions.swap.h3"></a>
92            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.swap.expression_semantics"></a></span><a class="link" href="swap.html#fusion.sequence.intrinsic.functions.swap.expression_semantics">Expression
93            Semantics</a>
94          </h6>
95<pre class="programlisting"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">seq1</span><span class="special">,</span> <span class="identifier">seq2</span><span class="special">);</span>
96</pre>
97<p>
98            <span class="bold"><strong>Return type</strong></span>: <code class="computeroutput"><span class="keyword">void</span></code>
99          </p>
100<p>
101            <span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><a class="link" href="size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">seq1</span><span class="special">)</span> <span class="special">==</span> <a class="link" href="size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">seq2</span><span class="special">)</span></code>
102          </p>
103<p>
104            <span class="bold"><strong>Semantics</strong></span>: Calls <code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">a1</span><span class="special">,</span> <span class="identifier">b1</span><span class="special">)</span></code> for corresponding elements in <code class="computeroutput"><span class="identifier">seq1</span></code> and <code class="computeroutput"><span class="identifier">seq2</span></code>.
105          </p>
106<h6>
107<a name="fusion.sequence.intrinsic.functions.swap.h4"></a>
108            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.swap.header"></a></span><a class="link" href="swap.html#fusion.sequence.intrinsic.functions.swap.header">Header</a>
109          </h6>
110<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">swap</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
111<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">swap</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
112</pre>
113<h6>
114<a name="fusion.sequence.intrinsic.functions.swap.h5"></a>
115            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.swap.example"></a></span><a class="link" href="swap.html#fusion.sequence.intrinsic.functions.swap.example">Example</a>
116          </h6>
117<pre class="programlisting"><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="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;</span> <span class="identifier">v1</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="string">"hello"</span><span class="special">),</span> <span class="identifier">v2</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="string">"world"</span><span class="special">);</span>
118<span class="identifier">swap</span><span class="special">(</span><span class="identifier">v1</span><span class="special">,</span> <span class="identifier">v2</span><span class="special">);</span>
119<span class="identifier">assert</span><span class="special">(</span><span class="identifier">v1</span> <span class="special">==</span> <a class="link" href="../../../container/generation/functions/make_vector.html" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="string">"world"</span><span class="special">));</span>
120<span class="identifier">assert</span><span class="special">(</span><span class="identifier">v2</span> <span class="special">==</span> <a class="link" href="../../../container/generation/functions/make_vector.html" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="string">"hello"</span><span class="special">));</span>
121</pre>
122</div>
123<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
124<td align="left"></td>
125<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
126      Dan Marsden, Tobias Schwinger<p>
127        Distributed under the Boost Software License, Version 1.0. (See accompanying
128        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>)
129      </p>
130</div></td>
131</tr></table>
132<hr>
133<div class="spirit-nav">
134<a accesskey="p" href="at_key.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="../metafunctions.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
135</div>
136</body>
137</html>
138