std::ranges::copy, std::ranges::copy_if, std::ranges::copy_result, std::ranges::copy_if_result

< cpp‎ | algorithm‎ | ranges
 
C++
 
算法库
有制约算法及范围上的算法 (C++20)
有制约算法： std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
未初始化存储上的操作
划分操作
排序操作
(C++11)
(C++11)
二分搜索操作
集合操作（在已排序范围上）
堆操作
(C++11)
(C++11)
最小/最大操作
(C++11)
(C++11)
(C++17)

排列
数值运算
C 库
 
有制约算法
不修改序列的操作
修改序列的操作
未初始化存储上的操作
划分操作
排序操作
二分搜索操作
集合操作（在已排序范围上）
堆操作
最小/最大操作
排列
 
定义于头文件 <algorithm>
调用签名
template< std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O >

requires std::indirectly_copyable<I, O>

constexpr ranges::copy_result<I, O> copy( I first, S last, O result );
 (1) (C++20 起)
template< ranges::input_range R, std::weakly_incrementable O >

requires std::indirectly_copyable<ranges::iterator_t<R>, O>
  constexpr ranges::copy_result<ranges::borrowed_iterator_t<R>, O>

copy( R&& r, O result );
 (2) (C++20 起)
template< std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O,

          class Proj = std::identity,
          std::indirect_unary_predicate<std::projected<I, Proj>> Pred >
requires std::indirectly_copyable<I, O>
  constexpr ranges::copy_if_result<I, O>

copy_if( I first, S last, O result, Pred pred, Proj proj = {} );
 (3) (C++20 起)
template< ranges::input_range R, std::weakly_incrementable O,

          class Proj = std::identity,
          std::indirect_unary_predicate<std::projected<ranges::iterator_t<R>, Proj>> Pred >
requires std::indirectly_copyable<ranges::iterator_t<R>, O>
  constexpr ranges::copy_if_result<ranges::borrowed_iterator_t<R>, O>

copy_if( R&& r, O result, Pred pred, Proj proj = {} );
 (4) (C++20 起)
辅助类型
template < class I, class O >
using copy_result = ranges::in_out_result<I, O>;
 (5) (C++20 起)
template < class I, class O >
using copy_if_result = ranges::in_out_result<I, O>;
 (6) (C++20 起)

复制 [first, last) 所定义的范围中的元素到始于 result 的另一范围。

1) 复制始于 first 并持续到 last - 1 的范围 [first, last) 中的元素。若 result 在范围 [first, last) 内则行为未定义。此情况下，可用 ranges::copy_backward 代替。
3) 仅复制谓词 pred 对其返回 true 的元素。保持复制的元素顺序。若源与目标范围重叠则行为未定义。
2,4) 同 (1,3) ，但以 r 为源范围，如同以 ranges::begin(r) 为 first 并以 ranges::end(r) 为 last 。

此页面上描述的仿函数实体是 niebloid ，即：

实际上，它们能以函数对象，或以某些特殊编译器扩展实现。

参数

first, last - 要复制的元素范围
r - 要复制的元素范围
result - 目标范围的起始
pred - 应用到投影后元素的谓词
proj - 应用到元素的投影

返回值

含有等于 last 的输入迭代器和指向最后复制元素后一位置的输出迭代器的 ranges::in_out_result 。

复杂度

1-2) 准确赋值 (last - first) 次。
3-4) 准确应用 (last - first) 次谓词与投影，并赋值 ​0​ 到 (last - first) 之间次（对每个谓词返回 true 的元素赋值，取决于谓词与输入数据）。

注解

实践中， std::ranges::copy 的实现若值类型为可平凡复制 (TriviallyCopyable) 且迭代器类型满足 contiguous_iterator ，则避免多次赋值并使用如 std::memmove 的大块复制函数。

复制重叠的范围时， std::ranges::copy 在向左复制（目标范围的起始在源范围外）时适合，而 std::ranges::copy_backward 在向右复制（目标范围的末尾在源范围外）时适合。

