std::ranges::cbegin

来自cppreference.com
< cpp‎ | ranges
 
 
范围库
范围适配器
 
在标头 <ranges> 定义
在标头 <iterator> 定义
inline namespace /* 未指明 */ {

    inline constexpr /* 未指明 */ cbegin = /* 未指明 */;

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

    requires /* 见下文 */

constexpr /* 见下文 */ auto cbegin( T&& t );
(C++20 起)

返回指向 const 限定的实参的首元素的迭代器。

(C++23 前)

返回指向实参的首元素的常量迭代器。

(C++23 起)

range-begin-end.svg

CT

  • 若实参为左值(即 T 为左值引用类型)则为 const std::remove_reference_t<T>&
  • 否则为 const T

ranges::cbegin 的调用表达式等价ranges::begin(static_cast<CT&&>(t))

(C++23 前)

若实参为左值或者 ranges::enable_borrowed_range<std::remove_cv_t<T>>true,则对 ranges::cbegin 的调用表达式等价于:

所有其他情况下,对 ranges::cbegin 的调用都非良构,这会在调用出现于模板实例化的立即语境中时导致代换失败

(C++23 起)

所有情况下,返回类型都实现 std::input_or_output_iteratorconstant-iterator (C++23 起)

定制点对象

名字 ranges::cbegin 代表一个定制点对象,它是某个字面 semiregular 类类型的 const 函数对象。为阐述目的,以 __cbegin_fn 表示它的类型的 cv 无限定版本。

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

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

否则,__cbegin_fn 的函数调用运算符不会参与重载决议。

注解

对于 T 类型的左值范围 eranges::cbegin(e) 等价于

ranges::begin(std::as_const(e))

(C++23 前)
(C++23 起)

示例

#include <cassert>
#include <ranges>
#include <vector>
 
int main() 
{
    std::vector v{3, 1, 4};
    auto vi = std::ranges::cbegin(v);
    assert(3 == *vi);
    ++vi; // OK,可以改动常量迭代器对象
    assert(1 == *vi);
    // *vi = 13; // 错误:常量迭代器指向不可改动元素
 
    int a[]{3, 1, 4};
    auto ai = std::ranges::cbegin(a); // cbegin 也可以对 C 数组
    assert(3 == *ai and *(ai + 1) == 1);
    // *ai = 13; // 错误:只读变量不可赋值
}

参阅

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