libs/fusion/doc/html/fusion/algorithm/auxiliary/functions/copy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>copy</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.2">
   8 <link rel="up" href="../functions.html" title="Functions">
   9 <link rel="prev" href="../functions.html" title="Functions">
  10 <link rel="next" href="../../iteration.html" title="Iteration">
  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="../functions.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="../../iteration.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.algorithm.auxiliary.functions.copy"></a><a class="link" href="copy.html" title="copy">copy</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="fusion.algorithm.auxiliary.functions.copy.h0"></a>
  31             <span class="phrase"><a name="fusion.algorithm.auxiliary.functions.copy.description"></a></span><a class="link" href="copy.html#fusion.algorithm.auxiliary.functions.copy.description">Description</a>
  32           </h6>
  33 <p>
  34             Copy a sequence <code class="computeroutput"><span class="identifier">src</span></code> to
  35             a sequence <code class="computeroutput"><span class="identifier">dest</span></code>. It is
  36             also used to convert sequence into other.
  37           </p>
  38 <h6>
  39 <a name="fusion.algorithm.auxiliary.functions.copy.h1"></a>
  40             <span class="phrase"><a name="fusion.algorithm.auxiliary.functions.copy.synopsis"></a></span><a class="link" href="copy.html#fusion.algorithm.auxiliary.functions.copy.synopsis">Synopsis</a>
  41           </h6>
  42 <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>
  43 <span class="keyword">void</span> <span class="identifier">copy</span><span class="special">(</span><span class="identifier">Seq1</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">,</span> <span class="identifier">Seq2</span><span class="special">&amp;</span> <span class="identifier">dest</span><span class="special">);</span>
  44 </pre>
  45 <div class="table">
  46 <a name="fusion.algorithm.auxiliary.functions.copy.t0"></a><p class="title"><b>Table&#160;1.37.&#160;Parameters</b></p>
  47 <div class="table-contents"><table class="table" summary="Parameters">
  48 <colgroup>
  49 <col>
  50 <col>
  51 <col>
  52 </colgroup>
  53 <thead><tr>
  54 <th>
  55                     <p>
  56                       Parameter
  57                     </p>
  58                   </th>
  59 <th>
  60                     <p>
  61                       Requirement
  62                     </p>
  63                   </th>
  64 <th>
  65                     <p>
  66                       Description
  67                     </p>
  68                   </th>
  69 </tr></thead>
  70 <tbody>
  71 <tr>
  72 <td>
  73                     <p>
  74                       <code class="computeroutput"><span class="identifier">src</span></code>
  75                     </p>
  76                   </td>
  77 <td>
  78                     <p>
  79                       A model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
  80                       Sequence</a>, all elements contained in the <code class="computeroutput"><span class="identifier">src</span></code> sequence should be convertible
  81                       into the element contained in the <code class="computeroutput"><span class="identifier">dest</span></code>
  82                       sequence.
  83                     </p>
  84                   </td>
  85 <td>
  86                     <p>
  87                       Operation's argument
  88                     </p>
  89                   </td>
  90 </tr>
  91 <tr>
  92 <td>
  93                     <p>
  94                       <code class="computeroutput"><span class="identifier">dest</span></code>
  95                     </p>
  96                   </td>
  97 <td>
  98                     <p>
  99                       A model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
 100                       Sequence</a>, <code class="computeroutput"><span class="identifier">e2</span>
 101                       <span class="special">=</span> <span class="identifier">e1</span></code>
 102                       is valid expression for each pair of elements <code class="computeroutput"><span class="identifier">e1</span></code> of <code class="computeroutput"><span class="identifier">src</span></code>
 103                       and <code class="computeroutput"><span class="identifier">e2</span></code> of
 104                       <code class="computeroutput"><span class="identifier">dest</span></code>.
 105                     </p>
 106                   </td>
 107 <td>
 108                     <p>
 109                       Operation's argument
 110                     </p>
 111                   </td>
 112 </tr>
 113 </tbody>
 114 </table></div>
 115 </div>
 116 <br class="table-break"><h6>
 117 <a name="fusion.algorithm.auxiliary.functions.copy.h2"></a>
 118             <span class="phrase"><a name="fusion.algorithm.auxiliary.functions.copy.expression_semantics"></a></span><a class="link" href="copy.html#fusion.algorithm.auxiliary.functions.copy.expression_semantics">Expression
 119             Semantics</a>
 120           </h6>
 121 <pre class="programlisting"><a class="link" href="copy.html" title="copy"><code class="computeroutput"><span class="identifier">copy</span></code></a><span class="special">(</span><span class="identifier">src</span><span class="special">,</span> <span class="identifier">dest</span><span class="special">);</span>
 122 </pre>
 123 <p>
 124             <span class="bold"><strong>Return type</strong></span>: <code class="computeroutput"><span class="keyword">void</span></code>
 125           </p>
 126 <p>
 127             <span class="bold"><strong>Semantics</strong></span>: <code class="computeroutput"><span class="identifier">e2</span>
 128             <span class="special">=</span> <span class="identifier">e1</span></code>
 129             for each element <code class="computeroutput"><span class="identifier">e1</span></code> in
 130             <code class="computeroutput"><span class="identifier">src</span></code> and <code class="computeroutput"><span class="identifier">e2</span></code> in <code class="computeroutput"><span class="identifier">dest</span></code>.
 131           </p>
 132 <h6>
 133 <a name="fusion.algorithm.auxiliary.functions.copy.h3"></a>
 134             <span class="phrase"><a name="fusion.algorithm.auxiliary.functions.copy.complexity"></a></span><a class="link" href="copy.html#fusion.algorithm.auxiliary.functions.copy.complexity">Complexity</a>
 135           </h6>
 136 <p>
 137             Linear, exactly <code class="computeroutput"><a class="link" href="../../../sequence/intrinsic/metafunctions/size.html" title="size"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">size</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">value</span></code>.
 138           </p>
 139 <h6>
 140 <a name="fusion.algorithm.auxiliary.functions.copy.h4"></a>
 141             <span class="phrase"><a name="fusion.algorithm.auxiliary.functions.copy.header"></a></span><a class="link" href="copy.html#fusion.algorithm.auxiliary.functions.copy.header">Header</a>
 142           </h6>
 143 <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">algorithm</span><span class="special">/</span><span class="identifier">auxiliary</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 144 <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">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 145 </pre>
 146 <h6>
 147 <a name="fusion.algorithm.auxiliary.functions.copy.h5"></a>
 148             <span class="phrase"><a name="fusion.algorithm.auxiliary.functions.copy.example"></a></span><a class="link" href="copy.html#fusion.algorithm.auxiliary.functions.copy.example">Example</a>
 149           </h6>
 150 <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="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">);</span>
 151 <a class="link" href="../../../container/list.html" title="list"><code class="computeroutput"><span class="identifier">list</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">&gt;</span> <span class="identifier">ls</span><span class="special">;</span>
 152 <a class="link" href="copy.html" title="copy"><code class="computeroutput"><span class="identifier">copy</span></code></a><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">ls</span><span class="special">);</span>
 153 <span class="identifier">assert</span><span class="special">(</span><span class="identifier">ls</span> <span class="special">==</span> <a class="link" href="../../../container/generation/functions/make_list.html" title="make_list"><code class="computeroutput"><span class="identifier">make_list</span></code></a><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">));</span>
 154 </pre>
 155 </div>
 156 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 157 <td align="left"></td>
 158 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2006, 2011, 2012 Joel de Guzman,
 159       Dan Marsden, Tobias Schwinger<p>
 160         Distributed under the Boost Software License, Version 1.0. (See accompanying
 161         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>)
 162       </p>
 163 </div></td>
 164 </tr></table>
 165 <hr>
 166 <div class="spirit-nav">
 167 <a accesskey="p" href="../functions.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="../../iteration.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 168 </div>
 169 </body>
 170 </html>