Namespaces
Variants
Views
Actions

std::ranges::copy_n, std::ranges::copy_n_result

From cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. std::ranges::copy, std::ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
(C++11)(C++11)(C++11)
(C++17)
Modifying sequence operations
Partitioning operations
Sorting operations
(C++11)
Binary search operations
Set operations (on sorted ranges)
Heap operations
(C++11)
Minimum/maximum operations
(C++11)
(C++17)

Permutations
Numeric operations
Operations on uninitialized storage
(C++17)
(C++17)
(C++17)
C library
 
Constrained algorithms
Non-modifying sequence operations
Modifying sequence operations
Partitioning operations
Sorting operations
Binary search operations
Set operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Permutations
Operations on uninitialized storage
Return types
 
Defined in header <algorithm>
Call signature
template< std::input_iterator I, std::weakly_incrementable O >

  requires std::indirectly_copyable<I, O>
  constexpr copy_n_result<I, O>

            copy_n( I first, std::iter_difference_t<I> n, O result );
(1) (since C++20)
Helper type
template< class I, class O >
  using copy_n_result = ranges::in_out_result<I, O>;
(2) (since C++20)
1) Copies exactly n values from the range beginning at first to the range beginning at result by performing *(result + i) = *(first + i) for each integer in [0, n). The behavior is undefined if result is within the range [first, first + n) (ranges::copy_backward might be used instead in this case).

The function-like entities described on this page are niebloids, that is:

In practice, they may be implemented as function objects, or with special compiler extensions.

Contents

[edit] Parameters

first - the beginning of the range of elements to copy from
n - number of the elements to copy
result - the beginning of the destination range

[edit] Return value

ranges::copy_n_result{first + n, result + n} or more formally, a value of type ranges::in_out_result that contains an std::input_iterator iterator equals to ranges::next(first, n) and a std::weakly_incrementable iterator equals to ranges::next(result, n).

[edit] Complexity

Exactly n assignments.

[edit] Notes

In practice, implementations of std::ranges::copy_n may avoid multiple assignments and use bulk copy functions such as std::memmove if the value type is TriviallyCopyable and the iterator types satisfy contiguous_iterator. Alternativelly, such copy acceleration can be injected during an optimization phase of a compiler.

When copying overlapping ranges, std::ranges::copy_n is appropriate when copying to the left (beginning of the destination range is outside the source range) while std::ranges::copy_backward is appropriate when copying to the right (end of the destination range is outside the source range).

[edit] Possible implementation

struct copy_n_fn {
  template<std::input_iterator I, std::weakly_incrementable O>
    requires std::indirectly_copyable<I, O>
    constexpr ranges::copy_n_result<I, O>
    operator()(I first, std::iter_difference_t<I> n, O result) const {
        for (std::iter_difference_t<I> i{}; i != n; ++i, ++first, ++result)
            *result = *first;
        return {std::move(first), std::move(result)};
    }
};
 
inline constexpr copy_n_fn copy_n{};

[edit] Example

#include <algorithm>
#include <iterator>
#include <iostream>
#include <iomanip>
#include <string>
#include <string_view>
 
int main()
{
    const std::string_view in {"ABCDEFGH"};
    std::string out;
 
    std::ranges::copy_n(in.begin(), 4, std::back_inserter(out));
    std::cout << std::quoted(out) << '\n';
 
    out = "abcdefgh";
    const auto res = std::ranges::copy_n(in.begin(), 5, out.begin());
    std::cout
        << "*(res.in): '" << *(res.in) << "', distance: "
        << std::distance(std::begin(in), res.in) << '\n'
        << "*(res.out): '" << *(res.out) << "', distance: "
        << std::distance(std::begin(out), res.out) << '\n';
}

Output:

"ABCD"
*(res.in): 'F', distance: 5
*(res.out): 'f', distance: 5

[edit] See also

copies a range of elements to a new location
(niebloid) [edit]
copies a range of elements in backwards order
(niebloid) [edit]
copies a range of elements omitting those that satisfy specific criteria
(niebloid) [edit]
copies a range, replacing elements satisfying specific criteria with another value
(niebloid) [edit]
creates a copy of a range that is reversed
(niebloid) [edit]
copies and rotate a range of elements
(niebloid) [edit]
creates a copy of some range of elements that contains no consecutive duplicates
(niebloid) [edit]
moves a range of elements to a new location
(niebloid) [edit]
moves a range of elements to a new location in backwards order
(niebloid) [edit]
(C++11)
copies a number of elements to a new location
(function template) [edit]