std::ranges::views::filter, std::ranges::filter_view

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

范围库

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata empty

范围转换 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

悬垂迭代器处理 dangling borrowed_iterator_t borrowed_subrange_t

范围原语
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

范围概念
range borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	constant_range (C++23)

视图
view_interface	subrange

范围工厂
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

范围适配器
views::all_tviews::all ref_view owning_view as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while concat_viewviews::concat (C++26)(C++26)	drop_viewviews::drop drop_while_viewviews::drop_while join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   lazy_split_viewviews::lazy_split split_viewviews::split views::counted common_viewviews::common	reverse_viewviews::reverse as_const_viewviews::as_const (C++23)(C++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (C++23)(C++23) zip_viewviews::zip (C++23)(C++23) zip_transform_viewviews::zip_transform (C++23)(C++23)	adjacent_viewviews::adjacent (C++23)(C++23) views::pairwise (C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23) views::pairwise_transform (C++23) chunk_viewviews::chunk (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23) stride_viewviews::stride (C++23)(C++23) cartesian_product_viewviews::cartesian_product (C++23)(C++23)

范围生成器 std::generator (C++23)

范围适配器闭包对象 range_adaptor_closure (C++23)

范围适配器对象

辅助项
copyable-box movable-box (直到 C++23)  (C++23)	simple-view non-propagating-cache

 

std::ranges::filter_view

成员函数

filter_view::filter_view

filter_view::base

filter_view::pred

filter_view::begin

filter_view::end

推导指南

迭代器

filter_view::iterator::iterator

filter_view::iterator::base

filter_view::iterator::operator*filter_view::iterator::operator->

filter_view::iterator::operator++ filter_view::iterator::operator++(int)

filter_view::iterator::operator-- filter_view::iterator::operator--(int)

operator==(filter_view::iterator)

iter_move(filter_view::iterator)

iter_swap(filter_view::iterator)

哨兵

filter_view::sentinel::sentinel

filter_view::sentinel::base

operator==(filter_view::iterator, filter_view::sentinel)

 

在头文件 <ranges> 中定义
template< ranges::input_range V,           std::indirect_unary_predicate<ranges::iterator_t<V>> Pred >     requires ranges::view<V> && std::is_object_v<Pred> class filter_view     : public ranges::view_interface<filter_view<V, Pred>>	(1)	(自 C++20 起)
namespace views {     inline constexpr /* 未指定 */ filter = /* 未指定 */; }	(2)	(自 C++20 起)
调用签名
template< ranges::viewable_range R, class Pred >     requires /* 见下文 */ constexpr ranges::view auto filter( R&& r, Pred&& pred );		(自 C++20 起)
template< class Pred > constexpr /* 范围适配器闭包 */ filter( Pred&& pred );		(自 C++20 起)

1) 一个范围适配器，它表示基础序列的 view，但不包含不满足谓词的元素。

2) RangeAdaptorObject。表达式 views::filter(e, p) 等效于 filter_view(e, p)，对于任何合适的子表达式 e 和 p。

filter_view 在基础 view V 满足相应概念的情况下，分别对概念 bidirectional_range、forward_range、input_range 和 common_range 建模。

数据成员

成员名称	定义
base_ (私有)	基础 view，类型为 V。 (仅供说明的成员对象*)
pred_ (私有)	包装用于过滤 base_ 中类型为 copyable-box<Pred>(直到 C++23)movable-box<Pred>(自 C++23 起) 元素的谓词，在需要时增强 Pred 的可赋值性，因此始终满足 copyable或 movable(自 C++23 起)。 (仅供说明的成员对象*)
begin_ (私有) (条件存在)	一个 类似可选类型 的对象，它缓存指向满足 pred_ 的 base_ 中第一个元素的迭代器。仅当 filter_view 对 forward_range 建模时存在。 (仅供说明的成员对象*)

成员函数

