• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2    Copyright 2010 Neil Groves
3    Distributed under the Boost Software License, Version 1.0.
4    (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
5/]
6[section:copy_backward copy_backward]
7
8[heading Prototype]
9
10``
11template<class BidirectionalRange, class BidirectionalOutputIterator>
12    BidirectionalOutputIterator
13        copy_backward(const BidirectionalRange& source_rng,
14                      BidirectionalOutputIterator out_it);
15``
16
17[heading Description]
18
19`copy_backward` copies all elements from `source_rng` to the range `[out_it - distance(source_rng), out_it)`.
20
21The values are copied in reverse order. The return value is `out_it - distance(source_rng)`.
22
23Note well that unlike all other standard algorithms `out_it` denotes the *end* of the output sequence.
24
25[heading Definition]
26
27Defined in the header file `boost/range/algorithm/copy_backward.hpp`
28
29[heading Requirements]
30
31* `BidirectionalRange` is a model of __bidirectional_range__ Concept.
32* `OutputIterator` is a model of the `OutputIteratorConcept`.
33* The `value_type` of __bidirectional_range__ Concept is convertible to a type in `OutputIterator`'s set of value types.
34
35[heading Precondition:]
36
37* `out_it` is not an iterator within the `source_rng`.
38* `[out_it, out_it + distance(source_rng))` is a valid range.
39
40[heading Complexity]
41
42Linear. Exactly `distance(source_rng)` assignments are performed.
43
44[endsect]
45
46
47