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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

技术规范

符号索引

外部库

 

范围库

范围访问 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) 。对任何适合的子表达式 e 和 p，表达式 views::filter(e, p) 表达式等价于 filter_view(e, p)。

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

数据成员

成员名	定义
base_ (私有)	V 类型的底层 view。 (仅用于阐述的成员对象*)
pred_ (私有)	copyable-box<Pred> (C++23 前)movable-box<Pred> (C++23 起) 类型的包装，用于过滤 base_ 中的元素的谓词，增强 Pred 使其在需要时可以赋值，因而总是满足 copyable或 movable (C++23 起)。 (仅用于阐述的成员对象*)
begin_ (私有) (有条件提供)	[[cpp/ranges#非传播缓存|std::optional 式]]类型的对象，缓存一个指向 base_ 的首个满足 pred_ 的元素的迭代器。只有在 filter_view 实现 forward_range 时才给出。 (仅用于阐述的成员对象*)

成员函数

(构造函数)	构造 filter_view (公开成员函数)
base	返回底层视图 V (公开成员函数)
pred	返回到存储于 filter_view 内的谓词的引用 (公开成员函数)
begin	返回 filter_view 的起始迭代器 (公开成员函数)
end	返回 filter_view 的哨位 (公开成员函数)
继承自 std::ranges::view_interface
empty	返回视图是否为空。仅当视图满足 forward_range 时提供。 (std::ranges::view_interface<D> 的公开成员函数)
cbegin (C++23)	返回指向范围起始的常量迭代器。 (std::ranges::view_interface<D> 的公开成员函数)
cend (C++23)	返回对应于范围常量迭代器的哨位。 (std::ranges::view_interface<D> 的公开成员函数)
operator 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_)); // 缓存
    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++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
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 的到首个谓词返回 false 为止的起始元素组成的 view (类模板) (范围适配器对象)