Namespaces
Variants
Views
Actions

std::ref, std::cref

From cppreference.com
< cpp‎ | utility‎ | functional
 
 
Utilities library
Language support
Type support (basic types, RTTI)
Library feature-test macros (C++20)
Dynamic memory management
Program utilities
Coroutine support (C++20)
Variadic functions
Debugging support
(C++26)
Three-way comparison
(C++20)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)

 
Function objects
Function invocation
(C++17)(C++23)
Identity function object
(C++20)
Reference wrappers
refcref
(C++11)(C++11)
Transparent operator wrappers
(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)

Old binders and adaptors
(until C++17*)
(until C++17*)
(until C++17*)
(until C++17*)  
(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
(until C++17*)(until C++17*)
(until C++17*)(until C++17*)

(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
 
Defined in header <functional>
(1)
template< class T >
std::reference_wrapper<T> ref( T& t ) noexcept;
(since C++11)
(until C++20)
template< class T >
constexpr std::reference_wrapper<T> ref( T& t ) noexcept;
(since C++20)
(2)
template< class T >

std::reference_wrapper<T>

    ref( std::reference_wrapper<T> t ) noexcept;
(since C++11)
(until C++20)
template< class T >

constexpr std::reference_wrapper<T>

    ref( std::reference_wrapper<T> t ) noexcept;
(since C++20)
template< class T >
void ref( const T&& ) = delete;
(3) (since C++11)
(4)
template< class T >
std::reference_wrapper<const T> cref( const T& t ) noexcept;
(since C++11)
(until C++20)
template< class T >
constexpr std::reference_wrapper<const T> cref( const T& t ) noexcept;
(since C++20)
(5)
template< class T >

std::reference_wrapper<const T>

    cref( std::reference_wrapper<T> t ) noexcept;
(since C++11)
(until C++20)
template< class T >

constexpr std::reference_wrapper<const T>

    cref( std::reference_wrapper<T> t ) noexcept;
(since C++20)
template< class T >
void cref( const T&& ) = delete;
(6) (since C++11)

Function templates ref and cref are helper functions that generate an object of type std::reference_wrapper, using template argument deduction to determine the template argument of the result.

T may be an incomplete type.

(since C++20)

Contents

[edit] Parameters

t - lvalue reference to object that needs to be wrapped or an instance of std::reference_wrapper

[edit] Return value

2) t
4) std::reference_wrapper<const T>(t)
5) t
3,6) rvalue reference wrapper is deleted.

[edit] Example

#include <functional>
#include <iostream>
 
void f(int& n1, int& n2, const int& n3)
{
    std::cout << "In function: " << n1 << ' ' << n2 << ' ' << n3 << '\n';
    ++n1; // increments the copy of n1 stored in the function object
    ++n2; // increments the main()'s n2
    // ++n3; // compile error
}
 
int main()
{
    int n1 = 1, n2 = 2, n3 = 3;
    std::function<void()> bound_f = std::bind(f, n1, std::ref(n2), std::cref(n3));
    n1 = 10;
    n2 = 11;
    n3 = 12;
    std::cout << "Before function: " << n1 << ' ' << n2 << ' ' << n3 << '\n';
    bound_f();
    std::cout << "After function: " << n1 << ' ' << n2 << ' ' << n3 << '\n';
}

Output:

Before function: 10 11 12
In function: 1 11 12
After function: 10 12 12

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 3146 C++11 unwrapping overloads sometimes led to error made always valid

[edit] See also

CopyConstructible and CopyAssignable reference wrapper
(class template) [edit]