std::copy, std::copy_if
| Определён в заголовке <algorithm>
|
||
template< class InputIt, class OutputIt >
OutputIt copy( InputIt first, InputIt last,
OutputIt d_first );
|
(1) | (constexpr начиная с C++20) |
template< class ExecutionPolicy,
class ForwardIt1, class ForwardIt2 >
ForwardIt2 copy( ExecutionPolicy&& policy,
ForwardIt1 first, ForwardIt1 last,
ForwardIt2 d_first );
|
(2) | (начиная с C++17) |
template< class InputIt, class OutputIt, class UnaryPred >
OutputIt copy_if( InputIt first, InputIt last,
OutputIt d_first, UnaryPred pred );
|
(3) | (начиная с C++11) (constexpr начиная с C++20) |
template< class ExecutionPolicy,
class ForwardIt1, class ForwardIt2, class UnaryPred >
ForwardIt2 copy_if( ExecutionPolicy&& policy,
ForwardIt1 first, ForwardIt1 last,
ForwardIt2 d_first, UnaryPred pred );
|
(4) | (начиная с C++17) |
Копирует элементы диапазона, определённого как [first, last), в другой диапазон, начинающийся с d_first (целевой диапазон копирования).
[first, last) начиная с first и до last.d_first находится в [first, last), поведение не определено. В этом случае вместо этого может использоваться std::copy_backward.policy.true:
|
|
(до C++20) |
|
|
(начиная с C++20) |
[first, last) и целевой диапазон копирования перекрываются, поведение не определено.pred возвращает true. Данный алгоритм копирования устойчив: относительный порядок копируемых элементов сохраняется.[first, last) и целевой диапазон копирования перекрываются, поведение не определено.policy.true:
|
|
(до C++20) |
|
|
(начиная с C++20) |
Параметры
| first, last | - | пара итераторов, определяющих исходный диапазон элементов для копирования |
| d_first | - | начало целевого диапазона |
| policy | - | используемая политика выполнения |
| pred | - | унарный предикат, возвращающий true для требуемых элементов. Выражение |
| Требования к типам | ||
-InputIt должен соответствовать требованиям LegacyInputIterator.
| ||
-OutputIt должен соответствовать требованиям LegacyOutputIterator.
| ||
-ForwardIt1, ForwardIt2 должен соответствовать требованиям LegacyForwardIterator.
| ||
-UnaryPred должен соответствовать требованиям Predicate.
| ||
Возвращаемое значение
Выходной итератор на элемент в целевом диапазоне, следующий за последним скопированным элементом.
Сложность
Пусть N = std::distance(first, last):
pred и не более N присваиваний.Для перегрузок с ExecutionPolicy, может быть потеря производительности, если тип значения ForwardIt1 не является MoveConstructible.
Исключения
Перегрузки с параметром шаблона с именем ExecutionPolicy сообщают об ошибках следующим образом:
- Если выполнение функции, вызванной в рамках алгоритма, генерирует исключение и
ExecutionPolicyявляется одной из стандартных политик, вызывается std::terminate. Для любой другойExecutionPolicyповедение определяется реализацией. - Если алгоритму не удаётся выделить память, выбрасывается std::bad_alloc.
Возможная реализация
| 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 UnaryPred>
OutputIt copy_if(InputIt first, InputIt last,
OutputIt d_first, UnaryPred pred)
{
for (; first != last; ++first)
if (pred(*first))
{
*d_first = *first;
++d_first;
}
return d_first;
}
|
Примечания
На практике реализации std::copy избегают множественных присваиваний и используют функции массового копирования, такие как std::memmove, если тип значения является TriviallyCopyable, а типы итераторов удовлетворяют LegacyContiguousIterator.
При копировании перекрывающихся диапазонов std::copy подходит при копировании влево (начало целевого диапазона находится вне исходного диапазона), а std::copy_backward подходит при копировании вправо (конец целевого диапазона находится вне исходного диапазона).
Пример
Следующий код использует 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 не была определена
|
определена |
См. также
| копирует диапазон элементов в обратном порядке (шаблон функции & объект функции алгоритма) | |
(C++20) |
|
| создаёт копию диапазона в обратном порядке (шаблон функции & объект функции алгоритма) | |
(C++20) |
|
(C++11) |
копирует указанное количество элементов в новое место (шаблон функции & объект функции алгоритма) |
(C++20) |
|
| копирует присваиванием заданное значение каждому элементу диапазона (шаблон функции & объект функции алгоритма) | |
(C++20) |
|
| копирует диапазон элементов, пропуская те, которые удовлетворяют определённым критериям (шаблон функции & объект функции алгоритма) | |
(C++20)(C++20) |
|
(C++20)(C++20) |
копирует диапазон элементов в новое место (объект функции алгоритма) |