std::ranges::remove, std::ranges::remove_if

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

演算法庫

有約束演算法與針對範圍的演算法 (C++20)
有約束的演算法，例如 ranges::copy、 ranges::sort 等……
執行策略 (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
非修改序列操作 批次操作 for_each for_each_n (C++17) 搜尋操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n 修改序列操作 複製操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) 交換操作 swap iter_swap swap_ranges 變換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 移除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序變換操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17 前)(C++11) shift_leftshift_right (C++20)(C++20) 取樣操作 sample (C++17)	排序及相關操作 劃分操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) 排序操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分搜尋操作 （於已劃分範圍上） lower_bound upper_bound equal_range binary_search 集合操作（於已排序範圍上） includes set_union set_intersection set_difference set_symmetric_difference 歸併操作（於已排序範圍上） merge inplace_merge 堆操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大值操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 字典序比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 排列操作 next_permutation prev_permutation is_permutation (C++11) C 庫 qsort bsearch
數值操作
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)
未初始化記憶體上的操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

受約束演算法

此選單中的所有名稱均屬於名稱空間 std::ranges

非修改序列操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

修改序列操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

劃分操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

排序操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分查詢操作（在已排序的範圍內）

lower_bound         upper_bound         binary_search      equal_range

集合操作（於已排序範圍上）

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

堆操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大值操作

max max_element         min min_element         minmax minmax_element     clamp

排列操作

is_permutation      next_permutation    prev_permutation

摺疊操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

數值操作 iota (C++23)             隨機數生成 generate_random (C++26)

對未初始化儲存的操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

返回型別

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

定義於標頭檔案 <algorithm>
呼叫簽名 (Call signature)
	(1)
template< std::permutable I, std::sentinel_for<I> S,           class T, class Proj = std::identity > requires std::indirect_binary_predicate              <ranges::equal_to, std::projected<I, Proj>, const T*> constexpr ranges::subrange<I>     remove( I first, S last, const T& value, Proj proj = {} );			(C++20 起) （直到 C++26）
template< std::permutable I, std::sentinel_for<I> S,           class Proj = std::identity,           class T = std::projected_value_t<I, Proj> > requires std::indirect_binary_predicate              <ranges::equal_to, std::projected<I, Proj>, const T*> constexpr ranges::subrange<I>     remove( I first, S last, const T& value, Proj proj = {} );			(C++26 起)
		(2)
template< ranges::forward_range R,           class T, class Proj = std::identity > requires std::permutable<ranges::iterator_t<R>> &&          std::indirect_binary_predicate              <ranges::equal_to,               std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr ranges::borrowed_subrange_t<R>     remove( R&& r, const T& value, Proj proj = {} );				(C++20 起) （直到 C++26）
template< ranges::forward_range R,           class Proj = std::identity,           class T = std::projected_value_t<ranges::iterator_t<R>, Proj> > requires std::permutable<ranges::iterator_t<R>> &&          std::indirect_binary_predicate              <ranges::equal_to,               std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr ranges::borrowed_subrange_t<R>     remove( R&& r, const T& value, Proj proj = {} );				(C++26 起)
template< std::permutable I, std::sentinel_for<I> S,           class Proj = std::identity,           std::indirect_unary_predicate<std::projected<I, Proj>> Pred > constexpr ranges::subrange<I>     remove_if( I first, S last, Pred pred, Proj proj = {} );			(3)	(C++20 起)
template< ranges::forward_range R,           class Proj = std::identity,           std::indirect_unary_predicate               <std::projected<ranges::iterator_t<R>, Proj>> Pred > requires std::permutable<ranges::iterator_t<R>> constexpr ranges::borrowed_subrange_t<R>     remove_if( R&& r, Pred pred, Proj proj = {} );			(4)	(C++20 起)

從範圍 [first, last) 中移除所有滿足特定條件的元素，並返回一個子範圍 [ret, last)，其中 ret 是該範圍新末尾的過尾迭代器。

