std::end, std::cend

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

イテレータライブラリ

イテレータのコンセプト
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
イテレータのプリミティブ
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (C++17で非推奨) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
アルゴリズムのコンセプトとユーティリティ
間接呼び出し可能コンセプト
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
共通アルゴリズム要件
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
ユーティリティ
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
イテレータアダプタ
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
ストリームイテレータ istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	イテレータのカスタマイゼーションポイント ranges::iter_move (C++20) ranges::iter_swap (C++20)
イテレータ操作 advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	Rangeアクセス begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (C++17)

 

ヘッダー <array> で定義
ヘッダー <deque> で定義
ヘッダ <flat_map> で定義
ヘッダ <flat_set> で定義
ヘッダ <forward_list> で定義
ヘッダ <inplace_vector> で定義
ヘッダ <iterator> で定義
ヘッダ <list> で定義
ヘッダ <map> で定義
ヘッダ <regex> で定義
ヘッダー <set> で定義
ヘッダ <span> で定義
ヘッダ <string> で定義
ヘッダ <string_view> で定義
ヘッダ <unordered_map> で定義
ヘッダー <unordered_set> で定義
ヘッダー <vector> で定義
template< class C > auto end( C& c ) -> decltype(c.end());	(1)	(C++11以降) (C++17 以降 constexpr)
template< class C > auto end( const C& c ) -> decltype(c.end());	(2)	(C++11以降) (C++17 以降 constexpr)
template< class T, std::size_t N > T* end( T (&array)[N] );	(3)	(C++11以降) (C++14以降 noexcept) (C++14以降constexpr)
template< class C > constexpr auto cend( const C& c ) noexcept(/* 以下参照 */)     -> decltype(std::end(c));	(4)	(C++14以降)

指定された範囲の末尾（つまり、最後の要素の次の要素）を指すイテレータを返します。

1,2) c.end() を返します。これは通常、c によって表されるシーケンスの末尾の1つ先のイテレータです。

1) C が標準の Container である場合、C::iterator オブジェクトを返します。

2) C が標準の Container である場合、C::const_iterator オブジェクトを返します。

3) array の末尾を指すポインタを返します。

4) c を常に const 修飾として扱う std::end(c) を返します。

C が標準の Container である場合、C::const_iterator オブジェクトを返します。

パラメータ

c	-	end メンバ関数を持つコンテナまたはビュー
array	-	任意の型の配列

戻り値

1,2) c.end()

3) array + N

4) c.end()

例外

4)

noexcept 指定:  

noexcept(noexcept(std::end(c)))

オーバーロード

適切な end() メンバ関数を公開していないが、イテレート可能なクラスや列挙型に対して、end のカスタムオーバーロードを提供できます。標準ライブラリによって既に提供されているオーバーロードは以下の通りです。

std::end(std::initializer_list) (C++11)	std::end を特殊化します。 (function template)
std::end(std::valarray) (C++11)	std::end を特殊化します。 (function template)
begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator) (C++17)	範囲ベース for ループのサポート (function)
begin(std::filesystem::recursive_directory_iterator)end(std::filesystem::recursive_directory_iterator)	範囲ベース for ループのサポート (関数)

swap の使用と同様に（Swappable で説明）、ジェネリックなコンテキストで end 関数を使用する一般的な方法は、using std::end; end(arg); の同等であり、これにより、ユーザー定義型に対する ADL で選択されたオーバーロードと標準ライブラリの関数テンプレートの両方が同じオーバーロードセットに表示されるようになります。

template<typename Container, typename Function>
void for_each(Container&& cont, Function f)
{
    using std::begin;
    auto it = begin(cont);
    using std::end;
    auto end_it = end(cont);
 
    for (; it != end_it; ++it)
        f(*it);
}

引数依存探索で見つかった end のオーバーロードは、std::ranges::end、std::ranges::cend、および std::ranges::end に依存する他のカスタマイズポインタオブジェクトの動作をカスタマイズするために使用できます。

(C++20以降)

注記

配列以外のオーバーロードは、C::end() の動作を正確に反映します。メンバ関数が適切な実装を持っていない場合、その効果は驚くべきものになる可能性があります。

std::cend は、メンバおよび非メンバの範囲アクセスを統一するために導入されました。 LWG issue 2128 も参照してください。

C がシャロー const ビューである場合、std::cend はミュータブルイテレータを返す可能性があります。このような動作は一部のユーザーにとって予期しないものです。 P2276 および P2278 も参照してください。

例

このコードを実行

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

出力

Found a 5 in array w!

関連項目

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