Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/functional/logical not"

From cppreference.com
< cpp‎ | utility‎ | functional
m (Text replace - "{{cpp|" to "{{c|")
m (~)
 
(16 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{cpp/title|logical_not}}
 
{{cpp/title|logical_not}}
{{cpp/utility/functional/sidebar}}
+
{{cpp/utility/functional/navbar}}
{{ddcl list begin}}
+
{{dcl begin}}
{{ddcl list header | functional }}
+
{{dcl header|functional}}
{{ddcl list item |
+
{{dcl rev begin}}
 +
{{dcl|until=c++14|
 
template< class T >
 
template< class T >
 
struct logical_not;
 
struct logical_not;
 
}}
 
}}
{{ddcl list end}}
+
{{dcl|since=c++14|
 +
template< class T {{=}} void >
 +
struct logical_not;
 +
}}
 +
{{dcl rev end}}
 +
{{dcl end}}
  
 
Function object for performing logical NOT (logical negation). Effectively calls {{c|operator!}} for type {{tt|T}}.
 
Function object for performing logical NOT (logical negation). Effectively calls {{c|operator!}} for type {{tt|T}}.
  
===Member types===
+
===Specializations===
{{tdcl list begin}}
+
{{rev begin}}
{{tdcl list hitem | Type | Definition }}
+
{{rev|since=c++14|
{{tdcl list item | {{tt|result_type}} | {{tt|bool}}}}
+
The standard library provides a specialization of {{tt|std::logical_not}} when {{tt|T}} is not specified, which leaves the parameter types and return type to be deduced.
{{tdcl list item | {{tt|argument_type}} | {{tt|T}} }}
+
{{dsc begin}}
{{tdcl list end}}
+
{{dsc inc|cpp/utility/functional/dsc logical_not_void}}
 +
{{dsc end}}
 +
}}
 +
{{rev end}}
 +
 
 +
{{cpp/utility/functional/member types|result=bool|arg1=T}}
  
 
===Member functions===
 
===Member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list mem fun | operator() | nolink=true | returns the logical NOT of the argument}}
+
{{dsc mem fun|operator()|nolink=true|returns the logical NOT of the argument}}
{{dcl list end}}
+
{{dsc end}}
  
{{member | {{small|std::logical_not::}}operator() | 2=
+
{{member|{{small|std::logical_not::}}operator()|2=
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcla|constexpr=c++14|1=
 
bool operator()( const T& arg ) const;
 
bool operator()( const T& arg ) const;
 
}}
 
}}
 +
{{dcl end}}
  
Returns the logical NOT of {{tt|arg}}.
+
Returns the logical NOT of {{c|arg}}.
  
 
===Parameters===
 
===Parameters===
{{param list begin}}
+
{{par begin}}
{{param list item | arg | value to compute logical NOT of}}
+
{{par|arg|value to compute logical NOT of}}
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
 
The result of {{c|!arg}}.
 
The result of {{c|!arg}}.
  
===Exceptions===
+
{{cpp/impldef exception}}
(none)
+
  
 
===Possible implementation===
 
===Possible implementation===
{{eq fun cpp | 1=
+
{{eq fun|1=
bool operator()(const T &arg) const  
+
constexpr // since C++14
 +
bool operator()(const T& arg) const  
 
{
 
{
 
     return !arg;
 
     return !arg;
Line 49: Line 62:
 
}}
 
}}
 
}}
 
}}
 +
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 21:17, 13 July 2024

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Function objects
Function invocation
(C++17)(C++23)
Identity function object
(C++20)
Transparent operator wrappers
(C++14)
(C++14)
(C++14)
(C++14)  
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)

Old binders and adaptors
(until C++17*)
(until C++17*)
(until C++17*)
(until C++17*)  
(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
(until C++17*)(until C++17*)
(until C++17*)(until C++17*)

(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
 
Defined in header <functional>
template< class T >
struct logical_not;
(until C++14)
template< class T = void >
struct logical_not;
(since C++14)

Function object for performing logical NOT (logical negation). Effectively calls operator! for type T.

Contents

[edit] Specializations

The standard library provides a specialization of std::logical_not when T is not specified, which leaves the parameter types and return type to be deduced.

function object implementing !x deducing parameter and return types
(class template specialization) [edit]
(since C++14)

[edit] Member types

Type Definition
result_type (deprecated in C++17)(removed in C++20) bool
argument_type (deprecated in C++17)(removed in C++20) T

These member types are obtained via publicly inheriting std::unary_function<T, bool>.

(until C++11)

[edit] Member functions

operator()
returns the logical NOT of the argument
(public member function)

std::logical_not::operator()

bool operator()( const T& arg ) const;
(constexpr since C++14)

Returns the logical NOT of arg.

Parameters

arg - value to compute logical NOT of

Return value

The result of !arg.

[edit] Exceptions

May throw implementation-defined exceptions.

Possible implementation

constexpr // since C++14
bool operator()(const T& arg) const 
{
    return !arg;
}