Namespaces
Variants
Views
Actions

std::begin

From cppreference.com
< cpp‎ | iterator
Revision as of 15:18, 2 November 2012 by P12bot (Talk | contribs)

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <iterator>
</td>

<td></td> <td></td> <tr class="t-dcl ">

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

<td > (1) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

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

<td > (2) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

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

<td > (3) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

Returns an iterator to the beginning of the given container c or array array.

Contents

Parameters

c - a container with a begin method
array - an array of arbitrary type

Return value

an iterator to the beginning of c or array

Notes

In addition to being included in <iterator>, std::begin is guaranteed to become available if any of the following headers are included: <array>, <deque>, <forward_list>, <list>, <map>, <regex>, <set>, <string>, <unordered_map>, <unordered_set>, and <vector>.

Specializations

Custom specializations of std::begin may be provided for classes that do not expose a suitable begin() member function, yet can be iterated. The following specializations are already provided by the standard library:

Template:cpp/numeric/valarray/dcl list begin2
specializes std::begin
(function template) [edit]

Example

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

Output:

3
-5

See also

Template:cpp/iterator/dcl list end