std::end

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Iterator library

Iterator primitives
iterator_traits
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tag
iterator
Iterator adaptors
reverse_iterator move_iterator (C++11) back_insert_iterator front_insert_iterator insert_iterator	make_reverse_iterator (C++14) make_move_iterator (C++11) back_inserter front_inserter inserter
Stream iterators
istream_iterator
ostream_iterator
istreambuf_iterator
ostreambuf_iterator
Iterator operations
advance
distance
prev (C++11)
next (C++11)
Range access
begincbegin (C++11)(C++14)
endcend (C++11)(C++14)
rbegincrbegin (C++14)(C++14)
rendcrend (C++14)(C++14)

 

Defined in header <iterator>
template< class C > auto end( C& c ) -> decltype(c.end());	(1)	(since C++11)
template< class C > auto end( const C& c ) -> decltype(c.end());	(1)	(since C++11)
	(2)
template< class T, size_t N > T* end( T (&array)[N] );			(since C++11) (until C++14)
template< class T, size_t N > constexpr T* end( T (&array)[N] );			(since C++14)
template< class C > constexpr auto cend( const C& c ) -> decltype(std::end(c));		(3)	(since C++14)

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

1) Returns a possibly const-qualified iterator to the end of the container c.

2) Returns a pointer to the end of the array array.

3) Returns a const-qualified iterator to the end of the container c.

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.

Exceptions

2)

noexcept specification:  

noexcept

  

(since C++14)

3)

noexcept specification:  

noexcept(noexcept(std::end(c)))

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>.

User-defined overloads

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

std::end(std::initializer_list) (C++11)	specializes std::end (function template)
std::end(std::valarray) (C++11)	specializes std::end (function template)

Similar to the use of swap (described in Swappable), typical use of the end function in generic context is an equivalent of using std::end; end(arg);, which lets both the ADL-selected overloads for user-defined types and the standard library function templates to appear in the same overload set.

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;
    }
}

Example

Run this code

#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

begincbegin (C++11)(C++14)

returns an iterator to the beginning of a container or array (function)