Namespaces
Variants
Views
Actions

std::end

From cppreference.com
< cpp‎ | iterator
Revision as of 16:16, 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-sep"><td></td><td></td><td></td></tr>

<tr class="t-dcl ">

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

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

<tr class="t-dcl ">

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

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

<tr class="t-dcl ">

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

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

Returns an iterator to the end (i.e. the element after the last element) of the given container c or array array.

Contents

Parameters

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

Return value

an iterator to the end of c or array. Note that the end of a container or array is defined as the element following the last valid element.

Notes

In addition to being included in <iterator>, std::end 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::end may be provided for classes that do not expose a suitable end() member function, yet can be iterated. The following specializations are already provided by the standard library:

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

Example

#include <iostream>
#include <vector>
#include <iterator>
#include <algorithm>
 
int main() 
{
    std::vector<int> v = { 3, 1, 4 };
    if (std::find(std::begin(v), std::end(v), 5) != std::end(v)) {
        std::cout << "found a 5 in vector v!\n";
    }
 
    int a[] = { 5, 10, 15 };
    if (std::find(std::begin(a), std::end(a), 5) != std::end(a)) {
        std::cout << "found a 5 in array a!\n";
    }
}

Output:

found a 5 in array a!

See also

Template:cpp/iterator/dcl list begin