Namespaces
Variants
Views
Actions

std::addressof

From cppreference.com
< cpp‎ | memory
 
 
Utilities library
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)
 
Dynamic memory management
Smart pointers
(C++11)
(C++11)
(C++11)
(until C++17)
(C++11)
(C++23)
Allocators
Memory resources
Uninitialized storage
Uninitialized memory algorithms
Constrained uninitialized memory algorithms
Garbage collection support
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
Miscellaneous
(C++20)
addressof
(C++11)
(C++11)
Low level memory management
 
Defined in header <memory>
(1)
template< class T >
T* addressof( T& arg ) noexcept;
(since C++11)
(until C++17)
template< class T >
constexpr T* addressof( T& arg ) noexcept;
(since C++17)
template< class T >
const T* addressof( const T&& ) = delete;
(2) (since C++17)
1) Obtains the actual address of the object or function arg, even in presence of overloaded operator&.
2) Rvalue overload is deleted to prevent taking the address of const rvalues.

The expression std::addressof(e) is a constant subexpression, if e is an lvalue constant subexpression.

(since C++17)

Contents

[edit] Parameters

arg - lvalue object or function

[edit] Return value

Pointer to arg.

[edit] Possible implementation

The implementation below is not constexpr (which requires compiler support).

template<class T>
typename std::enable_if<std::is_object<T>::value, T*>::type  addressof(T& arg) noexcept
{
    return reinterpret_cast<T*>(
               &const_cast<char&>(
                   reinterpret_cast<const volatile char&>(arg)));
}
 
template<class T>
typename std::enable_if<!std::is_object<T>::value, T*>::type addressof(T& arg) noexcept
{
    return &arg;
}

Correct implementation of this function requires compiler support: GNU libstdc++, LLVM libc++, Microsoft STL

[edit] Notes

Feature-test macro Value Std Comment
__cpp_lib_addressof_constexpr 201603L (C++17) constexpr std::addressof

[edit] Example

operator& may be overloaded for a pointer wrapper class to obtain a pointer to pointer:

#include <iostream>
#include <memory>
 
template<class T>
struct Ptr {
    T* pad; // add pad to show difference between 'this' and 'data'
    T* data;
    Ptr(T* arg) : pad(nullptr), data(arg)
    {
        std::cout << "Ctor this = " << this << '\n';
    }
 
    ~Ptr() { delete data; }
    T** operator&() { return &data; }
};
 
template<class T>
void f(Ptr<T>* p)
{
    std::cout << "Ptr   overload called with p = " << p << '\n';
}
 
void f(int** p)
{
    std::cout << "int** overload called with p = " << p << '\n';
}
 
int main()
{
    Ptr<int> p(new int(42));
    f(&p);                 // calls int** overload
    f(std::addressof(p));  // calls Ptr<int>* overload, (= this)
}

Possible output:

Ctor this = 0x7fff59ae6e88
int** overload called with p = 0x7fff59ae6e90
Ptr   overload called with p = 0x7fff59ae6e88

[edit] See also

the default allocator
(class template) [edit]
[static]
obtains a dereferenceable pointer to its argument
(public static member function of std::pointer_traits<Ptr>) [edit]