std::replace_copy, std::replace_copy_if

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Algorithm library

Execution policies (C++17)
is_execution_policy	execution::seqexecution::parexecution::par_unseq	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policy
Non-modifying sequence operations
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal lexicographical_compare	findfind_iffind_if_not (C++11) find_end find_first_of	adjacent_find search search_n
Modifying sequence operations
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (until C++17)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
Operations on uninitialized storage
uninitialized_copy uninitialized_move (C++17)	uninitialized_copy_n (C++11) uninitialized_move_n (C++17)	uninitialized_fill	uninitialized_fill_n
Partitioning operations
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
Sorting operations
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
Binary search operations
lower_bound	upper_bound	binary_search	equal_range
Set operations (on sorted ranges)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
Heap operations
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
Minimum/maximum operations
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
Permutations
is_permutation (C++11)	next_permutation	prev_permutation
Numeric operations
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17) exclusive_scan (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
C library
qsort	bsearch

 

Defined in header <algorithm>
template< class InputIt, class OutputIt, class T > OutputIt replace_copy( InputIt first, InputIt last, OutputIt d_first,                        const T& old_value, const T& new_value );	(1)
template< class ExecutionPolicy, class InputIt, class OutputIt, class T > OutputIt replace_copy( ExecutionPolicy&& policy, InputIt first, InputIt last, OutputIt d_first,                        const T& old_value, const T& new_value );	(2)	(since C++17)
template< class InputIt, class OutputIt, class UnaryPredicate, class T > OutputIt replace_copy_if( InputIt first, InputIt last, OutputIt d_first,                           UnaryPredicate p, const T& new_value );	(3)
template< class ExecutionPolicy, class InputIt, class OutputIt, class UnaryPredicate, class T > OutputIt replace_copy_if( ExecutionPolicy&& policy, InputIt first, InputIt last, OutputIt d_first,                           UnaryPredicate p, const T& new_value );	(4)	(since C++17)

Copies the all elements from the range [first, last) to another range beginning at d_first replacing all elements satisfying specific criteria with new_value. The source and destination ranges cannot overlap.

1) Replaces all elements that are equal to old_value.

3) Replaces all elements for which predicate p returns true.

2,4) Same as (1,3), but executed according to policy. These overloads do not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true

Parameters

first, last	-	the range of elements to copy
d_first	-	the beginning of the destination range
old_value	-	the value of elements to replace
policy	-	the execution policy to use. See execution policy for details.
p	-	unary predicate which returns ​true if the element value should be replaced. The signature of the predicate function should be equivalent to the following:  bool pred(const Type &a); The signature does not need to have const &, but the function must not modify the objects passed to it. The type Type must be such that an object of type InputIt can be dereferenced and then implicitly converted to Type. ​
new_value	-	the value to use as replacement
Type requirements
- InputIt must meet the requirements of InputIterator.
- OutputIt must meet the requirements of OutputIterator.

Return value

Iterator to the element past the last element copied.

Complexity

Exactly last - first applications of the predicate.

Exceptions

The overloads with a template parameter named ExecutionPolicy report errors as follows:

• If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the three standard policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
• If the algorithm fails to allocate memory, std::bad_alloc is thrown.

Possible implementation

First version
template<class InputIt, class OutputIt, class T> OutputIt replace_copy(InputIt first, InputIt last, OutputIt d_first, const T& old_value, const T& new_value) { for (; first != last; ++first) { *d_first++ = (*first == old_value) ? new_value : *first; } return d_first; }
Second version
template<class InputIt, class OutputIt, class UnaryPredicate, class T> OutputIt replace_copy_if(InputIt first, InputIt last, OutputIt d_first, UnaryPredicate p, const T& new_value) { for (; first != last; ++first) { *d_first++ = p( *first ) ? new_value : *first; } return d_first; }

Example

The following copy prints a vector, replacing all values over 5 with 99 on the fly.

Run this code

#include <algorithm>
#include <vector>
#include <iostream>
#include <iterator>
#include <functional>
 
int main()
{
    std::vector<int> v{5, 7, 4, 2, 8, 6, 1, 9, 0, 3};
    std::replace_copy_if(v.begin(), v.end(),
                         std::ostream_iterator<int>(std::cout, " "),
                         [](int n){return n > 5;}, 99);
    std::cout << '\n';
}

Output:

5 99 4 2 99 99 1 99 0 3

See also

removeremove_if	removes elements satisfying specific criteria (function template)
std::experimental::parallel::replace_copy (parallelism TS)	parallelized version of std::replace_copy (function template)
std::experimental::parallel::replace_copy_if (parallelism TS)	parallelized version of std::replace_copy_if (function template)