std::ranges::cbegin

 

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)

悬空迭代器处理 悬空 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 /* 未指定 */ {     inline constexpr /* 未指定 */ cbegin = /* 未指定 */; }		(自 C++20 起) (自定义点对象)
调用签名
template< class T >     requires /* 见下文 */ constexpr /* 见下文 */ auto cbegin( T&& t );		(自 C++20 起)

返回指向 const 限定参数的第一个元素的迭代器。	(直到 C++23)
返回指向参数的第一个元素的常量迭代器。	(自 C++23 起)

令 CT 为 const std::remove_reference_t<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 的调用与 std::const_iterator<decltype(U)>(U) 对于某些表达式 U 等效于 ranges::begin(/* 可能为 const 范围 */(t)) 表达式等效。 在所有其他情况下，对 ranges::cbegin 的调用都是非法的，这可能导致当调用出现在模板实例化的直接上下文中时发生 替换失败。	(自 C++23 起)

返回值类型在所有情况下都建模 std::input_or_output_iterator 和 常量迭代器(自 C++23 起)。

自定义点对象

名称 ranges::cbegin 表示一个自定义点对象，它是一个 const 函数对象，其类型为 字面量 半正则 类类型。为了说明目的，其类型的 cv 无限定版本表示为 __cbegin_fn。

所有 __cbegin_fn 实例都相等。调用类型为 __cbegin_fn 的不同实例对相同参数的效果是等效的，无论表示该实例的表达式是左值还是右值，以及是否具有 const 限定符（但是，不强制要求调用 volatile 限定的实例）。因此，可以自由地复制 ranges::cbegin，并且可以互换地使用其副本。

给定一组类型 Args...，如果 std::declval<Args>()... 满足上述 ranges::cbegin 参数的要求，__cbegin_fn 建模

• std::invocable<__cbegin_fn, Args...>,
• std::invocable<const __cbegin_fn, Args...>,
• std::invocable<__cbegin_fn&, Args...>，以及
• std::invocable<const __cbegin_fn&, Args...>.
  

否则，__cbegin_fn 的任何函数调用运算符都不会参与重载解析。

注释

对于类型为 T 的左值范围 e，ranges::cbegin(e) 等效于

ranges::begin(std::as_const(e)).	(直到 C++23)
ranges::begin(e) 如果 T 模型 constant_range. 否则，ranges::begin(std::as_const(e)) 如果 const T 模型 constant_range. 否则，std::basic_const_iterator(ranges::begin(e)).	(自 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, constant-iterator object is mutable
    assert(1 == *vi);
    // *vi = 13; // Error: constant-iterator points to an immutable element
 
    int a[]{3, 1, 4};
    auto ai = std::ranges::cbegin(a); // cbegin works with C-arrays as well
    assert(3 == *ai and *(ai + 1) == 1);
    // *ai = 13; // Error: read-only variable is not assignable
}

另请参阅

ranges::begin (C++20)	返回指向范围开头的迭代器 (定制点对象)
begincbegin (C++11)(C++14)	返回指向容器或数组开头的迭代器 (函数模板)