1) 使用 std::invoke(proj, *i) == value 進行比較，移除所有等於 value 的元素。

3) 移除所有滿足 std::invoke(pred, std::invoke(proj, *i)) 返回 true 的元素。

2,4) 與 (1,3) 相同，但使用 r 作為範圍，如同使用 ranges::begin(r) 作為 first 和 ranges::end(r) 作為 last。

移除操作透過移動賦值來完成，將不需要移除的元素移動到範圍的開頭。保留剩餘元素的相對順序，容器的*物理*大小不變。指向新*邏輯*末尾和*物理*末尾之間元素的迭代器仍然可以解引用，但這些元素本身的值未指定（根據MoveAssignable的後置條件）。

本頁描述的類函式實體是 演算法函式物件（非正式地稱為 niebloids），即

• 呼叫它們中的任何一個時，不能指定顯式模板引數列表。
• 它們中的任何一個都對 引數依賴查詢 不可見。
• 當它們透過普通非限定查詢作為函式呼叫運算子左側的名稱被找到時，實參依賴查詢被抑制。

引數

first, last	-	定義要處理元素的範圍的迭代器-哨兵對
r	-	要處理的元素範圍
value	-	要移除的元素值
pred	-	應用於投影元素的謂詞
proj	-	應用於元素的投影

返回值

{ret, last}，其中 [first, ret) 是移除後的結果子範圍，子範圍 [ret, last) 中的所有元素都處於有效但未指定狀態，即 [ret, last) 是要擦除的子範圍。

複雜度

精確執行 N 次對應謂詞和任何投影的操作，其中 N = ranges::distance(first, last)，並且最壞情況下執行 N - 1 次移動操作。

註解

呼叫 `ranges::remove` 後通常會呼叫容器的 `erase` 成員函式，該函式會擦除未指定的值並將容器的*物理*大小減小到與其新的*邏輯*大小匹配。這兩個呼叫共同構成了所謂的擦除-移除習語，可以透過自由函式std::erase實現，該函式對所有標準*序列*容器都有過載，或者透過std::erase_if實現，該函式對*所有*標準容器都有過載。

名稱相似的容器成員函式list::remove、list::remove_if、forward_list::remove和forward_list::remove_if會擦除被移除的元素。

這些演算法通常不能用於關聯容器，例如 std::set 和 std::map，因為它們的迭代器型別不能解引用為 MoveAssignable 型別（這些容器中的鍵不可修改）。

由於 ranges::remove 透過引用接收 value，如果它引用範圍 [first, last) 中的某個元素，則可能會導致意外行為。

可能的實現

remove (1,2)
struct remove_fn { template<std::permutable I, std::sentinel_for<I> S, class Proj = std::identity, class T = std::projected_value_t<I, Proj>> requires std::indirect_binary_predicate <ranges::equal_to, std::projected<I, Proj>, const T*> constexpr ranges::subrange<I> operator()(I first, S last, const T& value, Proj proj = {}) const { first = ranges::find(std::move(first), last, value, proj); if (first != last) { for (I i{std::next(first)}; i != last; ++i) if (value != std::invoke(proj, *i)) { *first = ranges::iter_move(i); ++first; } } return {first, last}; }   template<ranges::forward_range R, class Proj = std::identity, class T = std::projected_value_t<ranges::iterator_t<R>, Proj>> requires std::permutable<ranges::iterator_t<R>> && std::indirect_binary_predicate <ranges::equal_to, std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr ranges::borrowed_subrange_t<R> operator()(R&& r, const T& value, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), value, std::move(proj)); } };   inline constexpr remove_fn remove {};
remove_if (3,4)
struct remove_if_fn { template<std::permutable I, std::sentinel_for<I> S, class Proj = std::identity, std::indirect_unary_predicate<std::projected<I, Proj>> Pred> constexpr ranges::subrange<I> operator()(I first, S last, Pred pred, Proj proj = {}) const { first = ranges::find_if(std::move(first), last, pred, proj); if (first != last) { for (I i{std::next(first)}; i != last; ++i) if (!std::invoke(pred, std::invoke(proj, *i))) { *first = ranges::iter_move(i); ++first; } } return {first, last}; }   template<ranges::forward_range R, class Proj = std::identity, std::indirect_unary_predicate <std::projected<ranges::iterator_t<R>, Proj>> Pred> requires std::permutable<ranges::iterator_t<R>> constexpr ranges::borrowed_subrange_t<R> operator()(R&& r, Pred pred, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), pred, std::move(proj)); } };   inline constexpr remove_if_fn remove_if {};

