std::unary_negate

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)

Dynamic memory management

Error handling

Program utilities

Variadic functions

Date and time

Function objects

initializer_list (C++11)

bitset

hash (C++11)

Relational operators

rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=

Pairs and tuples

pair

tuple (C++11)

piecewise_construct_t (C++11)

piecewise_construct (C++11)

integer_sequence (C++14)

Swap, forward and move

swap

exchange (C++14)

forward (C++11)

move (C++11)

move_if_noexcept (C++11)

Type operations

declval (C++11)

as_const (C++17)

 

Function objects

Function wrappers
function (C++11)
mem_fn (C++11)
bad_function_call (C++11)
invoke (C++17)
Bind
bind (C++11)
is_bind_expression (C++11)
is_placeholder (C++11)
_1, _2, _3, ... (C++11)
Reference wrappers
reference_wrapper (C++11)
refcref (C++11)(C++11)
Operator wrappers
plus minus negate multiplies divides modulus logical_and logical_or logical_not	equal_to not_equal_to greater less greater_equal less_equal bit_and bit_or bit_xor bit_not (C++14)
Negators
unary_negate binary_negate	not1 not2
Deprecated binders and adaptors
unary_function (until C++17)
binary_function (until C++17)
ptr_fun (until C++17)
pointer_to_unary_function (until C++17)
pointer_to_binary_function (until C++17)
mem_fun (until C++17)
mem_fun_tmem_fun1_tconst_mem_fun_tconst_mem_fun1_t (until C++17)(until C++17)(until C++17)(until C++17)
mem_fun_ref (until C++17)
mem_fun_ref_tmem_fun1_ref_tconst_mem_fun_ref_tconst_mem_fun1_ref_t (until C++17)(until C++17)(until C++17)(until C++17)
binder1stbinder2nd (until C++17)(until C++17)
bind1stbind2nd (until C++17)(until C++17)

 

Defined in header <functional>
template< class Predicate > struct unary_negate : public std::unary_function<Predicate::argument_type, bool>;		(until C++11)
template< class Predicate > struct unary_negate;		(since C++11)

unary_negate is a wrapper function object returning the complement of the unary predicate it holds.

The unary predicate type must define a member type, argument_type, that is convertible to the predicate's parameter type. The unary function objects obtained from std::ref, std::cref, std::negate, std::logical_not, std::mem_fn, std::function, std::hash, or from another call to std::not1 have this type defined, as are function objects derived from the deprecated std::unary_function.

unary_negate objects are easily constructed with helper function std::not1.

Member types

Type	Definition
argument_type	Predicate::argument_type
result_type	bool

Member functions

(constructor)	constructs a new unary_negate object with the supplied predicate (public member function)
operator()	returns the logical complement of the result of a call to the stored predicate (public member function)

std::unary_negate::unary_negate

explicit unary_negate( Predicate const& pred );		(until C++14)
explicit constexpr unary_negate( Predicate const& pred );		(since C++14)

Constructs a unary_negate function object with the stored predicate pred.

Parameters

pred

-

predicate function object

std::unary_negate::operator()

bool operator()( argument_type const& x ) const;		(until C++14)
constexpr bool operator()( argument_type const& x ) const;		(since C++14)

Returns the logical complement of the result of calling pred(x).

Parameters

x

-

argument to pass through to predicate

Return value

The logical complement of the result of calling pred(x).

Example

Run this code

#include <algorithm>
#include <functional>
#include <iostream>
#include <vector>
 
struct less_than_7 : std::unary_function<int, bool>
{
    bool operator()(int i) const { return i < 7; }
};
 
int main()
{
    std::vector<int> v;
    for (int i = 0; i < 10; ++i) v.push_back(i);
 
    std::unary_negate<less_than_7> not_less_than_7((less_than_7()));
 
    std::cout << std::count_if(v.begin(), v.end(), not_less_than_7);
 
    /* C++11 solution:
        // Use std::function<bool (int)>
        std::function<bool (int)> not_less_than_7 =
            [](int x)->bool{ return !less_than_7()(x); };
 
        std::cout << std::count_if(v.begin(), v.end(), not_less_than_7);
    */
}

Output:

3

See also

binary_negate	wrapper function object returning the complement of the binary predicate it holds (class template)
function (C++11)	wraps callable object of any type with specified function call signature (class template)
not1	constructs custom std::unary_negate object (function template)
ptr_fun (until C++17)	creates an adaptor-compatible function object wrapper from a pointer to function (function template)
unary_function (until C++17)	adaptor-compatible unary function base class (class template)