std::ranges::cbegin

 

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 /* unspecified */ {     inline constexpr /* unspecified */ cbegin = /* unspecified */; }		(C++20 起) (定制点对象)
调用签名 (Call signature)
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(possibly-const-range(t) 的某个表达式。 在所有其他情况下，调用 ranges::cbegin 是病态的，这可能导致当调用出现在模板实例化的直接语境中时发生替换失败。	(C++23 起)

在所有情况下，返回类型都满足 std::input_or_output_iterator 和 constant-iterator(C++23 起)。

自定义点对象

名称 ranges::cbegin 表示一个定制点对象，它是一个 字面类型 semiregular 类类型的 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)	返回指向容器或数组开头的迭代器 (函数模板)