std::end, std::cend

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

迭代器库

迭代器概念
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)	范围访问 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) (constexpr 始于 C++17)
template< class C > auto end( const C& c ) -> decltype(c.end());	(2)	(始于 C++11) (constexpr 始于 C++17)
template< class T, std::size_t N > T* end( T (&array)[N] );	(3)	(始于 C++11) (noexcept 始于 C++14) (constexpr 始于 C++14)
template< class C > constexpr auto cend( const C& c ) noexcept(/* 见下文 */)     -> decltype(std::end(c));	(4)	(始于 C++14)

返回给定范围的末尾（即最后一个元素之后一个元素）的迭代器。

1,2) 返回 c.end()，它通常是表示为 c 的序列的末尾之后一个位置的迭代器。

1) 如果 C 是标准 容器，则返回 C::iterator 对象。

2) 如果 C 是标准 容器，则返回 C::const_iterator 对象。

3) 返回指向 array 末尾的指针。

4) 返回 std::end(c)，其中 c 始终被视为 const 限定。

如果 C 是标准 容器，则返回 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 (函数模板)
std::end(std::valarray) (C++11)	特化 std::end (函数模板)
begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator) (C++17)	基于范围的 for 循环支持 (函数)
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);
}

通过实参依赖查找 (ADL) 找到的 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)	返回指示范围末尾的哨位 (自定义点对象)
ranges::cend (C++20)	返回指示只读范围末尾的哨位 (自定义点对象)