C++ concepts: BinaryPredicate

 

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)

 

C++ concepts

Basic
DefaultConstructible CopyAssignable CopyConstructible	MoveAssignable (C++11) MoveConstructible (C++11) Destructible
Library-Wide
EqualityComparable LessThanComparable Swappable (C++11) ValueSwappable (C++11)	NullablePointer (C++11) Hash (C++11) Allocator
Container
Container SequenceContainer ReversibleContainer	AssociativeContainer AllocatorAwareContainer UnorderedAssociativeContainer (C++11)
Container Elements
CopyInsertable (C++11) MoveInsertable (C++11)	EmplaceConstructible (C++11)
Iterator
Iterator OutputIterator InputIterator	ForwardIterator BidirectionalIterator RandomAccessIterator
Stream I/O
FormattedInputFunction UnformattedInputFunction	FormattedOutputFunction UnformattedOutputFunction
Random Numbers
SeedSequence (C++11) RandomNumberEngine (C++11)	RandomNumberDistribution (C++11) UniformRandomNumberGenerator (C++11) RandomNumberEngineAdaptor (C++11)
Concurrency
BasicLockable (C++11) Lockable (C++11) TimedLockable (C++11)	Mutex (C++11) TimedMutex (C++11)
Other
CharTraits pos_type off_type Clock (C++11)	UnaryTypeTrait (C++11) BinaryTypeTrait (C++11) TransformationTrait (C++11) TrivialClock (C++11)

 

The concept BinaryPredicate is a set of requirements expected by some of the standard library facilities from the user-provided arguments.

Given a BinaryPredicate bin_pred and a pair of iterators iter1 and iter2 or an iterator iter and a value value, the expression bin_pred(*iter1, *iter2) or, respectively, bin_pred(*iter, value), must be contextually convertible to bool.

In addition, evaluation of that expression is not allowed to call non-const member functions of the dereferenced iterators.

Requirements

• Callable
• Copyable (unless otherwise specified)

Standard library

The following standard library facilities expect a BinaryPredicate which isn't a Compare type.

unique	removes consecutive duplicate elements (public member function of std::forward_list)
unique	removes consecutive duplicate elements (public member function of std::list)
find_end	finds the last sequence of elements in a certain range (function template)
find_first_of	searches for any one of a set of elements (function template)
adjacent_find	finds two identical (or some other relationship) items adjacent to each other (function template)
mismatch	finds the first position where two ranges differ (function template)
equal	determines if two sets of elements are the same (function template)
is_permutation (C++11)	determines if a sequence is a permutation of another sequence (function template)
search	searches for a range of elements (function template)
search_n	searches for a number consecutive copies of an element in a range (function template)
unique	removes consecutive duplicate elements in a range (function template)
unique_copy	creates a copy of some range of elements that contains no consecutive duplicates (function template)
not2	constructs custom std::binary_negate object (function template)
unordered_set (since C++11)	collection of unique keys, hashed by keys (class template)
unordered_map (since C++11)	collection of key-value pairs, hashed by keys, keys are unique (class template)
unordered_multiset (since C++11)	collection of keys, hashed by keys (class template)
unordered_multimap (since C++11)	collection of key-value pairs, hashed by keys (class template)