std::function

Определено в заголовочном файле `<functional>`
template< class > class function; /* undefined */		(с C++11)
template< class R, class... Args > class function<R(Args...)>;		(с C++11)

Шаблон класса std::function — универсальная полиморфная обёртка для функций. Экземпляры std::function могут хранить, копировать и вызывать любой копируемый CopyConstructible вызываемый объект-цель — функции (через указатели на них), лямбда-выражения, выражения bind или другие объекты-функции, а также указатели на члены функций и указатели на данные.

Хранимый вызываемый объект называется объектом-целью std::function. Если std::function не содержит объект-цели, то он называется пустым. Вызов объекта-цели пустого std::function приводит к выбрасыванию исключения std::bad_function_call.

std::function удовлетворяет требованиям CopyConstructible и CopyAssignable.

Типы-члены

Тип	Определение
`result_type`	`R`
`argument_type`(устарело в C++17)(удалено в C++20)	`T` если `sizeof...(Args)==1` и `T` — первый и единственный тип в `Args...`
`first_argument_type`(устарело в C++17)(удалено в C++20)	`T1` если `sizeof...(Args)==2` и `T1` — первый из двух типов в `Args...`
`second_argument_type`(устарело в C++17)(удалено в C++20)	`T2` если `sizeof...(Args)==2` и `T2` — второй из двух типов в `Args...`

Члены-функции

(конструктор)	создаёт новый экземпляр `std::function` (публичный член-функция)
(деструктор)	уничтожает экземпляр `std::function` (публичный член-функция)
operator=	присваивает новый объект-цель (публичный член-функция)
swap	обменивает содержимое (публичный член-функция)
assign (удалено в C++17)	присваивает новый объект-цель (публичный член-функция)
operator bool	проверяет наличие объекта-цели (публичный член-функция)
operator()	вызывает объект-цель (публичный член-функция)
Доступ к объекту-цели
target_type	получает typeid хранимого объекта-цели (публичный член-функция)
target	получает указатель на хранимый объект-цель (публичный член-функция)

Нечлены-функции

std::swap(std::function) (C++11)	специализирует алгоритм `std::swap` (шаблон функции)
operator==operator!= (удалено в C++20)	сравнивает `std::function` с `nullptr` (шаблон функции)

Вспомогательные классы

std::uses_allocator<std::function>

(C++11) (до C++17)

специализация типа-трейта std::uses_allocator
(специализация шаблона класса)

Вывод типов(с C++17)

Примечания

Следует соблюдать осторожность, когда std::function, тип результата которой является ссылкой, инициализируется из лямбда-выражения без trailing-return-type. Из-за способа работы вывода типа auto, такое лямбда-выражение всегда возвращает значение без срока жизни. Следовательно, полученная ссылка обычно связывается со временным объектом, срок жизни которого заканчивается, когда std::function::operator() возвращает значение.

(до C++23)

Если std::function возвращает ссылку, инициализируется из функции или объекта-функции, возвращающего значение без срока жизни (включая лямбда-выражение без trailing-return-type), программа считается некорректной, поскольку привязка возвращаемой ссылки к временному объекту запрещена.

(с C++23)

std::function<const int&()> F([] { return 42; }); // Error since C++23: can't bind
                                                  // the returned reference to a temporary
int x = F(); // Undefined behavior until C++23: the result of F() is a dangling reference
 
std::function<int&()> G([]() -> int& { static int i{0x2A}; return i; }); // OK
 
std::function<const int&()> H([i{052}] -> const int& { return i; }); // OK

Пример

#include <functional>
#include <iostream>
 
struct Foo
{
    Foo(int num) : num_(num) {}
    void print_add(int i) const { std::cout << num_ + i << '\n'; }
    int num_;
};
 
void print_num(int i)
{
    std::cout << i << '\n';
}
 
struct PrintNum
{
    void operator()(int i) const
    {
        std::cout << i << '\n';
    }
};
 
int main()
{
    // store a free function
    std::function<void(int)> f_display = print_num;
    f_display(-9);
 
    // store a lambda
    std::function<void()> f_display_42 = []() { print_num(42); };
    f_display_42();
 
    // store the result of a call to std::bind
    std::function<void()> f_display_31337 = std::bind(print_num, 31337);
    f_display_31337();
 
    // store a call to a member function
    std::function<void(const Foo&, int)> f_add_display = &Foo::print_add;
    const Foo foo(314159);
    f_add_display(foo, 1);
    f_add_display(314159, 1);
 
    // store a call to a data member accessor
    std::function<int(Foo const&)> f_num = &Foo::num_;
    std::cout << "num_: " << f_num(foo) << '\n';
 
    // store a call to a member function and object
    using std::placeholders::_1;
    std::function<void(int)> f_add_display2 = std::bind(&Foo::print_add, foo, _1);
    f_add_display2(2);
 
    // store a call to a member function and object ptr
    std::function<void(int)> f_add_display3 = std::bind(&Foo::print_add, &foo, _1);
    f_add_display3(3);
 
    // store a call to a function object
    std::function<void(int)> f_display_obj = PrintNum();
    f_display_obj(18);
 
    auto factorial = [](int n)
    {
        // store a lambda object to emulate "recursive lambda"; aware of extra overhead
        std::function<int(int)> fac = [&](int n) { return (n < 2) ? 1 : n * fac(n - 1); };
        // note that "auto fac = [&](int n) {...};" does not work in recursive calls
        return fac(n);
    };
    for (int i{5}; i != 8; ++i)
        std::cout << i << "! = " << factorial(i) << ";  ";
    std::cout << '\n';
}

Возможный вывод:

-9
42
31337
314160
314160
num_: 314159
314161
314162
18
5! = 120;  6! = 720;  7! = 5040;

См. также

move_only_function (C++23)	обёртка для вызываемого объекта любого типа с заданной сигнатурой вызова функции (шаблон класса)
bad_function_call (C++11)	исключение, выбрасываемое при вызове пустого `std::function` (класс)
mem_fn (C++11)	создание объекта-функции из указателя на член (шаблон функции)
`typeid`	запрос информации о типе, возвращающий объект `std::type_info` , представляющий тип

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/utility/functional/function