std::ranges::end

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

命名要求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

范围库

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata empty

范围转换 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

悬垂迭代器处理 dangling borrowed_iterator_t borrowed_subrange_t

范围原语
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 borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	constant_range (C++23)

视图
view_interface	subrange

范围工厂
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

范围适配器
views::all_tviews::all ref_view owning_view as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while concat_viewviews::concat (C++26)(C++26)	drop_viewviews::drop drop_while_viewviews::drop_while join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   lazy_split_viewviews::lazy_split split_viewviews::split views::counted common_viewviews::common	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)

范围生成器 std::generator (C++23)

范围适配器闭包对象 range_adaptor_closure (C++23)

范围适配器对象

辅助项
copyable-box movable-box (直到 C++23)  (C++23)	simple-view non-propagating-cache

 

在头文件 <ranges> 中定义
在头文件 <iterator> 中定义
inline namespace /* unspecified */ {     inline constexpr /* unspecified */ end = /* unspecified */; }		(自 C++20 起) (自定义点对象)
调用签名
template< class T >     requires /* see below */ 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 类类型。为了说明目的，其类型的 cv 无限定版本表示为 __end_fn。

所有 __end_fn 实例都是相等的。无论表达式表示的实例是左值还是右值，以及是否为 const 限定，调用相同参数上的不同 __end_fn 类型实例的效果都是等效的（但是，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)))在所有情况下都符合std::sentinel_for，而T符合std::ranges::range。

C++20 标准要求，如果底层end函数调用返回一个右值，则返回值将从物化的临时对象移动构造。所有实现都直接返回右值。该要求由 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)	返回一个表示只读范围结束的哨兵 (定制点对象)
ranges::begin (C++20)	返回指向范围开头的迭代器 (定制点对象)
endcend (C++11)(C++14)	返回指向容器或数组末尾的迭代器 (函数模板)