W3cubDocs

/C++

std::modulus

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.

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.

modulus<void>

function object implementing x % y deducing argument and return types
(class template specialization)

(since C++14)

Member types

Type	Definition
`result_type`(deprecated in C++17)	`T`
`first_argument_type`(deprecated in C++17)	`T`
`second_argument_type`(deprecated in C++17)	`T`

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;
}

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://en.cppreference.com/w/cpp/utility/functional/modulus