std::modulus - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# std::modulus

From cppreference.com
< cpp‎ | utility‎ | functional

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

### [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.
modulus<void> | 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;
    }

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/utility/functional/modulus&oldid=66246"