std::end, std::cend

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

迭代器库

迭代器概念
间接可读 (C++20) 间接可写 (C++20) 弱可增量 (C++20) 可增量 (C++20) 是整数类型 是有符号整数类型 (C++20)(C++20)	哨兵 (C++20) 大小哨兵 (C++20) 输入迭代器 (C++20) 输出迭代器 (C++20) 输入或输出迭代器 (C++20)	前向迭代器 (C++20) 双向迭代器 (C++20) 随机访问迭代器 (C++20) 连续迭代器 (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)	迭代器 (在 C++17 中已弃用) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
算法概念和实用程序
间接可调用概念
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	间接一元谓词 (C++20) 间接二元谓词 (C++20)	间接等价关系 (C++20) 间接严格弱排序 (C++20)
通用算法要求
间接可移动 (C++20) 间接可移动可存储 (C++20) 间接可复制 (C++20)	间接可复制可存储 (C++20)   间接可交换 (C++20) 间接可比较 (C++20)	可置换 (C++20) 可合并 (C++20) 可排序 (C++20)
实用程序
indirect_result_t (C++20)	投影 (C++20)	projected_value_t (C++26)
迭代器适配器
反向迭代器 make_reverse_iterator (C++14) 移动迭代器 (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 起) (自 C++17 起为 constexpr)
template< class C > auto end( const C& c ) -> decltype(c.end());	(2)	(自 C++11 起) (自 C++17 起为 constexpr)
	(3)
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(/* 见下文 */)     -> 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 循环支持 (函数)
开始(std::filesystem::recursive_directory_iterator)结束(std::filesystem::recursive_directory_iterator)	基于范围的 for 循环支持 (函数)

类似于使用 swap（在 可交换 中描述），在通用上下文中 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 问题 2128。

如果 C 是一个浅层常量视图，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)	返回指示只读范围结束的哨兵 (定制点对象)