std::ranges::end

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

范围库 (Ranges library)

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

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

悬空迭代器处理 (Dangling iterator handling) dangling borrowed_iterator_t borrowed_subrange_t

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

视图
view_interface	subrange

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

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

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

范围适配器闭包对象 (Range adaptor closure objects) range_adaptor_closure (C++23)

范围适配器对象 (Range adaptor objects)

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

 

定义于头文件 <ranges>
定义于头文件 <iterator>
inline namespace /* 未指定 */ {     inline constexpr /* 未指定 */ end = /* 未指定 */; }		(C++20 起) (定制点对象)
调用签名 (Call signature)
template< class T >     requires /* 见下文 */ 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 表示一个自定义点对象，它是一个 const 函数对象，其类型为字面量 semiregular 类类型。为便于说明，其类型的不带 cv 限定符的版本表示为 __end_fn。

所有 __end_fn 实例都相等。在相同参数上调用不同 __end_fn 类型的实例的效果是等价的，无论表示实例的表达式是左值还是右值，以及是否是 const 限定的（但是，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 函数调用返回一个 prvalue，则返回值从具象的临时对象移动构造。所有实现都直接返回 prvalue。该要求已由 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++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
P2602R2	C++20	存在禁止某些通过 ADL 找到的非成员 end 的机制	移除了此类机制

参阅

ranges::cend (C++20)	返回一个表示只读范围末尾的哨兵 (自定义点对象)
ranges::begin (C++20)	返回指向范围开头的迭代器 (自定义点对象)
endcend (C++11)(C++14)	返回指向容器或数组末尾的迭代器 (函数模板)