Difference between revisions of "cpp/utility/functional/modulus"
From cppreference.com
< cpp | utility | functional
m (forgot c++14 in the declaration) |
m (~) |
||
| (7 intermediate revisions by 5 users not shown) | |||
| Line 3: | Line 3: | ||
{{dcl begin}} | {{dcl begin}} | ||
| − | {{dcl header | functional }} | + | {{dcl header|functional}} |
{{dcl rev begin}} | {{dcl rev begin}} | ||
| − | {{dcl | until=c++14 | | + | {{dcl|until=c++14| |
template< class T > | template< class T > | ||
struct modulus; | struct modulus; | ||
}} | }} | ||
| − | {{dcl | since=c++14 | | + | {{dcl|since=c++14| |
template< class T {{=}} void > | template< class T {{=}} void > | ||
struct modulus; | struct modulus; | ||
| Line 20: | Line 20: | ||
===Specializations=== | ===Specializations=== | ||
{{rev begin}} | {{rev begin}} | ||
| − | {{rev | since=c++14 | | + | {{rev|since=c++14| |
The standard library provides a specialization of {{tt|std::modulus}} when {{tt|T}} is not specified, which leaves the parameter types and return type to be deduced. | The standard library provides a specialization of {{tt|std::modulus}} when {{tt|T}} is not specified, which leaves the parameter types and return type to be deduced. | ||
{{dsc begin}} | {{dsc begin}} | ||
| − | {{dsc inc | cpp/utility/functional/dsc modulus_void}} | + | {{dsc inc|cpp/utility/functional/dsc modulus_void}} |
{{dsc end}} | {{dsc end}} | ||
}} | }} | ||
{{rev end}} | {{rev end}} | ||
| − | + | {{cpp/utility/functional/member types|result=T|arg1=T|arg2=T}} | |
| − | {{ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
===Member functions=== | ===Member functions=== | ||
{{dsc begin}} | {{dsc begin}} | ||
| − | {{dsc mem fun | operator() | nolink=true | returns the remainder from the division of the first argument by the second argument}} | + | {{dsc mem fun|operator()|nolink=true|returns the remainder from the division of the first argument by the second argument}} |
{{dsc end}} | {{dsc end}} | ||
| − | {{member | {{small|std::modulus::}}operator() | 2= | + | {{member|{{small|std::modulus::}}operator()|2= |
{{dcl begin}} | {{dcl begin}} | ||
| − | {{ | + | {{dcla|constexpr=c++14|1= |
| − | + | ||
T operator()( const T& lhs, const T& rhs ) const; | T operator()( const T& lhs, const T& rhs ) const; | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
| − | |||
{{dcl end}} | {{dcl end}} | ||
| − | Returns the remainder of the division of {{ | + | Returns the remainder of the division of {{c|lhs}} by {{c|rhs}}. |
===Parameters=== | ===Parameters=== | ||
{{par begin}} | {{par begin}} | ||
| − | {{par | lhs, rhs | values to divide one by another}} | + | {{par|lhs, rhs|values to divide one by another}} |
{{par end}} | {{par end}} | ||
| Line 63: | Line 52: | ||
The result of {{c|lhs % rhs}}. | The result of {{c|lhs % rhs}}. | ||
| − | + | {{cpp/impldef exception}} | |
| − | + | ||
===Possible implementation=== | ===Possible implementation=== | ||
| − | {{eq fun | 1= | + | {{eq fun|1= |
| − | constexpr T operator()(const T &lhs, const T &rhs) const | + | constexpr T operator()(const T& lhs, const T& rhs) const |
{ | { | ||
return lhs % rhs; | return lhs % rhs; | ||
| Line 75: | Line 63: | ||
}} | }} | ||
| − | + | ===See also=== | |
| − | + | {{dsc begin}} | |
| − | + | {{dsc inc|cpp/numeric/math/dsc fmod}} | |
| − | + | {{dsc inc|cpp/numeric/math/dsc remainder}} | |
| − | + | {{dsc end}} | |
| − | + | ||
| − | + | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} | |
| − | + | ||
Latest revision as of 21:10, 13 July 2024
| 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
|
(since C++14) |
[edit] Member types
| Type | Definition |
result_type (deprecated in C++17)(removed in C++20)
|
T
|
first_argument_type (deprecated in C++17)(removed in C++20)
|
T
|
second_argument_type (deprecated in C++17)(removed in C++20)
|
T
|
|
These member types are obtained via publicly inheriting std::binary_function<T, T, T>. |
(until C++11) |
[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; |
(constexpr 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.
[edit] Exceptions
May throw implementation-defined exceptions.
Possible implementation
constexpr T operator()(const T& lhs, const T& rhs) const { return lhs % rhs; } |
[edit] See also
| (C++11)(C++11) |
remainder of the floating point division operation (function) |
| (C++11)(C++11)(C++11) |
signed remainder of the division operation (function) |