(构造函数)	构造一个 filter_view (公共成员函数)
base	返回基础视图 V (公共成员函数)
pred	返回对 filter_view 中存储的谓词的引用 (公共成员函数)
begin	返回 filter_view 的起始迭代器。 (公共成员函数)
end	返回 filter_view 的哨兵。 (公共成员函数)
继承自 std::ranges::view_interface
empty	返回派生视图是否为空。如果它满足 sized_range 或 forward_range，则提供此功能。 (std::ranges::view_interface<D> 的公有成员函数)
cbegin (C++23)	返回指向范围开头的常量迭代器。 (std::ranges::view_interface<D> 的公有成员函数)
cend (C++23)	返回范围的常量迭代器的哨兵。 (std::ranges::view_interface<D> 的公有成员函数)
运算符 bool	返回派生视图是否不为空。如果 ranges::empty 对它适用，则提供此功能。 (std::ranges::view_interface<D> 的公有成员函数)
front	返回派生视图中的第一个元素。如果它满足 forward_range，则提供此功能。 (std::ranges::view_interface<D> 的公有成员函数)
back	返回派生视图中的最后一个元素。如果它满足 bidirectional_range 和 common_range，则提供此功能。 (std::ranges::view_interface<D> 的公有成员函数)

std::ranges::filter_view::filter_view

filter_view() requires std::default_initializable<V> &&                        std::default_initializable<Pred> = default;	(1)	(自 C++20 起)
constexpr explicit filter_view( V base, Pred pred );	(2)	(自 C++20 起)

1) 通过其默认成员初始化器 (= V()) 对 base_ 进行值初始化，并对 pred_ 进行默认初始化（这会对包含的 Pred 进行值初始化）。

2) 用 std::move(base) 初始化 base_，并用 std::move(pred) 初始化 pred_。

参数

base	-	要过滤的范围
pred	-	用于过滤元素的谓词

std::ranges::filter_view::base

constexpr V base() const& requires std::copy_constructible<V>;	(1)	(自 C++20 起)
constexpr V base() &&;	(2)	(自 C++20 起)

1) 等效于 return base_;.

2) 等效于 return std::move(base_);.

std::ranges::filter_view::pred

constexpr const Pred& pred() const;		(自 C++20 起)

返回对包含的 Pred 对象的引用。如果 pred_ 不包含值，则行为未定义。

std::ranges::filter_view::begin

constexpr /*iterator*/ begin();		(仅供说明*)

为了提供 range 概念所需的摊销常数时间复杂度，此函数会将结果缓存在 filter_view 对象中，供后续调用使用。等效于

if constexpr (!ranges::forward_range<V>)
    return /*iterator*/{*this, ranges::find_if(base_, std::ref(*pred_))};
else
{
    if (!begin_.has_value())
        begin_ = ranges::find_if(base_, std::ref(*pred_)); // caching
    return /*iterator*/{*this, begin_.value())};
}

如果 pred_ 不包含值，则行为未定义。

std::ranges::filter_view::end

constexpr auto end();		(自 C++20 起)

返回指向结尾的迭代器。等效于

if constexpr (ranges::common_range<V>)
    return /*iterator*/{*this, ranges::end(base_)};
else
    return /*sentinel*/{*this};

推导指南

template< class R, class Pred > filter_view( R&&, Pred ) -> filter_view<views::all_t<R>, Pred>;		(自 C++20 起)

嵌套类

iterator	filter_view 的迭代器类型 (仅供说明的成员类*)
sentinel	当基础视图不是 common_range 时，filter_view 的哨兵类型 (仅供说明的成员类*)

示例

运行此代码

#include <iostream>
#include <ranges>
 
int main()
{
    auto even = [](int i) { return 0 == i % 2; };
    auto square = [](int i) { return i * i; };
 
    for (int i : std::views::iota(0, 6)
               | std::views::filter(even)
               | std::views::transform(square))
        std::cout << i << ' ';
    std::cout << '\n';
}

输出

0 4 16

缺陷报告

以下行为更改缺陷报告被追溯应用于以前发布的 C++ 标准。

DR	应用于	已发布的行为	正确行为
LWG 3714 (P2711R1)	C++20	多参数构造函数不是显式的	变为显式的
P2325R3	C++20	如果 Pred 不是 default_initializable，则默认构造函数 构造一个不包含 Pred 的 filter_view	filter_view 也 不是 default_initializable

另请参见

ranges::take_while_viewviews::take_while (C++20)

一个 view，它由另一个 view 的初始元素组成，直到第一个谓词返回 false 的元素。 (类模板) (范围适配器对象)