std::end, std::cend
ヘッダ <iterator> で定義
|
||
(1) | ||
template< class C > auto end( C& c ) -> decltype(c.end()); |
(C++11以上) (C++17未満) |
|
template< class C > constexpr auto end( C& c ) -> decltype(c.end()); |
(C++17以上) | |
(1) | ||
template< class C > auto end( const C& c ) -> decltype(c.end()); |
(C++11以上) (C++17未満) |
|
template< class C > constexpr auto end( const C& c ) -> decltype(c.end()); |
(C++17以上) | |
(2) | ||
template< class T, std::size_t N > T* end( T (&array)[N] ); |
(C++11以上) (C++14未満) |
|
template< class T, std::size_t N > constexpr T* end( T (&array)[N] ) noexcept; |
(C++14以上) | |
template< class C > constexpr auto cend( const C& c ) noexcept(/* see below */) |
(3) | (C++14以上) |
指定されたコンテナ c
または配列 array
の終端 (最後の要素の次の要素) を指すイテレータを返します。 これらのテンプレートは C::end() が妥当な実装を持つことを当てにしています。
c
によって表されるシーケンスの終端を指すイテレータです。 C
が標準の Container の場合、 c
が const 修飾されていなければ C::iterator を返し、そうでなければ C::const_iterator を返します。array
の終端を指すポインタを返します。c
は常に const 修飾されたものとして扱われます。 C
が標準の Container の場合、これは常に C::const_iterator を返します。
目次 |
[編集] 引数
c | - | メンバ関数 end を持つコンテナ
|
array | - | 任意の型の配列 |
[編集] 戻り値
c
または array
の終端を指すイテレータ。 ちなみにコンテナまたは配列の終端は、最後の有効な要素の次の要素として定義されます。
[編集] 例外
[編集] ノート
<iterator>
がインクルードされた場合に加えて <array>
、 <deque>
、 <forward_list>
、 <list>
、 <map>
、 <regex>
、 <set>
、 <span>
(C++20以上)、 <string>
、 <string_view>
(C++17以上)、 <unordered_map>
、 <unordered_set>
、 <vector>
のいずれかのヘッダがインクルードされた場合も、 std::end
および std::cend
が利用可能になることが保証されています。
[編集] ユーザ定義のオーバーロード
適切な end()
メンバ関数を持たないけれどもイテレート可能なクラスに対して、 end
のカスタムオーバーロードを提供しても構いません。 以下のオーバーロードは標準ライブラリによってすでに提供されています。
std::end の特殊化 (関数テンプレート) | |
(C++11) |
std::end の特殊化 (関数テンプレート) |
範囲ベースの for ループサポート (関数) | |
範囲ベースの 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); while (it != end_it) { f(*it); ++it; } }
[編集] 例
#include <iostream> #include <vector> #include <iterator> #include <algorithm> 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 a[] = { 5, 10, 15 }; if (std::find(std::begin(a), std::end(a), 5) != std::end(a)) { std::cout << "found a 5 in array a!\n"; } }
出力:
found a 5 in array a!
[編集] 関連項目
(C++11)(C++14) |
コンテナまたは配列の先頭を指すイテレータを返します (関数) |