可能的实现

版本一 
struct copy_fn {
  template< std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O >
  requires std::indirectly_copyable<I, O>
  constexpr ranges::copy_result<I, O> operator()( I first, S last, O result ) const
  {
      for (; first != last; ++first, (void)++result) {
          *result = *first;
      }
      return {std::move(first), std::move(result)};
  }
 
  template< ranges::input_range R, std::weakly_incrementable O >
  requires std::indirectly_copyable<ranges::iterator_t<R>, O>
  constexpr ranges::copy_result<ranges::borrowed_iterator_t<R>, O>
  operator()( R&& r, O result ) const
  {
      return (*this)(ranges::begin(r), ranges::end(r), std::move(result));
  }
};
 
inline constexpr copy_fn copy;
版本二 
struct copy_if_fn {
  template< std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O,
            class Proj = std::identity,
            std::indirect_unary_predicate<std::projected<I, Proj>> Pred >
  requires std::indirectly_copyable<I, O>
  constexpr ranges::copy_if_result<I, O>
  operator()( I first, S last, O result, Pred pred, Proj proj = {} ) const
  {
      for (; first != last; ++first) {
          if (std::invoke(pred, std::invoke(proj, *first))) {
              *result = *first;
              ++result;
          }
      }
 
      return {std::move(first), std::move(result)};
  }
 
  template< ranges::input_range R, std::weakly_incrementable O,
            class Proj = std::identity,
            std::indirect_unary_predicate<
                std::projected<ranges::iterator_t<R>, Proj>> Pred >
  requires std::indirectly_copyable<ranges::iterator_t<R>, O>
  constexpr ranges::copy_if_result<ranges::borrowed_iterator_t<R>, O>
  operator()( R&& r, O result, Pred pred, Proj proj = {} ) const
  {
      return (*this)(ranges::begin(r), ranges::end(r),
                     std::move(result),
                     std::ref(pred), std::ref(proj));
  }
};
 
inline constexpr copy_if_fn copy_if;

示例

下列代码用 copy 复制 vector 的内容到另一 vector 并显示结果 vector ：

运行此代码
#include <algorithm>
#include <iostream>
#include <vector>
#include <iterator>
#include <numeric>
 
int main()
{
    std::vector<int> from_vector(10);
    std::iota(from_vector.begin(), from_vector.end(), 0);
 
    std::vector<int> to_vector;
 
    namespace ranges = std::ranges;
    ranges::copy(from_vector.begin(), from_vector.end(),
                 std::back_inserter(to_vector));
// 或者另外使用
//  std::vector<int> to_vector(from_vector.size());
//  ranges::copy(from_vector.begin(), from_vector.end(), to_vector.begin());
// 都等价于
//  std::vector<int> to_vector = from_vector;
 
    std::cout << "to_vector contains: ";
 
    ranges::copy(to_vector, std::ostream_iterator<int>(std::cout, " "));
    std::cout << '\n';
 
    std::cout << "odd numbers in to_vector are: ";
 
    ranges::copy_if(to_vector, std::ostream_iterator<int>(std::cout, " "),
                 [](int x) { return (x % 2) == 1; });
    std::cout << '\n';
}

输出： 

to_vector contains: 0 1 2 3 4 5 6 7 8 9 
odd numbers in to_vector are: 1 3 5 7 9

参阅

(C++20)
 按从后往前的顺序复制一个范围内的元素
(niebloid)
(C++20)
 创建一个范围的逆向副本
(niebloid)
(C++20)
 将一定数目的元素复制到一个新的位置
(niebloid)
(C++20)
 将一个给定值复制赋值给一个范围内的每个元素
(niebloid)
(C++20)(C++20)
 复制一个范围的元素，忽略满足特定判别标准的元素
(niebloid)
(C++11)
 将某一范围的元素复制到一个新的位置
(函数模板)