註解

特性測試宏	值	標準	特性
__cpp_lib_algorithm_default_value_type	202403	(C++26)	演算法的列表初始化 (1,2)

示例

執行此程式碼

#include <algorithm>
#include <cassert>
#include <complex>
#include <cctype>
#include <iomanip>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>
 
int main()
{
    std::string v1{"No - Diagnostic - Required"};
    std::cout << std::quoted(v1) << " (v1, size: " << v1.size() << ")\n";
    const auto ret = std::ranges::remove(v1, ' ');
    std::cout << std::quoted(v1) << " (v1 after `remove`, size: " << v1.size() << ")\n";
    std::cout << ' ' << std::string(std::distance(v1.begin(), ret.begin()), '^') << '\n';
    v1.erase(ret.begin(), ret.end());
    std::cout << std::quoted(v1) << " (v1 after `erase`, size: " << v1.size() << ")\n\n";
 
    // remove_if with custom unary predicate:
    auto rm = [](char c) { return !std::isupper(c); };
    std::string v2{"Substitution Failure Is Not An Error"};
    std::cout << std::quoted(v2) << " (v2, size: " << v2.size() << ")\n";
    const auto [first, last] = std::ranges::remove_if(v2, rm);
    std::cout << std::quoted(v2) << " (v2 after `remove_if`, size: " << v2.size() << ")\n";
    std::cout << ' ' << std::string(std::distance(v2.begin(), first), '^') << '\n';
    v2.erase(first, last);
    std::cout << std::quoted(v2) << " (v2 after `erase`, size: " << v2.size() << ")\n\n";
 
    // creating a view into a container that is modified by `remove_if`:
    for (std::string s : {"Small Object Optimization", "Non-Type Template Parameter"})
        std::cout << std::quoted(s) << " => "
            << std::string_view{begin(s), std::ranges::remove_if(s, rm).begin()} << '\n';
 
    std::vector<std::complex<double>> nums{{2, 2}, {1, 3}, {4, 8}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto e = std::ranges::remove(nums, {1, 3}); // T gets deduced
    #else
        auto e = std::ranges::remove(nums, std::complex<double>{1, 3});
    #endif
    nums.erase(e.begin(), e.end());
    assert((nums == std::vector<std::complex<double>>{{2, 2}, {4, 8}}));
}

可能的輸出

"No _ Diagnostic _ Required" (v1, size: 26)
"No_Diagnostic_Requiredired" (v1 after `remove`, size: 26)
 ^^^^^^^^^^^^^^^^^^^^^^
"No_Diagnostic_Required" (v1 after `erase`, size: 22)
 
"Substitution Failure Is Not An Error" (v2, size: 36)
"SFINAEtution Failure Is Not An Error" (v2 after `remove_if`, size: 36)
 ^^^^^^
"SFINAE" (v2 after `erase`, size: 6)
 
"Small Object Optimization" => SOO
"Non-Type Template Parameter" => NTTP

參閱

ranges::remove_copyranges::remove_copy_if (C++20)(C++20)	複製一個範圍的元素，忽略那些滿足特定條件的元素 (演算法函式物件)
ranges::unique (C++20)	移除一個範圍中的連續重複元素 (演算法函式物件)
removeremove_if	移除滿足特定標準的元素 (函式模板)