Namespaces
Variants
Views
Actions

std::modulus

From cppreference.com
< cpp‎ | utility‎ | functional
Revision as of 16:51, 9 November 2013 by Cubbi (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
 
 
 
Function objects
Function wrappers
(C++11)
(C++11)
Bind
(C++11)
Reference wrappers
(C++11)(C++11)
Operator wrappers
Negators
Deprecated 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 T >
struct modulus;
(until C++14)
template< class T = void >
struct modulus;
(since C++14)

Function object for computing remainders of divisions. Implements operator% for type T.

Contents

[edit] Specializations

The standard library provides a specialization of std::modulus when T is not specified, which leaves the parameter types and return type to be deduced.

function object implementing x % y deducing argument and return types
(class template specialization) [edit]
(since C++14)

[edit] Member types

Type Definition
result_type T
first_argument_type T
second_argument_type T

[edit] Member functions

operator()
returns the remainder from the division of the first argument by the second argument
(public member function)

std::modulus::operator()

T operator()( const T& lhs, const T& rhs ) const;
(until C++14)
constexpr T operator()( const T& lhs, const T& rhs ) const;
(since C++14)

Returns the remainder of the division of lhs by rhs.

Parameters

lhs, rhs - values to divide one by another

Return value

The result of lhs % rhs.

Exceptions

(none)

Possible implementation

constexpr T operator()(const T &lhs, const T &rhs) const 
{
    return lhs % rhs;
}