std::end, std::cend

来自cppreference.com
< cpp‎ | iterator
 
 
迭代器库
迭代器概念
迭代器原语
算法概念与工具
间接可调用概念
常用算法要求
(C++20)
(C++20)
(C++20)
工具
(C++20)
迭代器适配器
范围访问
(C++11)(C++14)
(C++14)(C++14)  
endcend
(C++11)(C++14)
(C++14)(C++14)  
(C++17)(C++20)
(C++17)
(C++17)
 
在标头 <array> 定义
在标头 <deque> 定义
在标头 <flat_map> 定义
在标头 <flat_set> 定义
在标头 <forward_list> 定义
在标头 <inplace_vector> 定义
在标头 <iterator> 定义
在标头 <list> 定义
在标头 <map> 定义
在标头 <regex> 定义
在标头 <set> 定义
在标头 <span> 定义
在标头 <string> 定义
在标头 <string_view> 定义
在标头 <unordered_map> 定义
在标头 <unordered_set> 定义
在标头 <vector> 定义
template< class C >
auto end( C& c ) -> decltype(c.end());
(1) (C++11 起)
(C++17 起为 constexpr)
template< class C >
auto end( const C& c ) -> decltype(c.end());
(2) (C++11 起)
(C++17 起为 constexpr)
(3)
template< class T, std::size_t N >
T* end( T (&array)[N] );
(C++11 起)
(C++14 前)
template< class T, std::size_t N >
constexpr T* end( T (&array)[N] ) noexcept;
(C++14 起)
template< class C >

constexpr auto cend( const C& c ) noexcept(/* 见下文 */)

    -> decltype(std::end(c));
(4) (C++14 起)

返回指向给定范围结尾(即最末元素的后一元素)的迭代器。

1,2) 返回 c.end(),通常是指向 c 所代表的序列末尾后一位置的迭代器。
1) 如果 C 是标准容器 (Container) ,那么就会返回 C::iterator 对象。
2) 如果 C 是标准容器 (Container) ,那么就会返回 C::const_iterator 对象。
3) 返回指向 array 末尾的指针。
4) 返回 std::end(c),这里 c 始终当做 const 限定。
如果 C 是标准容器 (Container) ,那么就会返回 C::const_iterator 对象。

range-begin-end.svg

参数

c - 拥有 end 成员函数的容器或视图
array - 任意类型的数组

返回值

1,2) c.end()
3) array + N
4) c.end()

异常

4)
noexcept 说明:  
noexcept(noexcept(std::end(c)))

重载

可为不暴露适合的 end() 成员函数的类或枚举提供 end 的自定义重载。标准库已提供了下列重载:

特化 std::end
(函数模板)
特化的 std::end
(函数模板)
基于范围的 for 循环支持
(函数)
基于范围的 for 循环支持
(函数)

类似 swap 的用法(于可交换 (Swappable) 描述),end 函数在泛型语境中的典型用法等价于 using std::end; end(arg);,这允许实参依赖查找为用户定义类型所选择的重载,和标准库函数模板在同一重载集中出现。

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

实参依赖查找找到的 end 重载能用于定制 std::ranges::endstd::ranges::cend 及其他依赖于 std::ranges::end 的定制点对象的行为。

(C++20 起)

注解

非数组重载准确地反映 C::end() 的行为。如果该成员函数的实现不合理,那么就会有意外的效果。

std::cend 是为统一成员与非成员范围访问引入的。参阅 LWG 问题 2128

如果 C 是浅 const 的视图,那么 std::cend 可能返回可变的迭代器。某些用户不期待这种行为。参阅 P2276P2278

示例

#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 << "在 vector v 中找到 5!\n";
 
    int w[] = {5, 10, 15};
    if (std::find(std::begin(w), std::end(w), 5) != std::end(w))
        std::cout << "在数组 w 中找到 5!\n";
}

输出:

在数组 w 中找到 5!

参阅

(C++11)(C++14)
返回指向容器或数组起始的迭代器
(函数模板)
返回指示范围结尾的哨位
(定制点对象)
返回指示只读范围结尾的哨位
(定制点对象)