std::binary_function

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

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)

Filesystem library (C++17)

Technical Specifications

Utilities library

Type support (basic types, RTTI, type traits)
Dynamic memory management
Error handling
Program utilities
Variadic functions
Library feature-test macros
Date and time
Function objects
initializer_list (C++11)
bitset
hash (C++11)
integer_sequence (C++14)
Relational operators (deprecated)
rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=
Comparisons (C++20)
strong_order weak_order partial_order strong_equal weak_equal	strong_ordering weak_ordering partial_ordering strong_equality weak_equality	is_eqis_neqis_ltis_lteqis_gtis_gteq
common_comparison_category
Common vocabulary types
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
Swap, forward and move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
Elementary string conversions
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
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)	Bind bind (C++11) is_bind_expression (C++11) is_placeholder (C++11) _1, _2, _3, ... (C++11)
Function invocation invoke (C++17) Identity function object identity (C++20)	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
not_fn (C++17)
Searchers
default_searcher (C++17)
boyer_moore_searcher (C++17)
boyer_moore_horspool_searcher (C++17)
Old 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) not1 (until C++20) not2 (until C++20)	binder1stbinder2nd (until C++17)(until C++17) bind1stbind2nd (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) unary_negate (until C++20) binary_negate (until C++20)

Defined in header <functional>
template< class Arg1, class Arg2, class Result > struct binary_function;		(deprecated in C++11) (removed in C++17)

binary_function is a base class for creating function objects with two arguments.

binary_function does not define operator(); it is expected that derived classes will define this. binary_function provides only three types - first_argument_type, second_argument_type and result_type - defined by the template parameters.

Some standard library function object adaptors, such as std::not2, require the function objects they adapt to have certain types defined; std::not2 requires the function object being adapted to have two types named first_argument_type and second_argument_type. Deriving function objects that take two arguments from binary_function is an easy way to make them compatible with those adaptors.

binary_function is deprecated in C++11 and removed in C++17.

Member types

Type	Definition
first_argument_type	Arg1
second_argument_type	Arg2
result_type	Result

Example

Run this code

#include <algorithm>
#include <functional>
#include <iostream>
#include <vector>

struct same : std::binary_function<int, int, bool>
{
    bool operator()(int a, int b) const { return a == b; }
};

int main()
{
    std::vector<int> v1{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
    std::vector<int> v2{10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0 };
    std::vector<bool> v3(v1.size());

    std::transform(v1.begin(), v1.end(), v2.begin(), v3.begin(), std::not2(same()));

    std::cout << std::boolalpha;
    for (std::size_t i = 0; i < v1.size(); ++i)
        std::cout << v1[i] << ' ' << v2[i] << ' ' << v3[i] << '\n';
}

Output:

0 10 true
1 9 true
2 8 true
3 7 true
4 6 true
5 5 false
6 4 true
7 3 true
8 2 true
9 1 true
10 0 true

See also

function (C++11)	wraps callable object of any type with specified function call signature (class template)
ptr_fun (deprecated in C++11)(removed in C++17)	creates an adaptor-compatible function object wrapper from a pointer to function (function template)
pointer_to_binary_function (deprecated in C++11)(removed in C++17)	adaptor-compatible wrapper for a pointer to binary function (class template)
unary_function (deprecated in C++11)(removed in C++17)	adaptor-compatible unary function base class (class template)