BOOST_PP_MOD

The BOOST_PP_MOD macro expands to the modulus of its arguments.

Usage

BOOST_PP_MOD (x, y)

Arguments

x The dividend (numerator) of the operation. Valid values range from 0 to BOOST_PP_LIMIT_MAG. y The divisor (denominator) of the operation. Valid values range from 1 to BOOST_PP_LIMIT_MAG.

Remarks

Previously, this macro could not be used inside BOOST_PP_WHILE. There is no longer any such restriction. It is more efficient, however, to use BOOST_PP_MOD_D in such a situation.

If y is 0, the result is undefined.

See Also

• BOOST_PP_LIMIT_MAG
• BOOST_PP_MOD_D

Requirements

Header: <boost/preprocessor/arithmetic/mod.hpp>

Sample Code

#include <[boost/preprocessor/arithmetic/mod.hpp](../headers/arithmetic/mod.html)>[BOOST\_PP\_MOD](mod.html)(11, 5) // expands to 1

Copyright Housemarque Oy 2002 Copyright Paul Mensonides 2002

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)