std::not_fn

 

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)

 

関数オブジェクト

関数ラッパー 関数 (C++11) move_only_function (C++23) copyable_function (C++26) function_ref (C++26) mem_fn (C++11) bad_function_call (C++11)	部分関数適用 bind_frontbind_back (C++20)(C++23) bind (C++11) is_bind_expression (C++11) is_placeholder (C++11) _1, _2, _3, ... (C++11)
関数の呼び出し invokeinvoke_r (C++17)(C++23) 恒等関数オブジェクト identity (C++20)	参照ラッパー reference_wrapper (C++11) refcref (C++11)(C++11) unwrap_referenceunwrap_ref_decay (C++20)(C++20)
演算子ラッパー plus minus negate multiplies divides modulus bit_and bit_or bit_not (C++14)   bit_xor equal_to not_equal_to greater less greater_equal less_equal logical_and logical_or logical_not	透過的な演算子ラッパー plus<> (C++14) minus<> (C++14) negate<> (C++14) multiplies<> (C++14)   divides<> (C++14) modulus<> (C++14) bit_and<> (C++14) bit_or<> (C++14) bit_not<> (C++14) bit_xor<> (C++14) equal_to<> (C++14) not_equal_to<> (C++14) greater<> (C++14) less<> (C++14) greater_equal<> (C++14) less_equal<> (C++14) logical_and<> (C++14) logical_or<> (C++14) logical_not<> (C++14)
否定子 (Negators) not_fn (C++17) サーチャー default_searcher (C++17) boyer_moore_searcher (C++17) boyer_moore_horspool_searcher (C++17)	制約付き比較器 ranges::equal_to (C++20) ranges::not_equal_to (C++20) ranges::greater (C++20) ranges::less (C++20) ranges::greater_equal (C++20) ranges::less_equal (C++20) compare_three_way (C++20)
古いバインダとアダプタ
unary_function (C++17まで*) binary_function (C++17まで*) ptr_fun (C++17まで*) pointer_to_unary_function (C++17まで*) pointer_to_binary_function (C++17まで*)   mem_fun (C++17まで*) mem_fun_tmem_fun1_tconst_mem_fun_tconst_mem_fun1_t (C++17*まで)(C++17*まで)(C++17*まで)(C++17*まで) not1 (C++20まで*) not2 (C++20まで*)	binder1stbinder2nd (C++17*まで)(C++17*まで) bind1stbind2nd (C++17*まで)(C++17*まで) mem_fun_ref (C++17まで*) mem_fun_ref_tmem_fun1_ref_tconst_mem_fun_ref_tconst_mem_fun1_ref_t (C++17*まで)(C++17*まで)(C++17*まで)(C++17*まで) unary_negate (C++20まで*) binary_negate (C++20まで*)

 

ヘッダ <functional> で定義
template< class F > /* 未指定 */ not_fn( F&& f );	(1)	(C++17以降) (C++20 以降 constexpr)
template< auto ConstFn > constexpr /* 未指定 */ not_fn() noexcept;	(2)	(C++26以降)

1) 保持する呼び出し可能オブジェクトの否定を返す転送呼び出しラッパーを作成します。

2) 静的に決定された呼び出し可能ターゲットの否定を返す転送呼び出しラッパーを作成します。ConstFnがヌルポインタまたはヌルメンバポインタの場合、プログラムは不正です。

パラメータ

f	-	ラッパーが保持するCallableオブジェクトが構築される元となるオブジェクト
型要件
- std::decay_t<F>は、CallableおよびMoveConstructibleの要件を満たす必要があります。
- std::is_constructible_v<std::decay_t<F>, F>はtrueである必要があります。

戻り値

1) 未指定の型Tの関数オブジェクト。以下のメンバを持ちます。

std::not_fn 戻り値の型

メンバーオブジェクト

std::not_fnの戻り値の型は、型std::decay_t<F>のメンバオブジェクトを保持します。

コンストラクタ

explicit T( F&& f );	(1)	(C++17以降) (C++20 以降 constexpr) (説明用*)
T( T&& f ) = default; T( const T& f ) = default;	(2)	(C++17以降)

1) コンストラクタは、メンバオブジェクト（型std::decay_t<F>）をstd::forward<F>(f)から直接非リスト初期化します。選択されたコンストラクタによってスローされる例外をスローします。

2) std::decay_t<F>はMoveConstructibleである必要があるため、返される呼び出しラッパーは常にMoveConstructibleであり、std::decay_t<F>がCopyConstructibleであればCopyConstructibleです。

