std::apply

Определено в заголовочном файле `<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(/* see below */);			(начиная с C++23)

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

Для функции apply-impl, используемой только для пояснения и определённой следующим образом:

template<classF,classTuple,std::size_t...I> constexprdecltype(auto) apply-impl(F&&f,Tuple&&t,std::index_sequence<I...>)// exposition only { 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` требуется, чтобы он был подобен кортежу, то есть каждый содержащийся в нём тип должен быть специализацией `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';
    
    // Error: can't deduce the function type
    // 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'; 
    
    // advanced example
    std::tuple myTuple{25, "Hello", 9.31f, 'c'};
    std::cout << myTuple << '\n';
}

Вывод:

3
5
[25, Hello, 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) (шаблон функции)

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