std::end, std::cend
Defined in header <array>
|
||
Defined in header <deque>
|
||
Defined in header <flat_map>
|
||
Defined in header <flat_set>
|
||
Defined in header <forward_list>
|
||
Defined in header <inplace_vector>
|
||
Defined in header <iterator>
|
||
Defined in header <list>
|
||
Defined in header <map>
|
||
Defined in header <regex>
|
||
Defined in header <set>
|
||
Defined in header <span>
|
||
Defined in header <string>
|
||
Defined in header <string_view>
|
||
Defined in header <unordered_map>
|
||
Defined in header <unordered_set>
|
||
Defined in header <vector>
|
||
template
<
class C >
auto end( C& c ) - > decltype(c.end ( ) ) ; |
(1) | (since C++11) (constexpr since C++17) |
template
<
class C >
auto end( const C& c ) - > decltype(c.end ( ) ) ; |
(2) | (since C++11) (constexpr since C++17) |
template
<
class T, std::size_t N >
T* end( T ( &array) [N] ) ; |
(3) | (since C++11) (noexcept since C++14) (constexpr since C++14) |
template
<
class C >
constexpr
auto cend(
const C& c )
noexcept
(
/* see below */
)
|
(4) | (since C++14) |
Returns an iterator to the end (i.e. the element after the last element) of the given range.
Parameters
c | - | a container or view with an end member function
|
array | - | an array of arbitrary type |
Return value
Exceptions
Overloads
Custom overloads of end
may be provided for classes and enumerations that do not expose a suitable end()
member function, yet can be iterated. The following overloads are already provided by the standard library:
(C++11)
|
specializes std::end (function template) |
(C++11)
|
specializes std::end (function template) |
range-based for loop support (function) |
|
range-based for loop support (function) |
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
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); for (; it != end_it; ++it) f(*it); }
Overloads of |
(since C++20) |
Notes
The non-array overloads exactly reflect the behavior of C::end()
std::cend
is introduced for unification of member and non-member range accesses. See also LWG issue 2128.
If C
is a shallow-const view, std::cend
may return a mutable iterator. Such behavior is unexpected for some users. See also P2276 and P2278
Example
#include <algorithm> #include <iostream> #include <vector> 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 w[] = {5, 10, 15}; if (std::find(std::begin(w), std::end(w), 5) != std::end(w)) std::cout << "Found a 5 in array w!\n"; }
Output:
Found a 5 in array w!
See also
(C++11)(C++14)
|
returns an iterator to the beginning of a container or array (function template) |
(C++20)
|
returns a sentinel indicating the end of a range (customization point object) |
(C++20)
|
returns a sentinel indicating the end of a read-only range (customization point object) |