Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/functional/modulus"

From cppreference.com
< cpp‎ | utility‎ | functional
m (Text replace - "{{member frame" to "{{member")
m (~)
 
(18 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{cpp/title|modulus}}
 
{{cpp/title|modulus}}
−
{{cpp/utility/functional/sidebar}}
+
{{cpp/utility/functional/navbar}}
−
{{ddcl list begin}}
+
 
−
{{ddcl list header | functional }}
+
{{dcl begin}}
−
{{ddcl list item |
+
{{dcl header|functional}}
 +
{{dcl rev begin}}
 +
{{dcl|until=c++14|
 
template< class T >
 
template< class T >
 
struct modulus;
 
struct modulus;
 
}}
 
}}
−
{{ddcl list end}}
+
{{dcl|since=c++14|
 +
template< class T {{=}} void >
 +
struct modulus;
 +
}}
 +
{{dcl rev end}}
 +
{{dcl end}}
  
−
Function object for computing remainders of divisions. Implements {{cpp|operator%}} for type {{tt|T}}.
+
Function object for computing remainders of divisions. Implements {{c|operator%}} for type {{tt|T}}.
  
−
===Member types===
+
===Specializations===
−
{{tdcl list begin}}
+
{{rev begin}}
−
{{tdcl list hitem | Type | Definition }}
+
{{rev|since=c++14|
−
{{tdcl list item | {{tt|result_type}} | {{tt|T}}}}
+
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.
−
{{tdcl list item | {{tt|first_argument_type}} | {{tt|T}} }}
+
{{dsc begin}}
−
{{tdcl list item | {{tt|second_argument_type}} | {{tt|T}} }}
+
{{dsc inc|cpp/utility/functional/dsc modulus_void}}
−
{{tdcl list end}}
+
{{dsc end}}
 +
}}
 +
{{rev end}}
 +
 
 +
{{cpp/utility/functional/member types|result=T|arg1=T|arg2=T}}
  
 
===Member functions===
 
===Member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list 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}}
−
{{dcl list end}}
+
{{dsc end}}
  
−
{{member | {{small|std::modulus::}}operator() | 2=
+
{{member|{{small|std::modulus::}}operator()|2=
−
{{ddcl | 1=
+
{{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}}
  
−
Returns the remainder of the division of {{tt|lhs}} by {{tt|rhs}}.
+
Returns the remainder of the division of {{c|lhs}} by {{c|rhs}}.
  
 
===Parameters===
 
===Parameters===
−
{{param list begin}}
+
{{par begin}}
−
{{param list item | lhs, rhs | values to divide one by another}}
+
{{par|lhs, rhs|values to divide one by another}}
−
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
−
The result of {{cpp|lhs % rhs}}.
+
The result of {{c|lhs % rhs}}.
  
−
===Exceptions===
+
{{cpp/impldef exception}}
−
(none)
+
  
−
===Equivalent function===
+
===Possible implementation===
−
{{eq fun cpp | 1=
+
{{eq fun|1=
−
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 50: Line 62:
 
}}
 
}}
 
}}
 
}}
 +
 +
===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

 
C++
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Function objects
Function invocation
(C++17)(C++23)
Identity function object
(C++20)
Transparent operator wrappers
(C++14)
(C++14)
(C++14)
(C++14)  
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)

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

(C++14)
 function object implementing x % y deducing parameter and return types
(class template specialization) [edit]
(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) [edit]
(C++11)(C++11)(C++11)
 signed remainder of the division operation
(function) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/utility/functional/modulus&oldid=173627"