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

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

Rangesライブラリ

Rangeアクセス begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

Range変換 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

ダングリングイテレータの扱い dangling borrowed_iterator_t borrowed_subrange_t

Rangeプリミティブ
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コンセプト
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ファクトリ
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Rangeアダプタ
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ジェネレータ std::generator (C++23)

Rangeアダプタクロージャオブジェクト range_adaptor_closure (C++23)

Rangeアダプタオブジェクト

ヘルパーアイテム
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)

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 /* 不明 */ 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) は、任意の適切なサブ式 e および p に対して、 filter_view(e, p) と式等価です。

filter_viewは、基になるview Vがそれぞれのコンセプトをモデルとする場合、bidirectional_range、forward_range、input_range、およびcommon_rangeのコンセプトをモデル化します。

データメンバ

メンバ	説明
V base_ (private)	基盤となるビュー (説明用のメンバオブジェクト*)
copyable-box<Pred>(C++23まで)movable-box<Pred>(C++23以降) pred_ (private)	base_から要素を除外するために使用される述語をラップします。 (説明用のメンバオブジェクト*)
non-propagating-cache<ranges::iterator_t<V>> begin_ (private) (Vがforward_rangeを満たす場合のみ存在)	base_の、pred_を満たす最初の要素へのイテレータをキャッシュするオブジェクト。 (説明用のメンバオブジェクト*)

メンバ関数

(コンストラクタ)	filter_viewを構築します。 (public member function)
base	基本となるビュー V を返す (public member function)
pred	filter_view内に格納されている述語への参照を返します。 (public member function)
begin	filter_viewの開始イテレータを返します。 (public member function)
end	filter_viewのセンチネルを返します。 (public member function)
std::ranges::view_interface から継承
empty	派生ビューが空かどうかを返す。sized_range または forward_range を満たす場合にのみ提供される (std::ranges::view_interface<D> の public メンバ関数)
cbegin (C++23)	範囲の先頭への定数イテレータを返す (std::ranges::view_interface<D> の public メンバ関数)
cend (C++23)	範囲の定数イテレータの番兵を返す (std::ranges::view_interface<D> の public メンバ関数)
operator bool	派生ビューが空でないかどうかを返す。ranges::empty が適用可能な場合にのみ提供される (std::ranges::view_interface<D> の public メンバ関数)
front	派生ビューが forward_range を満たす場合に、派生ビューの最初の要素を返す (std::ranges::view_interface<D> の public メンバ関数)
back	派生ビューが bidirectional_range と common_range の両方を満たす場合にのみ、派生ビューの最後の要素を返す (std::ranges::view_interface<D> の public メンバ関数)

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) base_をデフォルトメンバ初期化子（= V()）で値初期化し、pred_をデフォルト初期化します（これにより、含まれるPredが値初期化されます）。

2) base_をstd::move(base)で初期化し、pred_をstd::move(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のイテレータ型。 (説明専用メンバクラス*)
センチネル	基になるビューが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	複数引数コンストラクタがexplicitではなかった。	明示的にされました
P2325R3	C++20	Predがdefault_initializableでない場合、デフォルトコンストラクタは Predを含まないfilter_viewを構築します。	filter_viewも default_initializableではありません。

関連項目

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

別のviewの先頭から、述語がfalseを返す最初の要素までの要素からなる view (クラステンプレート) (rangeアダプタオブジェクト)