Пространства имён
Варианты
Действия

std::function

Материал из cppreference.com
< cpp‎ | utility‎ | functional
 
 
Библиотека утилит
Языковая поддержка
Поддержка типов (базовые типы, RTTI)
Макросы тестирования функциональности библиотеки (C++20)    
Управление динамической памятью
Программные утилиты
Поддержка сопрограмм (C++20)
Вариативные функции
Трёхстороннее сравнение (C++20)
(C++20)
(C++20)(C++20)(C++20)(C++20)(C++20)(C++20)
Общие утилиты
Дата и время
Функциональные объекты
Библиотека форматирования (C++20)
(C++11)
Операторы отношения (устарело в C++20)
Целочисленные функции сравнения
(C++20)(C++20)(C++20)    
(C++20)
Операции обмена и типа
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Общие лексические типы
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Элементарные преобразования строк
(C++17)
(C++17)
 
Объекты функции
Функции обёртки
function
(C++11)
(C++11)
Применение частичных функций
(C++20)(C++23)
(C++11)
Вызов функции
(C++17)(C++23)
Объект идентичности функции
(C++20)
Обёртки ссылок
(C++11)(C++11)
Прозрачные обёртки операторов
(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)

Отрицатели
(C++17)
Искатели
Ограниченные компараторы
Старые привязки и адаптеры
(до C++17*)
(до C++17*)
(до C++17*)
(до C++17*)
(до C++17*)(до C++17*)(до C++17*)(до C++17*)
(до C++20*)
(до C++20*)
(до C++17*)(до C++17*)
(до C++17*)(до C++17*)

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

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

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

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

Содержание

[править] Типы-элементы

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

[править] Функции-элементы

создаёт новый экземпляр std::function
(public функция-элемент) [править]
уничтожает экземпляр std::function
(public функция-элемент) [править]
присваивает новую цель
(public функция-элемент) [править]
обменивает содержимое
(public функция-элемент) [править]
(удалено в C++17)
присваивает новую цель
(public функция-элемент) [править]
проверяет, содержится ли цель
(public функция-элемент) [править]
вызывает цель
(public функция-элемент) [править]
Доступ к цели
получает typeid сохранённой цели
(public функция-элемент) [править]
получает указатель на сохранённую цель
(public функция-элемент) [править]

[править] Функции, не являющиеся элементами

специализация алгоритма std::swap
(шаблон функции) [править]
(удалено в C++20)
сравнивает std::function с nullptr
(шаблон функции) [править]

[править] Вспомогательные классы

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

[править] Принципы вывода(начиная с C++17)

[править] Примечание

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

(до C++23)

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

(начиная с C++23)
std::function<const int&()> F([]{ return 42; }); // Ошибка начиная с C++23: невозможно
                                                 // привязать возвращённую ссылку
                                                 // к временному объекту
int x = F(); // Неопределённое поведение до C++23: результатом F() является висячая ссылка
 
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()
{
    // сохраняет свободную функцию
    std::function<void(int)> f_display = print_num;
    f_display(-9);
 
    // сохраняет лямбду
    std::function<void()> f_display_42 = []() { print_num(42); };
    f_display_42();
 
    // сохраняет результат вызова std::bind
    std::function<void()> f_display_31337 = std::bind(print_num, 31337);
    f_display_31337();
 
    // сохраняет вызов функции-элемента
    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);
 
    // сохраняет вызов метода доступа к элементу данных
    std::function<int(Foo const&)> f_num = &Foo::num_;
    std::cout << "num_: " << f_num(foo) << '\n';
 
    // сохраняет вызов функции-элемента и объект
    using std::placeholders::_1;
    std::function<void(int)> f_add_display2 = std::bind( &Foo::print_add, foo, _1 );
    f_add_display2(2);
 
    // сохраняет вызов функции-элемента и указатель на объект
    std::function<void(int)> f_add_display3 = std::bind( &Foo::print_add, &foo, _1 );
    f_add_display3(3);
 
    // сохраняет вызов функционального объекта
    std::function<void(int)> f_display_obj = PrintNum();
    f_display_obj(18);
 
    auto factorial = [](int n) {
        // сохраняет лямбда-объект для эмуляции "рекурсивной лямбды";
        // осведомлены о дополнительных накладных расходах
        std::function<int(int)> fac = [&](int n){ return (n < 2) ? 1 : n*fac(n-1); };
        // обратите внимание, что "auto fac = [&](int n){...};" не работает в рекурсивных
        // вызовах
        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;

[править] Смотрите также

обёртывает вызываемый объект любого типа с указанной сигнатурой вызова функции
(шаблон класса) [править]
исключение, возникающее при вызове пустой std::function
(класс) [править]
(C++11)
создаёт объект функцию из указателя на элемент
(шаблон функции) [править]
typeid Запрашивает информацию о типе, возвращая объект std::type_info, представляющий тип.