Namespaces
Variants
Views
Actions

std::modulus

From cppreference.com
< cpp‎ | utility‎ | functional
 
 
Utilities library
Language support
Type support (basic types, RTTI)
Library feature-test macros (C++20)
Dynamic memory management
Program utilities
Coroutine support (C++20)
Variadic functions
Debugging support
(C++26)
Three-way comparison
(C++20)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)

 
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)

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++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.

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;
(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.

[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]