明示的にデフォルト化された定義により、戻り値の型は代入不可になります。	(C++20まで)
これらのコンストラクタが明示的にデフォルト化されているか、および戻り値の型が代入可能であるかは未指定です。	(C++20以降)

メンバ関数 operator()

	(1)
template< class... Args > auto operator()( Args&&... args ) & -> decltype(!std::declval<     std::invoke_result_t<std::decay_t<F>&, Args...>>()); template< class... Args > auto operator()( Args&&... args ) const& -> decltype(!std::declval<     std::invoke_result_t<std::decay_t<F> const&, Args...>>());			(C++17以降) (C++20まで)
template< class... Args > constexpr auto operator()( Args&&... args ) &     noexcept(/* 以下を参照 */) -> decltype(!std::invoke(     std::declval<std::decay_t<F>&>(), std::declval<Args>()...)); template< class... Args > constexpr auto operator()( Args&&... args ) const&     noexcept(/* 以下を参照 */) -> decltype(!std::invoke(     std::declval<std::decay_t<F> const&>(), std::declval<Args>()...));			(C++20以降)
		(2)
template< class... Args > auto operator()( Args&&... args ) && -> decltype(!std::declval<     std::invoke_result_t<std::decay_t<F>, Args...>>()); template< class... Args > auto operator()( Args&&... args ) const&& -> decltype(!std::declval<     std::invoke_result_t<std::decay_t<F> const, Args...>>());				(C++17以降) (C++20まで)
template< class... Args > constexpr auto operator()( Args&&... args ) &&     noexcept(/* 以下を参照 */) -> decltype(!std::invoke(     std::declval<std::decay_t<F>>(), std::declval<Args>()...)); template< class... Args > constexpr auto operator()( Args&&... args ) const&&     noexcept(/* 以下を参照 */) -> decltype(!std::invoke(     std::declval<std::decay_t<F> const>(), std::declval<Args>()...));				(C++20以降)

fdを型std::decay_t<F>のメンバオブジェクトとします。

1) return !std::invoke(fd, std::forward<Args>(args)...);と同等。 2) return !std::invoke(std::move(fd), std::forward<Args>(args)...);と同等。 結果を呼び出す際に、最初に選択されたoperator()オーバーロードの戻り値の型への置換が失敗した場合、別のオーバーロードが選択される場合があります。	(C++17以降) (C++20まで)
1) 式的に同等!std::invoke(fd, std::forward<Args>(args)...) 2) 式的に同等!std::invoke(std::move(fd), std::forward<Args>(args)...) 結果を呼び出す際に、最初に選択されたoperator()オーバーロードの戻り値の型への置換が失敗した場合、呼び出しは不正であり、これも置換失敗となる可能性があります。	(C++20以降)

2) 以下の型の値。

std::not_fn ステートレスな戻り値の型

戻り値の型はCopyConstructibleなステートレスクラスです。戻り値の型が代入可能であるかは未指定です。

メンバ関数 operator()

template< class... Args > constexpr auto operator()( Args&&... args ) const     noexcept(/* 以下を参照 */) -> decltype(!std::invoke(ConstFn, std::declval<Args>()...));		(C++26以降)

式的に同等!std::invoke(ConstFn, std::forward<Args>(args)...)。

例外

1) fdの構築が例外をスローしない限り、例外をスローしません。

実装例

