std::array::cbegin

const_iterator cbegin() const noexcept;

Return const_iterator to beginning

Returns a const_iterator pointing to the first element in the array container.

const_iterator is an iterator that points to const content. This iterator can be increased and decreased (unless it is itself also const), just like the iterator returned by array::begin, but it cannot be used to modify the contents it points to, even if the array object is not itself const.

Parameters

none

Return Value

A const_iterator to the beginning of the sequence.

Member type

const_iterator is a random access iterator type that points to a const element.

Example

// array::cbegin example
#include <iostream>
#include <array>

int main ()
{
  std::array<int,5> myarray = { 2, 16, 77, 34, 50 };

  std::cout << "myarray contains:";

  for ( auto it = myarray.cbegin(); it != myarray.cend(); ++it )
    std::cout << ' ' << *it;   // cannot modify *it

  std::cout << '\n';

  return 0;
}

Output:

myarray contains: 2 16 77 34 50

Complexity

Constant.

Iterator validity

No changes.

Data races

No contained elements are accessed by the call, but the iterator returned can be used to access them. Concurrently accessing or modifying different elements is safe.

Exception safety

No-throw guarantee: this member function never throws exceptions.
The copy construction or assignment of the returned iterator is also guaranteed to never throw.