std::ranges::end

来自cppreference.com
< cpp‎ | ranges
 
 
范围库
范围访问
范围转换器
(C++23)
范围原语



悬垂迭代器处理
范围概念
视图

范围工厂
适配器
范围生成器
范围适配器对象
范围适配器闭包对象
辅助项
 
在标头 <ranges> 定义
inline namespace /* 未指定 */ {

    inline constexpr /* 未指定 */ end = /* 未指定 */;

}
(C++20 起)
(定制点对象)
调用签名
template< class T >

    requires /* 见下文 */

constexpr std::sentinel_for<ranges::iterator_t<T>> auto end( T&& t );
(C++20 起)

返回指示范围末尾的哨位。

range-begin-end.svg

如果实参是左值,或者 ranges::enable_borrowed_range<std::remove_cv_t<T>>true,那么调用 ranges::end 表达式等价于:

  1. t + std::extent_v<T>,如果 t 具有已知边界数组类型。
  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 声明
    • void end(auto&) = delete;
    • void end(const auto&) = delete;

所有其他情况下,调用 ranges::end 非良构,这能在 ranges::end 的调用在模板实例化的立即语境出现时导致替换失败

定制点对象

名字 ranges::end 代表一个定制点对象,它是字面 semiregular 类类型的 const 函数对象。为说明目的,以 __end_fn 表示它的类型的 cv 无限定版本。

__end_fn 的所有实例均相等。在相同参数上调用类型 __end_fn 的不同实例的效果是等价的,与指代该实例的表达式是左值还是右值,以及是否为 const 限定无关(然而不要求 volatile 限定的实例可调用)。从而能自由地复制 ranges::end 并且能彼此替代地使用它的副本。

给定类型集合 Args...,如果 std::declval<Args>()... 满足上面对于 ranges::end 的参数要求,那么 __end_fn 实现

否则,__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> v{3, 1, 4};
    if (std::ranges::find(v, 5) != std::ranges::end(v))
        std::cout << "在 vector v 中找到了 5!\n";
 
    int a[]{5, 10, 15};
    if (std::ranges::find(a, 5) != std::ranges::end(a))
        std::cout << "在数组 a 中找到了 5!\n";
}

输出:

在数组 a 中找到了 5!

参阅

返回指示只读范围结尾的哨位
(定制点对象)
返回指向范围起始的迭代器
(定制点对象)
(C++11)(C++14)
返回指向容器或数组结尾的迭代器
(函数模板)