The modulus operator

The modulus operator (also informally known as the *remainder operator*) is an operator that returns the remainder after doing an integer division. For example, 7 / 4 = 1 remainder 3. Therefore, 7 % 4 = 3. As another example, 25 / 7 = 3 remainder 4, thus 25 % 7 = 4. Modulus only works with integer operands.

Modulus is most useful for testing whether a number is evenly divisible by another number (meaning that after division, there is no remainder): if *x % y* evaluates to 0, then we know that *x* is evenly divisible by *y*.

```
#include <iostream>
int main()
{
std::cout << "Enter an integer: ";
int x{};
std::cin >> x;
std::cout << "Enter another integer: ";
int y{};
std::cin >> y;
std::cout << "The remainder is: " << x % y << '\n';
if ((x % y) == 0)
std::cout << x << " is evenly divisible by " << y << '\n';
else
std::cout << x << " is not evenly divisible by " << y << '\n';
return 0;
}
```

Here are a couple runs of this program:

Enter an integer: 6 Enter another integer: 3 The remainder is: 0 6 is evenly divisible by 3

Enter an integer: 6 Enter another integer: 4 The remainder is: 2 6 is not evenly divisible by 4

Now let’s try an example where the second number is bigger than the first:

Enter an integer: 2 Enter another integer: 4 The remainder is: 2 2 is not evenly divisible by 4

A remainder of 2 might be a little non-obvious at first, but it’s simple: 2 / 4 is 0 (using integer division) remainder 2. Whenever the second number is larger than the first, the second number will divide the first 0 times, so the first number will be the remainder.

Modulus with negative numbers

The modulus operator can also work with negative operands. `x % y`

always returns results with the sign of *x*.

Running the above program:

Enter an integer: -6 Enter another integer: 4 The remainder is: -2 -6 is not evenly divisible by 4

Enter an integer: 6 Enter another integer: -4 The remainder is: 2 6 is not evenly divisible by -4

In both cases, you can see the remainder takes the sign of the first operand.

Where’s the exponent operator?

You’ll note that the *^* operator (commonly used to denote exponentiation in mathematics) is a *Bitwise XOR* operation in C++ (covered in lesson O.3 -- Bit manipulation with bitwise operators and bit masks). C++ does not include an exponent operator.

To do exponents in C++, #include the <cmath> header, and use the pow() function:

```
#include <cmath>
double x{ std::pow(3.0, 4.0) }; // 3 to the 4th power
```

Note that the parameters (and return value) of function pow() are of type double. Due to rounding errors in floating point numbers, the results of pow() may not be precise (even if you pass it integers or whole numbers).

If you want to do integer exponentiation, you’re best off using your own function to do so. The following function implements integer exponentiation (using the non-intuitive “exponentiation by squaring” algorithm for efficiency):

```
#include <iostream>
#include <cstdint> // for std::int64_t
#include <cassert> // for assert
// note: exp must be non-negative
std::int64_t powint(std::int64_t base, int exp)
{
assert(exp >= 0 && "powint: exp parameter has negative value");
std::int64_t result{ 1 };
while (exp)
{
if (exp & 1)
result *= base;
exp >>= 1;
base *= base;
}
return result;
}
int main()
{
std::cout << powint(7, 12); // 7 to the 12th power
return 0;
}
```

Produces:

13841287201

Don’t worry if you don’t understand how this function works -- you don’t need to understand it in order to call it.

Related content

We cover asserts in lesson 7.17 -- Assert and static_assert.

Warning

In the vast majority of cases, integer exponentiation will overflow the integral type. This is likely why such a function wasn’t included in the standard library in the first place.

Quiz time

Question #2

Write a program that asks the user to input an integer, and tells the user whether the number is even or odd. Write a function called isEven() that returns true if an integer passed to it is even, and false otherwise. Use the modulus operator to test whether the integer parameter is even.

Hint: You’ll need to use if statements and the comparison operator (==) for this program. See lesson 4.9 -- Boolean values if you need a refresher on how to do this.

Your program should match the following output:

Enter an integer: 5 5 is odd