std::reference_wrapper

来自cppreference.com
< cpp‎ | utility‎ | functional
 
C++
 
工具库
语言支持
类型支持（基本类型、RTTI）
库功能特性测试宏 (C++20)
动态内存管理
程序工具
协程支持 (C++20)
变参数函数
(C++20)
(C++26)
(C++11)
(C++20)
调试支持
(C++26)
(C++26)
(C++26)
三路比较
(C++20)(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)   
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
通用工具
日期和时间
函数对象
格式化库 (C++20)
(C++11)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)   
(C++20)
交换与类型运算
(C++20)
(C++14)
(C++11)
(C++23)
(C++11)
(C++23)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++11)
(C++17)
(C++17)
(C++23)
初等字符串转换
(C++17)
(C++17)
(C++17)

 
函数对象
函数调用
(C++17)(C++23)
恒等函数对象
(C++20)
引用包装器
reference_wrapper
(C++11)
(C++11)(C++11)
(C++20)(C++20)
通透运算符包装器
(C++14)
(C++14)
(C++14)
(C++14)  
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)

旧式绑定器与适配器
(C++17 前*)
(C++17 前*)
(C++17 前*)
(C++17 前*)
(C++17 前*)  
(C++17 前*)
(C++17 前*)(C++17 前*)(C++17 前*)(C++17 前*)
(C++20 前*)
(C++20 前*)
(C++17 前*)(C++17 前*)
(C++17 前*)(C++17 前*)

(C++17 前*)
(C++17 前*)(C++17 前*)(C++17 前*)(C++17 前*)
(C++20 前*)
(C++20 前*)
 
std::reference_wrapper
 
在标头 <functional> 定义
template< class T >
class reference_wrapper;
 (C++11 起)

std::reference_wrapper 是一种把引用包装到可复制、可赋值对象的类模板。

明确地说，std::reference_wrapper 是围绕到 T 类型的对象引用或函数引用的可复制构造 (CopyConstructible) 且可复制赋值 (CopyAssignable) 的包装器。std::reference_wrapper 的实例是对象（它们可被复制或存储于容器），但它们能隐式转换成 T&，故能将它用作按引用接收底层类型的函数的实参。

若存储的引用可调用 (Callable) ，则可以相同实参调用 std::reference_wrapper。

辅助函数 std::ref 与 std::cref 常用于生成 std::reference_wrapper 对象。

std::reference_wrapper 亦用于按引用传递对象给 std::bind，std::thread 的构造函数，或辅助函数 std::make_pair 与 std::make_tuple。它还可以作为在通常无法持有引用的标准容器（如 std::vector）中存储引用的机制。

保证 std::reference_wrapper 为可平凡复制 (TriviallyCopyable) 。

(C++17 起)

T 可为不完整类型。

(C++20 起)

成员类型

类型 定义
type T
result_type(C++17 中弃用)(C++20 中移除) 若 T 为函数则为 T 的返回类型。否则不定义。
argument_type(C++17 中弃用)(C++20 中移除)
  • 若 T 为接受一个 A1 类型实参的函数或函数指针，则 argument_type 为 A1
  • 若 T 是不接收实参的指向类 T0 成员函数的指针，则 argument_type 为 T0*，可能有 cv 限定
  • 若 T 是拥有成员类型 T::argument_type 的类类型，则 argument_type 为其别名
first_argument_type
(C++17 中弃用)(C++20 中移除)
  • 若 T 是接收两个 A1 与 A2 类型实参的函数或函数指针，则 first_argument_type 为 A1
  • 若 T 是接收一个实参的指向类 T0 的成员函数的指针，则 first_argument_type 为 T0*，可能有 cv 限定
  • 若 T 是拥有成员类型 T::first_argument_type 的类类型，则 first_argument_type 为其别名
second_argument_type
(C++17 中弃用)(C++20 中移除)
  • 若 T 是接收两个 A1 与 A2 类型实参的函数或函数指针，则 second_argument_type 为 A2
  • 若 T 是接收一个 A1 类型实参的指向类 T0 成员函数的指针，则 second_argument_type 为 A1，可有 cv 限定
  • 若 T 是拥有成员类型 T::second_argument_type 的类类型，则 second_argument_type 为其别名

