Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/types/negation"

From cppreference.com
< cpp‎ | types
(LWG 2567)
m (Example: Applied `static_assert`)
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{cpp/title|negation}}
 
{{cpp/title|negation}}
{{cpp/types/navbar}}
+
{{cpp/meta/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
{{dcl header | type_traits}}
+
{{dcl header|type_traits}}
{{dcl | since=c++17 | num=1 | 1=
+
{{dcl|since=c++17|1=
template<class B>
+
template< class B >
 
struct negation;
 
struct negation;
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
Forms the logical negation of the type trait {{tt|B}}.
+
Forms the [[enwiki:Negation|logical negation]] of the type trait {{c|B}}.
  
The type {{c|std::negation<B>}} is a {{concept|UnaryTypeTrait}} with a BaseCharacteristic of {{c|std::bool_constant<!bool(B::value)>}}.
+
The type {{c|std::negation<B>}} is a {{named req|UnaryTypeTrait}} with a base characteristic of {{c|std::bool_constant<!bool(B::value)>}}.
 +
 
 +
{{cpp/types/nospec|pv}}
  
 
===Template parameters===
 
===Template parameters===
 
{{par begin}}
 
{{par begin}}
{{par | B | any type such that {{c|B::value}} is convertible to {{c|bool}} }}
+
{{par|B|any type such that the expression {{c|bool(B::value)}} is a valid constant expression }}
 
{{par end}}
 
{{par end}}
  
=== Helper variable template ===
+
===Helper variable template===
{{dcl begin}}
+
{{ddcl|since=c++17|1=
{{dcl | since=c++17 | 1=
+
template< class B >
template<class B>
+
 
constexpr bool negation_v = negation<B>::value;
 
constexpr bool negation_v = negation<B>::value;
 
}}
 
}}
{{dcl end}}
 
  
{{cpp/types/integral_constant/inherit | {{tt|B}} has a member {{tt|::value}} that is {{c|false}} }}
+
{{cpp/types/integral_constant/inherit|{{tt|B}} has a member {{c|::value}} that is {{c|false}} when explicitly converted to {{c|bool}}}}
  
 
===Possible implementation===
 
===Possible implementation===
 
{{eq fun
 
{{eq fun
| 1=
+
|1=
 
template<class B>
 
template<class B>
struct negation : std::bool_constant<!B::value> { };
+
struct negation : std::bool_constant<!bool(B::value)> { };
 
}}
 
}}
 +
 +
===Notes===
 +
{{feature test macro|__cpp_lib_logical_traits|std=C++17|value=201510L|[[cpp/meta#Operations on traits|Logical operator type traits]]}}
  
 
===Example===
 
===Example===
{{example}}
+
{{example
 +
|code=
 +
#include <type_traits>
 +
 
 +
static_assert(
 +
    std::is_same<
 +
        std::bool_constant<false>,
 +
        typename std::negation<std::bool_constant<true>>::type>::value,
 +
    "");
 +
static_assert(
 +
    std::is_same<
 +
        std::bool_constant<true>,
 +
        typename std::negation<std::bool_constant<false>>::type>::value,
 +
    "");
 +
 
 +
static_assert(std::negation_v<std::bool_constant<true>> == false);
 +
static_assert(std::negation_v<std::bool_constant<false>> == true);
 +
 
 +
int main() {}
 +
}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
{{dsc inc | cpp/types/dsc conjunction}}
+
{{dsc inc|cpp/types/dsc conjunction}}
{{dsc inc | cpp/types/dsc disjunction}}
+
{{dsc inc|cpp/types/dsc disjunction}}
 +
{{dsc inc|cpp/types/dsc integral_constant}}
 
{{dsc end}}
 
{{dsc end}}
  
[[de:cpp/types/negation]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
[[es:cpp/types/negation]]
+
[[fr:cpp/types/negation]]
+
[[it:cpp/types/negation]]
+
[[ja:cpp/types/negation]]
+
[[pt:cpp/types/negation]]
+
[[ru:cpp/types/negation]]
+
[[zh:cpp/types/negation]]
+

Latest revision as of 12:18, 24 September 2024

 
 
Metaprogramming library
Type traits
Type categories
(C++11)
(C++14)  
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Type properties
(C++11)
(C++11)
(C++14)
(C++11)
(C++11)(until C++20*)
(C++11)(deprecated in C++20)
(C++11)
Type trait constants
Metafunctions
negation
(C++17)
Supported operations
Relationships and property queries
Type modifications
(C++11)(C++11)(C++11)
Type transformations
(C++11)(deprecated in C++23)
(C++11)(deprecated in C++23)
(C++11)
(C++11)
(C++17)

(C++11)(until C++20*)(C++17)
Compile-time rational arithmetic
Compile-time integer sequences
 
Defined in header <type_traits>
template< class B >
struct negation;
(since C++17)

Forms the logical negation of the type trait B.

The type std::negation<B> is a UnaryTypeTrait with a base characteristic of std::bool_constant<!bool(B::value)>.

If the program adds specializations for std::negation or std::negation_v, the behavior is undefined.

Contents

[edit] Template parameters

B - any type such that the expression bool(B::value) is a valid constant expression

[edit] Helper variable template

template< class B >
constexpr bool negation_v = negation<B>::value;
(since C++17)

Inherited from std::integral_constant

Member constants

value
[static]
true if B has a member ::value that is false when explicitly converted to bool, false otherwise
(public static member constant)

Member functions

operator bool
converts the object to bool, returns value
(public member function)
operator()
(C++14)
returns value
(public member function)

Member types

Type Definition
value_type bool
type std::integral_constant<bool, value>

[edit] Possible implementation

template<class B>
struct negation : std::bool_constant<!bool(B::value)> { };

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_logical_traits 201510L (C++17) Logical operator type traits

[edit] Example

#include <type_traits>
 
static_assert(
    std::is_same<
        std::bool_constant<false>,
        typename std::negation<std::bool_constant<true>>::type>::value,
    "");
static_assert(
    std::is_same<
        std::bool_constant<true>,
        typename std::negation<std::bool_constant<false>>::type>::value,
    "");
 
static_assert(std::negation_v<std::bool_constant<true>> == false);
static_assert(std::negation_v<std::bool_constant<false>> == true);
 
int main() {}

[edit] See also

variadic logical AND metafunction
(class template) [edit]
variadic logical OR metafunction
(class template) [edit]
compile-time constant of specified type with specified value
(class template) [edit]