std::ignore

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ユーティリティライブラリ

言語サポート 型のサポート (基本型、RTTI) ライブラリ機能検査マクロ (C++20) プログラムユーティリティ 可変引数関数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) コルーチンサポート (C++20) 契約サポート (C++26) 三方比較 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_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (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)

 

std::tuple

メンバ関数

tuple::tuple

tuple::operator=

tuple::swap

非メンバ関数

make_tuple

tie

forward_as_tuple

tuple_cat

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20)

swap(std::tuple)

get(std::tuple)

ヘルパーコンセプト

tuple-like (C++23)

ヘルパークラス

tuple_size<std::tuple>

tuple_element<std::tuple>

uses_allocator<std::tuple>

basic_common_reference<std::tuple> (C++23)

common_type<std::tuple> (C++23)

formatter<std::tuple> (C++23)

ignore

推論ガイド(C++17)

 

ヘッダ <tuple> で定義
ヘッダ <utility> で定義
	(1)
const /*ignore-type*/ ignore;			(C++11以降) (C++14まで)
constexpr /*ignore-type*/ ignore;			(C++14以降) (C++17以降inline)
		(2)
struct /*ignore-type*/ {     template< class T >     const /*ignore-type*/& operator=( const T& ) const noexcept     {         return *this;     } };				(C++11以降) (C++14まで) (説明用*)
struct /*ignore-type*/ {     template< class T >     constexpr const /*ignore-type*/& operator=( const T& ) const noexcept     {         return *this;     } };				(C++14以降) (説明用*)

1) あらゆる値を代入しても効果がないオブジェクト。

2) std::ignoreの型。

備考

void 式または揮発性ビットフィールド値はstd::ignoreに代入できません。

std::ignoreは、std::tupleをアンパックする際に使用されない引数のプレースホルダーとしてstd::tieと一緒に使用することを意図していますが、不要な代入にも使用できます。

一部のコードガイドでは、代入が必須ではないにもかかわらず、[[nodiscard]]関数の未使用の戻り値による警告を回避するためにstd::ignoreを使用することを推奨しています。

代入が不要な値を無視するには、voidにキャストできます。名前はあるが値が使用されていない変数の場合、それらをvoidにキャストするか、[[maybe_unused]]でそれらの変数を宣言できます。

例

1. std::ignoreと[[nodiscard]]関数の使用方法を示します。
2. std::set::insert()が返すstd::pair<iterator, bool>をアンパックしますが、ブール値のみを保存します。

このコードを実行

#include <iostream>
#include <set>
#include <string>
#include <tuple>
 
[[nodiscard]] int dontIgnoreMe()
{
    return 42;
}
 
int main()
{
    std::ignore = dontIgnoreMe();
 
    std::set<std::string> set_of_str;
    if (bool inserted{false};
        std::tie(std::ignore, inserted) = set_of_str.insert("Test"),
        inserted)
        std::cout << "Value was inserted successfully.\n";
}

出力

Value was inserted successfully.

欠陥レポート

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2773	C++14	std::tupleはconstexprになりましたが、std::ignoreはまだ	constexprではありませんでした。
P2968R2	C++11	std::tie以外のstd::ignoreの動作は正式に指定されていませんでした。	完全に指定されました。

関連項目

tie (C++11)

左辺値参照のtupleを生成するか、タプルを個別のオブジェクトにアンパックする (関数テンプレート)