成员函数

 存储引用于新的 std::reference_wrapper 对象
(公开成员函数)
重绑定 std::reference_wrapper
(公开成员函数)
访问存储的引用
(公开成员函数)
调用其所存储的函数
(公开成员函数)

非成员函数

(C++26)
 依据所存储的引用比较 reference_wrapper 对象
(函数)

推导指引(C++17 起)

辅助类

(C++23)
 确定 reference_wrapper 和非 reference_wrapper 的公共引用类型
(类模板特化)

可能的实现

namespace detail
{
    template<class T> constexpr T& FUN(T& t) noexcept { return t; }
    template<class T> void FUN(T&&) = delete;
}
 
template<class T>
class reference_wrapper
{
public:
    // 类型
    using type = T;
 
    // construct/copy/destroy
    template<class U, class = decltype(
        detail::FUN<T>(std::declval<U>()),
        std::enable_if_t<!std::is_same_v<reference_wrapper, std::remove_cvref_t<U>>>()
    )>
    constexpr reference_wrapper(U&& u)
        noexcept(noexcept(detail::FUN<T>(std::forward<U>(u))))
        : _ptr(std::addressof(detail::FUN<T>(std::forward<U>(u)))) {}
 
    reference_wrapper(const reference_wrapper&) noexcept = default;
 
    // 赋值
    reference_wrapper& operator=(const reference_wrapper& x) noexcept = default;
 
    // 访问
    constexpr operator T& () const noexcept { return *_ptr; }
    constexpr T& get() const noexcept { return *_ptr; }
 
    template<class... ArgTypes>
    constexpr std::invoke_result_t<T&, ArgTypes...>
        operator() (ArgTypes&&... args ) const
            noexcept(std::is_nothrow_invocable_v<T&, ArgTypes...>)
    {
        return std::invoke(get(), std::forward<ArgTypes>(args)...);
    }
 
private:
    T* _ptr;
};
 
// 推导指引
template<class T>
reference_wrapper(T&) -> reference_wrapper<T>;

示例

演示将 std::reference_wrapper 作为引用的容器使用，这令使用多重索引访问同一容器称为可能。

运行此代码
#include <algorithm>
#include <functional>
#include <iostream>
#include <list>
#include <numeric>
#include <random>
#include <vector>
 
void println(auto const rem, std::ranges::range auto const& v)
{
    for (std::cout << rem; auto const& e : v)
        std::cout << e << ' ';
    std::cout << '\n';
}
 
int main()
{
    std::list<int> l(10);
    std::iota(l.begin(), l.end(), -4);
 
    // 不能在 list 上用 shuffle（要求随机访问），但能在 vector 上使用它
    std::vector<std::reference_wrapper<int>> v(l.begin(), l.end());
 
    std::ranges::shuffle(v, std::mt19937{std::random_device{}()});
 
    println("list 的内容: ", l);
    println("list 的内容，通过经混洗的 vector 所见: ", v);
 
    std::cout << "倍增初始化式列表中的值...\n";
    std::ranges::for_each(l, [](int& i) { i *= 2; });
 
    println("list 的内容，通过经混洗的 vector 所见: ", v);
}

可能的输出： 

list 的内容: -4 -3 -2 -1 0 1 2 3 4 5
list 的内容，通过经混洗的 vector 所见: -1 2 -2 1 5 0 3 -3 -4 4
倍增初始化式列表中的值...
list 的内容，通过经混洗的 vector 所见: -2 4 -4 2 10 0 6 -6 -8 8

参阅

(C++11)(C++11)
 创建具有从其实参推导的类型的 std::reference_wrapper
(函数模板)
(C++11)
 绑定一或多个实参到函数对象
(函数模板)
(C++20)(C++20)
 获取包装于 std::reference_wrapper 的引用类型
(类模板)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/utility/functional/reference_wrapper&oldid=92547”