std::begin, std::cbegin

template< class C > 
auto begin( C& c ) -> decltype(c.begin());

template< class C > 
auto begin( const C& c ) -> decltype(c.begin());

template< class T, std::size_t N > 
T* begin( T (&array)[N] );

template< class C > 
constexpr auto cbegin( const C& c ) noexcept(/* see below */)
    -> decltype(std::begin(c));

Возвращает итератор на начало заданного диапазона.

Параметры

Возвращаемое значение

Исключения

noexcept(noexcept(std::begin(c)))

Перегрузки

Для классов и перечислений, которые не предоставляют подходящую функцию-член begin(), но допускают итерацию, можно определить пользовательские перегрузки begin. Стандартная библиотека уже предоставляет следующие перегрузки:

Подобно использованию swap (описанному в Swappable), типичное использование функции begin в обобщённом контексте эквивалентно using std::begin; begin(arg);, что позволяет включить в один набор перегрузок как перегрузки, выбранные с помощью ADL для пользовательских типов, так и шаблоны функций стандартной библиотеки.

template<typename Container, typename Function>
void for_each(Container&& cont, Function f)
{
    using std::begin;
    auto it = begin(cont);
    using std::end;
    auto end_it = end(cont);
    while (it != end_it)
    {
        f(*it);
        ++it;
    }
}

Примечания

Перегрузки для не-массивов в точности отражают поведение C::begin. Их эффекты могут быть неожиданными, если функция-член реализована ненадлежащим образом.

std::cbegin введена для унификации доступа к диапазонам через функции-члены и не-члены. См. также задачу LWG 2128.

Если C является представлением с поверхностной константностью, std::cbegin может вернуть изменяемый итератор. Такое поведение может показаться неожиданным некоторым пользователям. См. также P2276 и P2278.

Пример

#include <iostream>
#include <iterator>
#include <vector>

int main() 
{
    std::vector<int> v = {3, 1, 4};
    auto vi = std::begin(v);
    std::cout << std::showpos << *vi << '\n'; 
    
    int a[] = {-5, 10, 15};
    auto ai = std::begin(a);
    std::cout << *ai << '\n';
}

+3
-5

См. также