std::modulus<void>

From cppreference.com
< cpp‎ | utility‎ | functional
 
 
 
Function objects


Function wrappers
(C++11)
(C++11)
(C++17)
Bind
(C++11)
Reference wrappers
(C++11)(C++11)
Operator wrappers
Negators
(deprecated)
(deprecated)

(deprecated)
(deprecated)
Searchers
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++17)
(until C++17)(until C++17)

(until C++17)
(until C++17)(until C++17)(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.

Example