W3cubDocs

/C++

std::ranges::cend

Defined in header <ranges>
inline namespace /* unspecified */ {
    inline constexpr /* unspecified */ cend = /* unspecified */;
}
(since C++20)
(customization point object)
Call signature
template< class T >
    requires /* see below */
constexpr std::sentinel_for<ranges::iterator_t<T>> auto cend( T&& t );
(since C++20)

Returns a sentinel indicating the end of a const-qualified range.

range-begin-end.svg

Let CT be.

  • const std::remove_reference_t<T>& if the argument is an lvalue (i.e. T is an lvalue reference type),
  • const T otherwise.

A call to ranges::cend is expression-equivalent to ranges::end(static_cast<CT&&>(t)).

If ranges::cend(e) is valid for an expression e, where decltype((e)) is T, then CT models std::ranges::range, and std::sentinel_for<S, I> is true in all cases, where S is decltype(ranges::cend(e)), and I is decltype(ranges::cbegin(e)).

Customization point objects

The name ranges::cend denotes a customization point object, which is a const function object of a literal semiregular class type. For exposition purposes, the cv-unqualified version of its type is denoted as __cend_fn.

All instances of __cend_fn are equal. The effects of invoking different instances of type __cend_fn on the same arguments are equivalent, regardless of whether the expression denoting the instance is an lvalue or rvalue, and is const-qualified or not (however, a volatile-qualified instance is not required to be invocable). Thus, ranges::cend can be copied freely and its copies can be used interchangeably.

Given a set of types Args..., if std::declval<Args>()... meet the requirements for arguments to ranges::cend above, __cend_fn models
.

Otherwise, no function call operator of __cend_fn participates in overload resolution.

Example

#include <algorithm>
#include <iostream>
#include <ranges>
#include <vector>
 
int main()
{
    std::vector<int> vec = {3, 1, 4};
    int arr[] = {5, 10, 15};
 
    std::cout << std::boolalpha
              << "vec contains 5: "
              << (std::ranges::find(vec, 5) != std::ranges::cend(vec)) << '\n'
              << "arr contains 5: "
              << (std::ranges::find(arr, 5) != std::ranges::cend(arr)) << '\n';
}

Output:

vec contains 5: false
arr contains 5: true

See also

(C++20)
returns a sentinel indicating the end of a range
(customization point object)
(C++11)(C++14)
returns an iterator to the end of a container or array
(function template)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/ranges/cend