Namespaces
Variants

std::apply

ja.cppreference.net より
 
 
ユーティリティライブラリ
言語サポート
型サポート (基本型、RTTI)
ライブラリ機能テストマクロ (C++20)
プログラムユーティリティ
可変引数関数
コルーチンサポート (C++20)
契約サポート (C++26)
三方比較
(C++20)
(C++20)(C++20)(C++20)    
(C++20)(C++20)(C++20)

一般ユーティリティ
関係演算子 (C++20で非推奨)
整数比較関数
(C++20)(C++20)(C++20)    
(C++20)
Swap と 型操作
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
共通語彙型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)



 
ヘッダ <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,class Tuple, std::size_t... I>
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... は以下の パック を表す:

(C++23以降)

注記

Tuple は必ずしも std::tuple である必要はなく、 std::get と std::tuple_size をサポートするものであれば何でも使用できる。特に、 std::array と std::pair が使用可能である。

(C++23まで)

Tuple はtuple-likeに制約され、すなわち、その中の各型は std::tuple の特殊化、または tuple-like をモデル化する他の型( std::array や std::pair など)であることが要求される。

(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, "Hello", 9.31f, 'c'};
    std::cout << myTuple << '\n';
}

出力:

3
5
[25, Hello, 9.31, c]

関連項目

(C++11)
引数の型によって定義される型の tuple オブジェクトを作成する
(関数テンプレート)
転送参照 の tuple を作成する
(関数テンプレート)
引数のタプルでオブジェクトを構築する
(関数テンプレート)
(C++17) (C++23)
任意の Callable オブジェクトを指定された引数で呼び出す (戻り値の型を指定可能) (C++23以降)
(関数テンプレート)