# std::modulus

> C++ Atlas: `cppatlas.com/w/cpp/utility/functional/modulus` | Source: https://en.cppreference.com/w/cpp/utility/functional/modulus | Domain: Utility | Standards: C++11, C++14, C++17, C++20

Function object for computing remainders of divisions. Implements operator% for type T.

## Official Specification Summary (cppreference)

```cpp
// 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

(since C++14):

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>` (C++14): function object implementing `x % y` deducing parameter and return types (class template specialization)

#### 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)

#### Member functions

- `operator()`: returns the remainder from the division of the first argument by the second argument (public member function)

### std::modulus::operator()

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

#### Exceptions

May throw implementation-defined exceptions.

#### Possible implementation

```cpp
constexpr T operator()(const T& lhs, const T& rhs) const
{
    return lhs % rhs;
}
```

#### See also

- [`fmod`](https://en.cppreference.com/w/cpp/numeric/math/fmod), [`fmodf`](https://en.cppreference.com/w/cpp/numeric/math/fmod) (C++11), [`fmodl`](https://en.cppreference.com/w/cpp/numeric/math/fmod) (C++11): remainder of the floating point division operation (function)
- [`remainder`](https://en.cppreference.com/w/cpp/numeric/math/remainder) (C++11), [`remainderf`](https://en.cppreference.com/w/cpp/numeric/math/remainder) (C++11), [`remainderl`](https://en.cppreference.com/w/cpp/numeric/math/remainder) (C++11): signed remainder of the division operation (function)

---
Attribution: content from https://en.cppreference.com/w/cpp/utility/functional/modulus (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.