Spec-Zone.ru › C++

std::copy, std::copy_if

Defined in header <algorithm>
template< class InputIt, class OutputIt >
OutputIt copy( InputIt first, InputIt last, OutputIt d_first );
(1) (constexpr since C++20)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >
ForwardIt2 copy( ExecutionPolicy&& policy,
                 ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first );
(2) (since C++17)
template< class InputIt, class OutputIt, class UnaryPredicate >
OutputIt copy_if( InputIt first, InputIt last, OutputIt d_first,
                  UnaryPredicate pred );
(3) (since C++11)
(constexpr since C++20)
template< class ExecutionPolicy,
          class ForwardIt1, class ForwardIt2, class UnaryPredicate >
ForwardIt2 copy_if( ExecutionPolicy&& policy,
                    ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first,
                    UnaryPredicate pred );
(4) (since C++17)

Копирует элементы из диапазона, определённого [first, last), в другой диапазон, начинающийся с d_first (диапазон назначения).

1) Копирует все элементы из диапазона [first, last) начиная с first и продолжая до last.
Если d_first находится в [first, last), поведение неопределённо. В этом случае, можно использовать std::copy_backward.
2) Копирует элементы, но выполняется согласно policy. Эта перегрузка не участвует в разрешении перегрузки, если

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> является true.

(до C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> является true.

(с C++20)
Если [first, last) и диапазон назначения перекрывается, поведение неопределённо.
3) Копирует только те элементы, для которых предикат pred возвращает true. Этот алгоритм копирования стабилен: относительный порядок копируемых элементов сохраняется.
Если [first, last) и диапазон назначения перекрывается, поведение неопределённо.
4) То же, что (3), но выполняется согласно policy. Эта перегрузка не участвует в разрешении перегрузки, если

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> является true.

(до C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> является true.

(с C++20)

Параметры

first, last - диапазон копируемых элементов
d_first - начало диапазона назначения
policy - используемая политика выполнения. Подробнее см. политику выполнения.
pred - унарный предикат, который возвращает ​true для требуемых элементов.

Выражение pred(v) должно быть приводимо к bool для каждого аргумента v типа (возможно const) VT, где VT — тип значения InputIt, независимо от категории значения, и не должен изменять v. Таким образом, тип параметра VT& не допускается, а также VT за исключением случаев, когда для VT перемещение эквивалентно копированию(с C++11). ​

Требования к типу
-InputIt должен соответствовать требованиям LegacyInputIterator.
-OutputIt должен соответствовать требованиям LegacyOutputIterator.
-ForwardIt1, ForwardIt2 должен соответствовать требованиям LegacyForwardIterator.
-UnaryPredicate должен соответствовать требованиям Predicate.

Возвращаемое значение

Итератор выходного значения в диапазоне назначения, указывающий на элемент после последнего скопированного элемента.

Сложность

Дано \(\scriptsize N\)N как std::distance(first, last):

1,2) Ровно \(\scriptsize N\)N присваиваний.
3,4) Ровно \(\scriptsize N\)N применений предиката pred, и максимум NN присваиваний.

Для перегрузок с ExecutionPolicy, может быть затрачена производительность, если тип значения ForwardIt1 не является MoveConstructible.

Исключения

Перегрузки с параметром шаблона ExecutionPolicy сообщают об ошибках следующим образом:

  • Если выполнение функции, вызванной как часть алгоритма, вызывает исключение, и ExecutionPolicy является одной из стандартных политик, то std::terminate вызывается. Для любой другой ExecutionPolicy, поведение определяется реализацией.
  • Если алгоритм не может выделить память, выбрасывается std::bad_alloc.

Примечания

На практике реализации std::copy избегают многократных присваиваний и используют функции объёмной копирования, такие как std::memmove , если тип значения является TriviallyCopyable и типы итераторов удовлетворяют LegacyContiguousIterator.

При копировании перекрывающихся диапазонов, std::copy подходит для копирования влево (начало диапазона назначения находится вне диапазона исходного), в то время как std::copy_backward подходит для копирования вправо (конец диапазона назначения находится вне диапазона исходного).

Возможная реализация

copy (1)
template<class InputIt, class OutputIt>
OutputIt copy(InputIt first, InputIt last,
              OutputIt d_first)
{
    for (; first != last; (void)++first, (void)++d_first)
        *d_first = *first;
 
    return d_first;
}
copy_if (3)
template<class InputIt, class OutputIt, class UnaryPredicate>
OutputIt copy_if(InputIt first, InputIt last,
                 OutputIt d_first, UnaryPredicate pred)
{
    for (; first != last; ++first)
        if (pred(*first))
        {
            *d_first = *first;
            ++d_first;
        }
 
    return d_first;
}

Пример

Следующий код использует std::copy для копирования содержимого одного std::vector в другой и для отображения результирующего std::vector.

#include <algorithm>
#include <iostream>
#include <iterator>
#include <numeric>
#include <vector>
 
int main()
{
    std::vector<int> from_vector(10);
    std::iota(from_vector.begin(), from_vector.end(), 0);
 
    std::vector<int> to_vector;
    std::copy(from_vector.begin(), from_vector.end(),
              std::back_inserter(to_vector));
// or, alternatively,
//  std::vector<int> to_vector(from_vector.size());
//  std::copy(from_vector.begin(), from_vector.end(), to_vector.begin());
// either way is equivalent to
//  std::vector<int> to_vector = from_vector;
 
    std::cout << "to_vector contains: ";
 
    std::copy(to_vector.begin(), to_vector.end(),
              std::ostream_iterator<int>(std::cout, " "));
    std::cout << '\n';
 
    std::cout << "odd numbers in to_vector are: ";
 
    std::copy_if(to_vector.begin(), to_vector.end(),
                 std::ostream_iterator<int>(std::cout, " "),
                 [](int x) { return x % 2 != 0; });
    std::cout << '\n';
 
    std::cout << "to_vector contains these multiples of 3: ";
 
    to_vector.clear();
    std::copy_if(from_vector.begin(), from_vector.end(),
                 std::back_inserter(to_vector),
                 [](int x) { return x % 3 == 0; });
 
    for (const int x : to_vector)
        std::cout << x << ' ';
    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
to_vector contains these multiples of 3: 0 3 6 9

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR Применён к Поведение, опубликованное Правильное поведение
LWG 2039 C++11 значение возврата std::copy_if не было указано указано
LWG 2044 C++11 стабильность std::copy_if не была определена определена

См. также

copy_backward
копирует диапазон элементов в обратном порядке
(шаблон функции)
reverse_copy
создаёт копию диапазона, который перевёрнут
(шаблон функции)
copy_n
(C++11)
копирует количество элементов в новое местоположение
(шаблон функции)
fill
присваивает заданное значение каждому элементу в диапазоне
(шаблон функции)
remove_copyremove_copy_if
копирует диапазон элементов, опуская те, которые удовлетворяют определённым критериям
(шаблон функции)
ranges::copyranges::copy_if
(C++20)(C++20)
копирует диапазон элементов в новое местоположение
(niebloid)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/algorithm/copy

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API