Spec-Zone.ru › C++

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<class F, tuple-like Tuple, std::size_t... I> // no constraint on Tuple before C++23
constexpr decltype(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/w/cpp/utility/apply

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API