std::ranges::end

 

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

 

ヘッダ <ranges> で定義
ヘッダ <iterator> で定義
inline namespace /* 未指定 */ {     inline constexpr /* 指定なし */ end = /* 指定なし */; }		(C++20以降) (カスタマイズポイントオブジェクト)
呼び出しシグネチャ
template< class T >     requires /* 以下を参照 */ constexpr std::sentinel_for<ranges::iterator_t<T>> auto end( T&& t );		(C++20以降)

範囲の終端を示すセンチネルを返します。

引数が左辺値であるか、または ranges::enable_borrowed_range<std::remove_cv_t<T>> が true である場合、ranges::end の呼び出しは 式等価です。

1. t + std::extent_v<T> （t が既知の境界を持つ配列型の場合）。
   • もし std::remove_all_extents_t<std::remove_reference_t<T>> が不完全型である場合、ranges::end の呼び出しは不正形式であり、診断は不要です。
2. それ以外の場合、decay-copy(t.end())(C++23まで)auto(t.end())(C++23以降)、この式が有効であり、その型が std::sentinel_for<ranges::iterator_t<T>> をモデル化する場合。
3. それ以外の場合、decay-copy(end(t))(C++23まで)auto(end(t))(C++23以降)、T がクラス型または列挙型であり、この式が有効で、その変換された型が std::sentinel_for<ranges::iterator_t<T>> をモデル化する場合。ここで、end の意味は、引数依存探索のみを実行した場合と同様に確立されます。

上記以外のすべてのケースでは、ranges::end の呼び出しは不正形式であり、テンプレートインスタンス化の直接のコンテキストで ranges::end の呼び出しが現れる場合、置換失敗につながる可能性があります。

カスタマイゼーションポイントオブジェクト

ranges::end という名前は、カスタマイゼーションポイントオブジェクト を表します。これは、関数オブジェクトであり、リテラルな semiregular クラス型の const オブジェクトです。説明のために、その型の cv 修飾されていないバージョンは __end_fn と表記されます。

__end_fn のすべてのインスタンスは等価です。同じ引数に対して異なる __end_fn 型のインスタンスを呼び出した場合の効果は、インスタンスを表す式が左辺値か右辺値か、および const 修飾されているかどうかにかかわらず同等です（ただし、volatile 修飾されたインスタンスは呼び出し可能であることが保証されていません）。したがって、ranges::end は自由にコピーでき、そのコピーは互換性があります。

型のセット Args... が与えられた場合、std::declval<Args>()... が上記の ranges::end の引数要件を満たす場合、__end_fn は以下をモデル化します。

• std::invocable<__end_fn, Args...>,
• std::invocable<const __end_fn, Args...>,
• std::invocable<__end_fn&, Args...>、および
• std::invocable<const __end_fn&, Args...>.
  

それ以外の場合、__end_fn の関数呼び出し演算子のいずれもオーバーロード解決に参加しません。

注釈

引数が右辺値（つまり T がオブジェクト型）であり、ranges::enable_borrowed_range<std::remove_cv_t<T>> が false である場合、または境界が不明な配列型である場合、ranges::end の呼び出しは不正形式であり、置換失敗にもつながります。

もし ranges::end(std::forward<T>(t)) が有効である場合、decltype(ranges::end(std::forward<T>(t))) と decltype(ranges::begin(std::forward<T>(t))) は、T が std::ranges::range をモデル化する間、すべてのケースで std::sentinel_for をモデル化します。

C++20 標準では、基になる end 関数呼び出しが prvalue を返す場合、戻り値はマテリアライズされた一時オブジェクトからムーブ構築される必要があります。すべての実装では、代わりに prvalue を直接返します。この要件は、実装に一致するように、C++20 後プロポーザル P0849R8 によって修正されています。

例

このコードを実行

#include <algorithm>
#include <iostream>
#include <ranges>
#include <vector>
 
int main()
{
    std::vector<int> vec{3, 1, 4};
    if (std::ranges::find(vec, 5) != std::ranges::end(vec))
        std::cout << "found a 5 in vector vec!\n";
 
    int arr[]{5, 10, 15};
    if (std::ranges::find(arr, 5) != std::ranges::end(arr))
        std::cout << "found a 5 in array arr!\n";
}

出力

found a 5 in array arr!

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
P2602R2	C++20	ADL によって見つけられる特定の非メンバー end を禁止する仕組みがあります。	その仕組みは削除されました。

関連項目

ranges::cend (C++20)	読み取り専用rangeの終端を示す番兵を返す (カスタマイゼーションポイントオブジェクト)
ranges::begin (C++20)	rangeの先頭を指すイテレータを返す (カスタマイゼーションポイントオブジェクト)
endcend (C++11)(C++14)	コンテナまたは配列の末尾を指すイテレータを返す (関数テンプレート)