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

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

范围库 (Ranges library)

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

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

悬空迭代器处理 (Dangling iterator handling) dangling borrowed_iterator_t borrowed_subrange_t

范围原语 (Range primitives)
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 concepts)
range borrowed_range    common_range	sized_range viewable_range    view	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	approximately_sized_range (C++26) constant_range (C++23)

视图
view_interface	subrange

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

范围适配器 (Range adaptors)
views::all_tviews::all as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while common_viewviews::common views::counted to_input_viewviews::to_input (C++26)(C++26)	ref_view drop_viewviews::drop drop_while_viewviews::drop_while lazy_split_viewviews::lazy_split split_viewviews::split join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   concat_viewviews::concat (C++26)(C++26) cache_latest_viewviews::cache_latest (C++26)(C++26)	owning_view 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)

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

范围适配器闭包对象 (Range adaptor closure objects) range_adaptor_closure (C++23)

范围适配器对象 (Range adaptor objects)

辅助项 (Helper items)
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

推导指引

迭代器 (Iterator)

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)

哨兵 (Sentinel)

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 /* unspecified */ filter = /* unspecified */; }	(2)	(C++20 起)
调用签名 (Call signature)
template< ranges::viewable_range R, class Pred >     requires /* 见下文 */ constexpr ranges::view auto filter( R&& r, Pred&& pred );		(C++20 起)
template< class Pred > constexpr /* range adaptor closure */ filter( Pred&& pred );		(C++20 起)

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

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

当底层view V 模拟相应的概念时，filter_view 模拟bidirectional_range、forward_range、input_range 和common_range的概念。

数据成员

成员	描述
V base_ (私有)	底层视图 (仅用于阐释的成员对象*)
copyable-box<Pred>(C++23前)movable-box<Pred>(C++23起) pred_ (私有)	包装用于过滤 base_ 元素的谓词 (仅用于阐释的成员对象*)
non-propagating-cache<ranges::iterator_t<V>> begin_ (私有) (仅当 V 满足forward_range时存在)	一个对象，用于缓存指向 base_ 中满足 pred_ 的第一个元素的迭代器 (仅用于阐释的成员对象*)

成员函数

(构造函数)	构造一个 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> 的公共成员函数)
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_)); // 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++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
LWG 3714 (P2711R1)	C++20	多参数构造函数不是显式的	改为 explicit
P2325R3	C++20	如果 Pred 不是default_initializable，则默认构造函数 构造的 filter_view 不包含 Pred	filter_view 也 不可default_initializable

另见

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

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