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

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

范围库

范围访问
begin cbegin end cend	rbegin crbegin rend crend	size ssize data cdata	empty
范围原语
iterator_tsentinel_t	range_size_trange_difference_t	range_reference_trange_rvalue_reference_t	range_value_t
悬垂迭代器处理
dangling	borrowed_iterator_t	borrowed_subrange_t
范围概念
range borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range random_access_range contiguous_range
视图
view_interface	subrange
范围工厂
empty_viewviews::empty	single_viewviews::single	iota_viewviews::iota	basic_istream_viewviews::istream
适配器
views::all_tviews::all ref_view owning_view common_viewviews::common reverse_viewviews::reverse views::counted zip_viewviews::zip (C++23)(C++23)	take_viewviews::take take_while_viewviews::take_while drop_viewviews::drop drop_while_viewviews::drop_while zip_transform_viewviews::zip_transform (C++23)(C++23)	elements_viewviews::elements keys_viewviews::keys values_viewviews::values transform_viewviews::transform adjacent_viewviews::adjacent (C++23)(C++23)	filter_viewviews::filter join_viewviews::join split_viewviews::split lazy_split_viewviews::lazy_split adjacent_transform_viewviews::adjacent_transform (C++23)(C++23)
范围适配器对象
范围适配器闭包对象
辅助项
copyable-box	simple-view

 

std::ranges::filter_view

成员函数

filter_view::filter_view (C++20)

filter_view::base (C++20)

filter_view::pred (C++20)

filter_view::begin (C++20)

filter_view::end (C++20)

推导指引 (C++20)

迭代器

filter_view::iterator::iterator (C++20)

filter_view::iterator::base (C++20)

filter_view::iterator::operator*filter_view::iterator::operator-> (C++20)(C++20)

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

filter_view::iterator::operator-- filter_view::iterator::operator--(int) (C++20)(C++20)

operator==(filter_view::iterator) (C++20)

iter_move(filter_view::iterator) (C++20)

iter_swap(filter_view::iterator) (C++20)

哨位

filter_view::sentinel::sentinel (C++20)

filter_view::sentinel::base (C++20)

operator==(filter_view::iterator, filter_view::sentinel) (C++20)

 

定义于头文件 <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 /*unspecified*/ filter = /*unspecified*/; }	(2)	(C++20 起)

1) 表示排除了不能满足谓词的元素的底层序列的 view 的范围适配器。

2) 范围适配器对象。对任何适合的子表达式 e 与 p ，表达式 views::filter(e, p) 表达式等价于 filter_view(e, p) 。

filter_view 在底层 view V 实现 bidirectional_range、 forward_range、 input_range 及 common_range 时分别实现相应的概念。

表达式等价

表达式 e 表达式等价于表达式 f ，若 e 与 f 拥有相同效果，均为潜在抛出或均非潜在抛出（即 noexcept(e) == noexcept(f) ），且均为常量子表达式或均非常量子表达式。

数据成员

filter_view 的典型实现保有二或三个数据成员：

• V 类型的底层 view （此处示为 base_ ，仅为阐释），
• /*copyable-box*/<Pred> 类型的包装，包装用于滤出 base_ 的元素的谓词（此处示为 pred_ ，仅为阐释），其中 copyable-box 时始终满足 copyable 的包装类模板，
• std::optional 式对象（此处示为 begin_ ，仅为阐释），缓存指向 base_ 的首个满足 pred_ 的元素的迭代器。 begin_ 可能仅若 filter_view 实现 forward_range 才存在。

成员函数

(构造函数) (C++20)	构造 filter_view (公开成员函数)
base (C++20)	返回底层视图 V (公开成员函数)
pred (C++20)	返回到存储于 filter_view 内的谓词的引用 (公开成员函数)
begin (C++20)	返回 filter_view 的起始迭代器 (公开成员函数)
end (C++20)	返回 filter_view 的哨位 (公开成员函数)
继承自 std::ranges::view_interface
empty (C++20)	返回视图是否为空。若视图满足 forward_range 则提供。 (std::ranges::view_interface<D> 的公开成员函数)
operator bool (C++20)	返回派生视图是否为非空。若 ranges::empty 可应用于它则提供。 (std::ranges::view_interface<D> 的公开成员函数)
front (C++20)	返回派生视图中的首元素。若视图满足 forward_range 则提供。 (std::ranges::view_interface<D> 的公开成员函数)
back (C++20)	返回派生视图中的末元素。若视图满足 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 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();		(C++20 起)

为提供 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_)); // 缓存
    return /*iterator*/{*this, begin_.value())};
}

若 pred_ 不含值则行为未定义。

std::ranges::filter_view::end

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

推导指引

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

嵌套类

iterator (C++20)	filter_view 的迭代器类型 (仅用于阐释的成员类)
sentinel (C++20)	底层视图非 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 << ' ';
    }
}

输出：

0 4 16

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

DR	应用于	出版时的行为	正确行为
P2325R3	C++20	若 Pred 非 default_initializable ， 则默认构造函数构造不含 Pred 的 filter_view	filter_view 亦非 default_initializable

参阅

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

由另一 view 的到首个谓词返回 false 为止的起始元素组成的 view (类模板) (范围适配器对象)