public member function
<array>
std::array::begin
iterator begin() noexcept;const_iterator begin() const noexcept;
Return iterator to beginning
Returns an iterator pointing to the first element in the array container.
Notice that, unlike member array::front, which returns a reference to the first element, this function returns a random access iterator pointing to it.
In zero-sized arrays, this function returns the same as array::end, but the returned iterator should not be dereferenced.
Return Value
An iterator to the beginning of the sequence.
If the array object is const-qualified, the function returns a const_iterator. Otherwise, it returns an iterator.
Member types iterator and const_iterator are random access iterator types (pointing to an element and to a const element, respectively).
Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
// array::begin 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.begin(); it != myarray.end(); ++it )
std::cout << ' ' << *it;
std::cout << '\n';
return 0;
}
|
Output:
myarray contains: 2 16 77 34 50
|
Iterator validity
No changes.
Data races
No contained elements are accessed by the call, but the iterator returned can be used to access or modify elements. 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.
See also
- array::cbegin
- Return const_iterator to beginning (public member function)
- array::front
- Access first element (public member function)
- array::end
- Return iterator to end (public member function)
- array::rbegin
- Return reverse iterator to reverse beginning (public member function)
- array::rend
- Return reverse iterator to reverse end (public member function)