Namespaces
Variants

std::ranges::cbegin

ja.cppreference.net より
 
 
範囲ライブラリ
範囲アダプタ
 
ヘッダで定義 <ranges>
ヘッダで定義 <iterator>
inline namespace /* unspecified */ {
    inline constexpr /* unspecified */ cbegin = /* unspecified */;
}
(C++20 以降)
(カスタマイゼーションポイントオブジェクト)
呼び出しシグネチャ
template< class T >
    requires /* see below */
constexpr /* see below */ 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 の呼び出しは ill-formed であり、呼び出しがテンプレートのインスタンス化の直接の文脈に現れた場合、置換失敗を引き起こす可能性があります。

(C++23 以降)

戻り値の型は、すべての場合において std::input_or_output_iterator と constant-iterator(C++23 以降) をモデル化します。

カスタマイゼーションポイントオブジェクト

名前 ranges::cbegin は カスタマイゼーションポイントオブジェクト を表し、これは 関数オブジェクト のconst版で、 リテラル型 semiregular クラス型です。詳細は CustomizationPointObject を参照してください。

注記

lvalue範囲 e が型 T を持つ場合、 ranges :: 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)
コンテナまたは配列の先頭を指すイテレータを返す
(関数テンプレート)