std::begin, std::cbegin
| Определён в заголовке <array>
|
||
| Определён в заголовке <deque>
|
||
| Определён в заголовке <flat_map>
|
(начиная с C++23) |
|
| Определён в заголовке <flat_set>
|
(начиная с C++23) |
|
| Определён в заголовке <forward_list>
|
||
| Определён в заголовке <inplace_vector>
|
(начиная с C++26) |
|
| Определён в заголовке <iterator>
|
||
| Определён в заголовке <list>
|
||
| Определён в заголовке <map>
|
||
| Определён в заголовке <optional>
|
(начиная с C++26) |
|
| Определён в заголовке <regex>
|
||
| Определён в заголовке <set>
|
||
| Определён в заголовке <span>
|
(начиная с C++20) |
|
| Определён в заголовке <stacktrace>
|
(начиная с C++23) |
|
| Определён в заголовке <string>
|
||
| Определён в заголовке <string_view>
|
(начиная с C++17) |
|
| Определён в заголовке <unordered_map>
|
||
| Определён в заголовке <unordered_set>
|
||
| Определён в заголовке <valarray>
|
||
| Определён в заголовке <vector>
|
||
template< class C >
auto begin( C& c ) -> decltype(c.begin());
|
(1) | (начиная с C++11) (constexpr начиная с C++17) |
template< class C >
auto begin( const C& c ) -> decltype(c.begin());
|
(2) | (начиная с C++11) (constexpr начиная с C++17) |
template< class T, std::size_t N >
T* begin( T (&array)[N] );
|
(3) | (начиная с C++11) (noexcept начиная с C++14) (constexpr начиная с C++14) |
template< class C >
constexpr auto cbegin( const C& c ) noexcept(/* see below */)
-> decltype(std::begin(c));
|
(4) | (начиная с C++14) |
Возвращает итератор на начало заданного диапазона.
c.begin(), который обычно является итератором на начало последовательности, представленной c.array.std::begin(c), при этом c всегда рассматривается как const-квалифицированный.
Параметры
| c | - |
контейнер или представление с функцией-членом
begin
|
| array | - | массив произвольного типа |
Возвращаемое значение
Исключения
Перегрузки
Пользовательские перегрузки
begin
могут быть предоставлены для классов и перечислений, которые не предоставляют подходящую функцию-член
begin()
, но по которым можно выполнять итерацию. Следующие перегрузки уже предоставлены стандартной библиотекой:
|
перегружает
std::begin
(шаблон функции) |
|
|
(C++11)
|
перегружает
std::begin
(шаблон функции) |
|
поддержка range-based for loop
(функция) |
|
|
поддержка range-based for loop
(функция) |
Подобно использованию
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++20) |
Примечания
Перегрузки для не-массивов точно отражают поведение
C::begin
. Их эффекты могут быть неожиданными, если функция-член не имеет разумной реализации.
std::cbegin
введен для унификации доступа к диапазонам через члены и нечлены. См. также
LWG issue 2128
.
Если
C
является shallow-const представлением,
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
Смотрите также
|
(C++11)
(C++14)
|
возвращает итератор на конец контейнера или массива
(шаблон функции) |
|
(C++20)
|
возвращает итератор на начало диапазона
(объект точки кастомизации) |
|
(C++20)
|
возвращает итератор на начало диапазона только для чтения
(объект точки кастомизации) |