std::apply

 

C++

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

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

Язык

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

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

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) is_within_lifetime (C++26) 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) to_chars_result (C++17) from_chars_result (C++17)

 

<tbody> </tbody> <tbody class="t-dcl-rev "> </tbody><tbody> </tbody>

Определено в заголовочном файле <tuple>
template< class F, class Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t );		(начиная с C++17) (до C++23)
template< class F, tuple-like Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t ) noexcept(/* смотрите ниже */);		(начиная с C++23)

Вызывает Callable объект f элементами t в качестве аргументов.

Дана функция только для описания apply-impl, определённая следующим образом: template<class F, tuple-like Tuple, std::size_t... I> // нет ограничений на Tuple до C++23
constexpr decltype(auto)
    apply-impl(F&& f, Tuple&& t, std::index_sequence<I...>) // только для описания
{
    return INVOKE(std::forward<F>(f), std::get<I>(std::forward<Tuple>(t))...);
}

Эффект эквивалентен return apply-impl(std::forward<F>(f), std::forward<Tuple>(t),
 std::make_index_sequence<
 std::tuple_size_v<std::decay_t<Tuple>>>{}); .

Параметры

f	—	Callable объект для вызова
t	—	кортеж, элементы которого будут использоваться в качестве аргументов для f

Возвращаемое значение

Значение, возвращаемое f.

Исключения

(нет)	(до C++23)
спецификация noexcept:   noexcept( noexcept(std::invoke(std::forward<F>(f), std::get<Is>(std::forward<Tuple>(t))...)) ) где Is... обозначает пакет параметров: 0, 1, ..., std::tuple_size_v<std::remove_reference_t<Tuple>> - 1.	(начиная с C++23)

Примечание

Tuple не обязательно должен быть std::tuple, вместо него может быть любой объект, поддерживающий std::get и std::tuple_size; в частности, могут использоваться std::array и std::pair.	(до C++23)
Tuple должен быть tuple-подобным, т.е. каждый тип в нём должен быть специализацией std::tuple или другим типом (например, std::array и std::pair), который моделирует tuple-like.	(начиная с C++23)

Макрос Тестирования функциональности	Значение	Стандарт	Функциональность
__cpp_lib_apply	201603L	(C++17)	std::apply

Пример

Запустить этот код

#include <iostream>
#include <tuple>
#include <utility>

int add(int first, int second) { return first + second; }

template<typename T>
T add_generic(T first, T second) { return first + second; }

auto add_lambda = [](auto first, auto second) { return first + second; };

template<typename... Ts>
std::ostream& operator<<(std::ostream& os, std::tuple<Ts...> const& theTuple)
{
    std::apply
    (
        [&os](Ts const&... tupleArgs)
        {
            os << '[';
            std::size_t n{0};
            ((os << tupleArgs << (++n != sizeof...(Ts) ? ", " : "")), ...);
            os << ']';
        }, theTuple
    );
    return os;
}

int main()
{
    // OK
    std::cout << std::apply(add, std::pair(1, 2)) << '\n';
 
    // Ошибка: невозможно определить тип функции
    // std::cout << std::apply(add_generic, std::make_pair(2.0f, 3.0f)) << '\n'; 

    // OK
    std::cout << std::apply(add_lambda, std::pair(2.0f, 3.0f)) << '\n'; 

    // расширенный пример
    std::tuple myTuple{25, "Привет", 9.31f, 'c'};
    std::cout << myTuple << '\n';
}

Вывод:

3
5
[25, Привет, 9.31, c]

Смотрите также

make_tuple (C++11)	создаёт объект tuple типа, определённого типами аргументов (шаблон функции)
forward_as_tuple (C++11)	создаёт tuple пересылалаемых ссылок (шаблон функции)
make_from_tuple (C++17)	создаёт объект с кортежем аргументов (шаблон функции)
invokeinvoke_r (C++17)(C++23)	вызывает любой Callable объект с данными аргументами и имеет возможность указать тип возврата (начиная с C++23) (шаблон функции)