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 Callable-цели: функции (через указатели на них), лямбда-выражения, выражения 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 с типом результата-ссылкой инициализируется лямбда-выражением без завершающего типа возвращаемого значения. Из-за особенностей вывода типа auto такое лямбда-выражение всегда возвращает prvalue. Поэтому результирующая ссылка обычно привязывается к временному объекту, время жизни которого заканчивается при возврате из std::function::operator().

(до C++23)

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

(начиная с 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)	обёртка с семантикой перемещения для любого вызываемого объекта, поддерживающая квалификаторы в заданной сигнатуре вызова (шаблон класса)
copyable_function (C++26)	копируемая обёртка для любого копируемого вызываемого объекта, поддерживающая квалификаторы в заданной сигнатуре вызова (шаблон класса)
function_ref (C++26)	невладеющая обёртка для любого вызываемого объекта (шаблон класса)
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/cpp/utility/functional/function