std::reference_wrapper

来自cppreference.com
< cpp‎ | utility‎ | functional
 
 
 
函数对象
函数包装
(C++11)
(C++11)
(C++17)
绑定
(C++11)
引用包装
reference_wrapper
(C++11)
(C++11)
(C++11)
运算符包装
取反器
(过时)
(过时)

(过时)
查找器
旧绑定器与适配器
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)

(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
 
 
定义于头文件 <functional>
template< class T >
class reference_wrapper;
(C++11 起)

std::reference_wrapper 是包装引用于可复制、可赋值对象的类模板。它常用作将容器存储入无法正常保有引用的标准容器(类似 std::vector )的机制。

特别是, std::reference_wrapper 是围绕到类型 T 的对象引用或函数引用的可复制构造 (CopyConstructible) 且可复制赋值 (CopyAssignable) 的包装器。 std::reference_wrapper 的实例是对象(它们可被复制或存储于容器),但它们能隐式转换成 T& ,故它们能用做以引用接收底层类型的函数的参数。

帮助函数 std::refstd::cref 常用于生成 std::reference_wrapper 对象。

std::reference_wrapper 亦用于按引用传递对象给 std::bindstd::thread 的构造函数。

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

(C++17 起)

目录

[编辑] 成员类型

类型 定义
type T
result_type(C++17 中过时) T 为函数则为 T 的返回类型。否则不定义。
argument_type(C++17 中过时) 1) 若 T 为接受一个 A1 类型参数的函数或指向函数指针,则 argument_typeA1

2) 若 T 是不接收参数的指向类 T0 成员函数的指针,则 argument_typeT0* ,可能有 cv 限定
3) 若 T 是拥有成员类型 T::argument_type 的类类型,则 argument_type 为其别名

first_argument_type(C++17 中过时) 1) 若 T 是接收二个 A1A2 类型参数的函数或指向函数指针,则 first_argument_typeA1

2) 若 T 是接收一个参数的指向 T0 成员函数指针,则 first_argument_typeT0* ,可能有 cv 限定
3) 若 T 是拥有成员类型 T::first_argument_type 的类类型,则 first_argument_type 为其别名

second_argument_type(C++17 中过时) 1) 若 T 是接收二个 A1A2 类型参数的函数或指向函数指针,则 second_argument_typeA2

2) 若 T 是接收一个 A1 类型参数的指向 T0 成员函数指针,则 second_argument_typeA1 ,可有 cv 限定
3) 若 T 是拥有成员类型 T::second_argument_type 的类类型,则 second_argument_type 为其别名

[编辑] 成员函数

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

[编辑] 推导指引(C++17 起)

[编辑] 可能的实现

template <class T>
class reference_wrapper {
public:
  // 类型
  typedef T type;
 
  // 构造/复制/销毁
  reference_wrapper(T& ref) noexcept : _ptr(std::addressof(ref)) {}
  reference_wrapper(T&&) = delete;
  reference_wrapper(const reference_wrapper&) noexcept = default;
 
  // 赋值
  reference_wrapper& operator=(const reference_wrapper& x) noexcept = default;
 
  // 访问
  operator T& () const noexcept { return *_ptr; }
  T& get() const noexcept { return *_ptr; }
 
  template< class... ArgTypes >
  typename std::result_of<T&(ArgTypes&&...)>::type
    operator() ( ArgTypes&&... args ) const {
    return std::invoke(get(), std::forward<ArgTypes>(args)...);
  }
 
private:
  T* _ptr;
};

[编辑] 示例

演示将 reference_wrapper 作为引用的容器使用,这令用多重下标访问同一容器可行

#include <algorithm>
#include <list>
#include <vector>
#include <iostream>
#include <numeric>
#include <random>
#include <functional>
 
int main()
{
    std::list<int> l(10);
    std::iota(l.begin(), l.end(), -4);
 
    std::vector<std::reference_wrapper<int>> v(l.begin(), l.end());
    // can't use shuffle on a list (requires random access), but can use it on a vector
    std::shuffle(v.begin(), v.end(), std::mt19937{std::random_device{}()});
 
    std::cout << "Contents of the list: ";
    for (int n : l) std::cout << n << ' '; std::cout << '\n';
 
    std::cout << "Contents of the list, as seen through a shuffled vector: ";
    for (int i : v) std::cout << i << ' '; std::cout << '\n';
 
    std::cout << "Doubling the values in the initial list...\n";
    for (int& i : l) {
        i *= 2;
    }
 
    std::cout << "Contents of the list, as seen through a shuffled vector: ";
    for (int i : v) std::cout << i << ' '; std::cout << '\n';
}

可能的输出:

Contents of the list: -4 -3 -2 -1 0 1 2 3 4 5 
Contents of the list, as seen through a shuffled vector: -1 2 -2 1 5 0 3 -3 -4 4 
Doubling the values in the initial list...
Contents of the list, as seen through a shuffled vector: -2 4 -4 2 10 0 6 -6 -8 8

[编辑] 参阅

(C++11)
(C++11)
创建类型从参数可推导的std::reference_wrapper
(函数模板) [编辑]
(C++11)
绑定一或多个参数到函数对象
(函数模板) [编辑]