(1) not_fn
namespace detail { template<class V, class F, class... Args> constexpr bool negate_invocable_impl = false; template<class F, class... Args> constexpr bool negate_invocable_impl<std::void_t<decltype( !std::invoke(std::declval<F>(), std::declval<Args>()...))>, F, Args...> = true;   template<class F, class... Args> constexpr bool negate_invocable_v = negate_invocable_impl<void, F, Args...>;   template<class F> struct not_fn_t { F f;   template<class... Args, std::enable_if_t<negate_invocable_v<F&, Args...>, int> = 0> constexpr decltype(auto) operator()(Args&&... args) & noexcept(noexcept(!std::invoke(f, std::forward<Args>(args)...))) { return !std::invoke(f, std::forward<Args>(args)...); }   template<class... Args, std::enable_if_t<negate_invocable_v<const F&, Args...>, int> = 0> constexpr decltype(auto) operator()(Args&&... args) const& noexcept(noexcept(!std::invoke(f, std::forward<Args>(args)...))) { return !std::invoke(f, std::forward<Args>(args)...); }   template<class... Args, std::enable_if_t<negate_invocable_v<F, Args...>, int> = 0> constexpr decltype(auto) operator()(Args&&... args) && noexcept(noexcept(!std::invoke(std::move(f), std::forward<Args>(args)...))) { return !std::invoke(std::move(f), std::forward<Args>(args)...); }   template<class... Args, std::enable_if_t<negate_invocable_v<const F, Args...>, int> = 0> constexpr decltype(auto) operator()(Args&&... args) const&& noexcept(noexcept(!std::invoke(std::move(f), std::forward<Args>(args)...))) { return !std::invoke(std::move(f), std::forward<Args>(args)...); }   // Deleted overloads are needed since C++20 // for preventing a non-equivalent but well-formed overload to be selected.   template<class... Args, std::enable_if_t<!negate_invocable_v<F&, Args...>, int> = 0> void operator()(Args&&...) & = delete;   template<class... Args, std::enable_if_t<!negate_invocable_v<const F&, Args...>, int> = 0> void operator()(Args&&...) const& = delete;   template<class... Args, std::enable_if_t<!negate_invocable_v<F, Args...>, int> = 0> void operator()(Args&&...) && = delete;   template<class... Args, std::enable_if_t<!negate_invocable_v<const F, Args...>, int> = 0> void operator()(Args&&...) const&& = delete; }; }   template<class F> constexpr detail::not_fn_t<std::decay_t<F>> not_fn(F&& f) { return {std::forward<F>(f)}; }
(2) not_fn
namespace detail { template<auto ConstFn> struct stateless_not_fn { template<class... Args> constexpr auto operator()(Args&&... args) const noexcept(noexcept(!std::invoke(ConstFn, std::forward<Args>(args)...))) -> decltype(!std::invoke(ConstFn, std::forward<Args>(args)...)) { return !std::invoke(ConstFn, std::forward<Args>(args)...); } }; }   template<auto ConstFn> constexpr detail::stateless_not_fn<ConstFn> not_fn() noexcept { if constexpr (std::is_pointer_v<decltype(ConstFn)> || std::is_member_pointer_v<decltype(ConstFn)>) static_assert(ConstFn != nullptr);   return {}; }

備考

std::not_fnは、C++03時代の否定子std::not1およびstd::not2を置き換えることを意図しています。

機能テストマクロ	値	規格	機能
__cpp_lib_not_fn	201603L	(C++17)	std::not_fn(), (1)
	202306L	(C++26)	呼び出し可能オブジェクトを非型テンプレート引数としてstd::not_fnに渡すことを許可します, (2)

例

このコードを実行

#include <cassert>
#include <functional>
 
bool is_same(int a, int b) noexcept
{
    return a == b;
}
 
struct S
{
    int val;
    bool is_same(int arg) const noexcept { return val == arg; }
};
 
int main()
{
    // Using with a free function:
    auto is_differ = std::not_fn(is_same);
    assert(is_differ(8, 8) == false); // equivalent to: !is_same(8, 8) == false
    assert(is_differ(6, 9) == true); // equivalent to: !is_same(8, 0) == true
 
    // Using with a member function:
    auto member_differ = std::not_fn(&S::is_same);
    assert(member_differ(S{3}, 3) == false); //: S tmp{6}; !tmp.is_same(6) == false
 
    // Noexcept-specification is preserved:
    static_assert(noexcept(is_differ) == noexcept(is_same));
    static_assert(noexcept(member_differ) == noexcept(&S::is_same));
 
    // Using with a function object:
    auto same = [](int a, int b) { return a == b; };
    auto differ = std::not_fn(same);
    assert(differ(1, 2) == true); //: !same(1, 2) == true
    assert(differ(2, 2) == false); //: !same(2, 2) == false
 
#if __cpp_lib_not_fn >= 202306L
    auto is_differ_cpp26 = std::not_fn<is_same>();
    assert(is_differ_cpp26(8, 8) == false);
    assert(is_differ_cpp26(6, 9) == true);
 
    auto member_differ_cpp26 = std::not_fn<&S::is_same>();
    assert(member_differ_cpp26(S{3}, 3) == false);
 
    auto differ_cpp26 = std::not_fn<same>();
    static_assert(differ_cpp26(1, 2) == true);
    static_assert(differ_cpp26(2, 2) == false);
#endif
}

関連項目

not1 (C++17で非推奨)(C++20で削除)	カスタムの std::unary_negate オブジェクトを構築する (関数テンプレート)
not2 (C++17で非推奨)(C++20で削除)	カスタムの std::binary_negate オブジェクトを構築する (関数テンプレート)