std::modulus<void>

 

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)

declval (C++11)

 

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 modulus<void>;		(since C++14)

std::modulus<> is a specialization of std::modulus with parameter and return type deduced.

Member types

Member type	Definition
is_transparent	/* unspecified */

Member functions

operator()

returns the modulus of two arguments (public member function)

std::modulus<>::operator()

template< class T, class U> constexpr auto operator()( T&& lhs, U&& rhs ) const   -> decltype(std::forward<T>(lhs) % std::forward<U>(rhs));

Returns the remainder of the division of lhs by rhs (or whatever operator% is overloaded to do)

Parameters

lhs, rhs

-

values to divide

Return value

The result of lhs % rhs.

Notes

The member type is_transparent indicates to the caller that this function object is a transparent function object: it accepts arguments of arbitrary types and uses perfect forwarding, which avoids unnecessary copying and conversion when the function object is used in heterogeneous context, or with rvalue arguments. In particular, template functions such as std::set::find and std::set::lower_bound make use of this member type on their Compare types.