Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/functional/negate"

From cppreference.com
< cpp‎ | utility‎ | functional
(Created Page)
 
m (~)
 
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{cpp/title|negate}}
 
{{cpp/title|negate}}
{{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 negate;
 
struct negate;
 
}}
 
}}
{{ddcl list end}}
+
{{dcl|since=c++14|
 +
template< class T {{=}} void >
 +
struct negate;
 +
}}
 +
{{dcl rev end}}
 +
{{dcl end}}
  
Function object for performing negation.
+
Function object for performing negation. Effectively calls {{c|operator-}} on an instance of 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|T}}}}
+
The standard library provides a specialization of {{tt|std::negate}} 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 negate_void}}
 +
{{dsc end}}
 +
}}
 +
{{rev end}}
 +
 
 +
{{cpp/utility/functional/member types|result=T|arg1=T}}
  
 
===Member functions===
 
===Member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list mem fun | cpp/utility/functional/negate/operator() | Returns the negation of its argument}}
+
{{dsc mem fun|operator()|nolink=true|returns the negation of the argument}}
{{dcl list end}}
+
{{dsc end}}
 +
 
 +
{{member|{{small|std::negate::}}operator()|2=
 +
{{dcl begin}}
 +
{{dcla|constexpr=c++14|1=
 +
T operator()( const T& arg ) const;
 +
}}
 +
{{dcl end}}
 +
 
 +
Returns the negation of {{c|arg}}.
 +
 
 +
===Parameters===
 +
{{par begin}}
 +
{{par|arg|value to compute negation of}}
 +
{{par end}}
 +
 
 +
===Return value===
 +
The result of {{c|-arg}}.
 +
 
 +
{{cpp/impldef exception}}
 +
 
 +
===Possible implementation===
 +
{{eq fun|1=
 +
constexpr T operator()(const T& arg) const
 +
{
 +
    return -arg;
 +
}
 +
}}
 +
}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 21:06, 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 negate;
(until C++14)
template< class T = void >
struct negate;
(since C++14)

Function object for performing negation. Effectively calls operator- on an instance of type T.

Contents

[edit] Specializations

The standard library provides a specialization of std::negate 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) T
argument_type (deprecated in C++17)(removed in C++20) T

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

(until C++11)

[edit] Member functions

operator()
returns the negation of the argument
(public member function)

std::negate::operator()

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

Returns the negation of arg.

Parameters

arg - value to compute negation of

Return value

The result of -arg.

[edit] Exceptions

May throw implementation-defined exceptions.

Possible implementation

constexpr T operator()(const T& arg) const 
{
    return -arg;
}