• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
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.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0">
8<link rel="up" href="../mutating.html" title="Mutating algorithms">
9<link rel="prev" href="../mutating.html" title="Mutating algorithms">
10<link rel="next" href="copy_backward.html" title="copy_backward">
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="../mutating.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="copy_backward.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="range.reference.algorithms.mutating.copy"></a><a class="link" href="copy.html" title="copy">copy</a>
28</h5></div></div></div>
29<h6>
30<a name="range.reference.algorithms.mutating.copy.h0"></a>
31            <span class="phrase"><a name="range.reference.algorithms.mutating.copy.prototype"></a></span><a class="link" href="copy.html#range.reference.algorithms.mutating.copy.prototype">Prototype</a>
32          </h6>
33<p>
34</p>
35<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
36<span class="identifier">OutputIterator</span> <span class="identifier">copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&amp;</span> <span class="identifier">source_rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">);</span>
37</pre>
38<p>
39          </p>
40<h6>
41<a name="range.reference.algorithms.mutating.copy.h1"></a>
42            <span class="phrase"><a name="range.reference.algorithms.mutating.copy.description"></a></span><a class="link" href="copy.html#range.reference.algorithms.mutating.copy.description">Description</a>
43          </h6>
44<p>
45            <code class="computeroutput"><span class="identifier">copy</span></code> copies all elements
46            from <code class="computeroutput"><span class="identifier">source_rng</span></code> to the
47            range <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span><span class="special">,</span> <span class="identifier">out_it</span>
48            <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">))</span></code>. The return value is <code class="computeroutput"><span class="identifier">out_it</span> <span class="special">+</span>
49            <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code>
50          </p>
51<h6>
52<a name="range.reference.algorithms.mutating.copy.h2"></a>
53            <span class="phrase"><a name="range.reference.algorithms.mutating.copy.definition"></a></span><a class="link" href="copy.html#range.reference.algorithms.mutating.copy.definition">Definition</a>
54          </h6>
55<p>
56            Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span></code>
57          </p>
58<h6>
59<a name="range.reference.algorithms.mutating.copy.h3"></a>
60            <span class="phrase"><a name="range.reference.algorithms.mutating.copy.requirements"></a></span><a class="link" href="copy.html#range.reference.algorithms.mutating.copy.requirements">Requirements</a>
61          </h6>
62<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
63<li class="listitem">
64                <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is
65                a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
66                Pass Range</a> Concept.
67              </li>
68<li class="listitem">
69                <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is
70                a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>.
71              </li>
72<li class="listitem">
73                The <code class="computeroutput"><span class="identifier">value_type</span></code> of
74                <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a>
75                Concept is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s
76                set of value types.
77              </li>
78</ul></div>
79<h6>
80<a name="range.reference.algorithms.mutating.copy.h4"></a>
81            <span class="phrase"><a name="range.reference.algorithms.mutating.copy.precondition_"></a></span><a class="link" href="copy.html#range.reference.algorithms.mutating.copy.precondition_">Precondition:</a>
82          </h6>
83<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
84<li class="listitem">
85                <code class="computeroutput"><span class="identifier">out_it</span></code> is not an
86                iterator within the <code class="computeroutput"><span class="identifier">source_rng</span></code>.
87              </li>
88<li class="listitem">
89                <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span><span class="special">,</span> <span class="identifier">out_it</span>
90                <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">))</span></code> is a valid range.
91              </li>
92</ul></div>
93<h6>
94<a name="range.reference.algorithms.mutating.copy.h5"></a>
95            <span class="phrase"><a name="range.reference.algorithms.mutating.copy.complexity"></a></span><a class="link" href="copy.html#range.reference.algorithms.mutating.copy.complexity">Complexity</a>
96          </h6>
97<p>
98            Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code> assignments are performed.
99          </p>
100</div>
101<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
102<td align="left"></td>
103<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen,
104      Neil Groves<p>
105        Distributed under the Boost Software License, Version 1.0. (See accompanying
106        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>)
107      </p>
108</div></td>
109</tr></table>
110<hr>
111<div class="spirit-nav">
112<a accesskey="p" href="../mutating.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="copy_backward.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
113</div>
114</body>
115</html>
116