std::function

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью launder (C++17) Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) initializer_list (C++11) source_location (C++20) Трёхстороннее сравнение (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)     is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

Общие утилиты Дата и время Функциональные объекты Библиотека форматирования (C++20) bitset hash (C++11) Операторы отношения (устарело в C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Целочисленные функции сравнения cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)     cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Операции обмена и типа swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Общие лексические типы pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

Объекты функции

Обёртки функций function (C++11) move_only_function (C++23) mem_fn (C++11) bad_function_call (C++11)	Частичное применение функций bind_frontbind_back (C++20)(C++23) bind (C++11) is_bind_expression (C++11) is_placeholder (C++11) _1, _2, _3, ... (C++11)
Вызов функции invokeinvoke_r (C++17)(C++23) Идентификация объекта функции identity (C++20)	Обёртки ссылок reference_wrapper (C++11) refcref (C++11)(C++11) unwrap_referenceunwrap_ref_decay (C++20)(C++20)
Обёртки операторов plus minus negate multiplies    divides modulus bit_and bit_or bit_not (C++14)   bit_xor equal_to not_equal_to greater less greater_equal less_equal logical_and logical_or logical_not	Прозрачные обёртки операторов plus<> (C++14) minus<> (C++14) negate<> (C++14) multiplies<> (C++14) divides<> (C++14) modulus<> (C++14) bit_and<> (C++14) bit_or<> (C++14) bit_not<> (C++14) bit_xor<> (C++14) equal_to<> (C++14) not_equal_to<> (C++14) greater<> (C++14) less<> (C++14) greater_equal<> (C++14) less_equal<> (C++14) logical_and<> (C++14) logical_or<> (C++14) logical_not<> (C++14)
Отрицатели not_fn (C++17) Поисковики default_searcher (C++17) boyer_moore_searcher (C++17) boyer_moore_horspool_searcher (C++17)	Компараторы с ограничениями ranges::equal_to (C++20) ranges::not_equal_to (C++20) ranges::greater (C++20) ranges::less (C++20) ranges::greater_equal (C++20) ranges::less_equal (C++20) compare_three_way (C++20)
Старые связыватели и адаптеры
unary_function (до C++17) binary_function (до C++17) ptr_fun (до C++17) pointer_to_unary_function (до C++17) pointer_to_binary_function (до C++17) mem_fun (до C++17) mem_fun_tmem_fun1_tconst_mem_fun_tconst_mem_fun1_t (до C++17)(до C++17)(до C++17)(до C++17) not1 (до C++20) not2 (до C++20)	binder1stbinder2nd (до C++17)(до C++17) bind1stbind2nd (до C++17)(до C++17) mem_fun_ref (до C++17) mem_fun_ref_tmem_fun1_ref_tconst_mem_fun_ref_tconst_mem_fun1_ref_t (до C++17)(до C++17)(до C++17)(до C++17) unary_negate (до C++20) binary_negate (до C++20)

 

std::function

Функции-элементы

function::function

function::~function

function::operator=

function::swap

function::assign (до C++17)

function::operator bool

function::operator()

function::target_type

function::target

Функции, не являющиеся элементами

operator==operator!= (до C++20)

std::swap(std::function)

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

std::uses_allocator<std::function> (до C++17)

Принципы вывода(C++17)

 

Определено в заголовочном файле <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 функция-элемент)
operator=	присваивает новую цель (public функция-элемент)
swap	обменивает содержимое (public функция-элемент)
assign (удалено в C++17)	присваивает новую цель (public функция-элемент)
operator bool	проверяет, содержится ли цель (public функция-элемент)
operator()	вызывает цель (public функция-элемент)
Доступ к цели
target_type	получает typeid сохранённой цели (public функция-элемент)
target	получает указатель на сохранённую цель (public функция-элемент)

Функции, не являющиеся элементами

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 (специализация шаблона класса)

Примечание

Следует соблюдать осторожность, когда 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) << ";  "; }
}

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

-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)	создаёт объект функцию из указателя на элемент (шаблон функции)