2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" / >
2004-11-28 03:35:12 +00:00
< title > The MPL Reference Manual: modulus< / title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" / >
< / head >
< body class = "docframe refmanual" >
< table class = "header" > < tr class = "header" > < td class = "header-group navigation-bar" > < span class = "navigation-group" > < a href = "./divides.html" class = "navigation-link" > Prev< / a > < a href = "./negate.html" class = "navigation-link" > Next< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./divides.html" class = "navigation-link" > Back< / a > < a href = "./negate.html" class = "navigation-link" > Along< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./arithmetic-operations.html" class = "navigation-link" > Up< / a > < a href = "../refmanual.html" class = "navigation-link" > Home< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC< / a > < / span > < / td >
< td class = "header-group page-location" > < a href = "../refmanual.html" class = "navigation-link" > Front Page< / a > / < a href = "./metafunctions.html" class = "navigation-link" > Metafunctions< / a > / < a href = "./arithmetic-operations.html" class = "navigation-link" > Arithmetic Operations< / a > / < a href = "./modulus.html" class = "navigation-link" > modulus< / a > < / td >
< / tr > < / table > < div class = "header-separator" > < / div >
< div class = "section" id = "modulus" >
2010-08-09 20:07:24 +00:00
< h1 > < a class = "toc-backref" href = "./arithmetic-operations.html#id1540" > modulus< / a > < / h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id996" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#synopsis" name = "synopsis" > Synopsis< / a > < / h3 >
< pre class = "literal-block" >
template<
typename T1
, typename T2
>
struct < a href = "./modulus.html" class = "identifier" > modulus< / a >
{
typedef < em > unspecified< / em > type;
};
< / pre >
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id997" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#description" name = "description" > Description< / a > < / h3 >
< p > Returns the modulus of its arguments.< / p >
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id998" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#header" name = "header" > Header< / a > < / h3 >
< pre class = "literal-block" >
#include < < a href = "../../../../boost/mpl/modulus.hpp" class = "header" > boost/mpl/modulus.hpp< / a > >
#include < < a href = "../../../../boost/mpl/arithmetic.hpp" class = "header" > boost/mpl/arithmetic.hpp< / a > >
< / pre >
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id999" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#model-of" name = "model-of" > Model of< / a > < / h3 >
2009-08-17 11:30:52 +00:00
< p > < a class = "reference internal" href = "./numeric-metafunction.html" > Numeric Metafunction< / a > < / p >
2004-11-28 03:35:12 +00:00
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1000" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#parameters" name = "parameters" > Parameters< / a > < / h3 >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "17%" / >
< col width = "30%" / >
< col width = "53%" / >
< / colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr > < th class = "head" > Parameter< / th >
< th class = "head" > Requirement< / th >
< th class = "head" > Description< / th >
2004-11-28 03:35:12 +00:00
< / tr >
< / thead >
< tbody valign = "top" >
< tr > < td > < tt class = "literal" > < span class = "pre" > T1< / span > < / tt > , < tt class = "literal" > < span class = "pre" > T2< / span > < / tt > < / td >
2009-08-17 11:30:52 +00:00
< td > < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > < / td >
2004-11-28 03:35:12 +00:00
< td > Operation's arguments.< / td >
< / tr >
< / tbody >
< / table >
< p > [< em > Note:< / em > The requirements listed in this specification
2009-08-17 11:30:52 +00:00
are the ones imposed by the default implementation. See < a class = "reference internal" href = "./numeric-metafunction.html" > Numeric Metafunction< / a > concept
for the details on how to provide an implementation for a user-defined numeric type
that does not satisfy the < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > requirements. — < em > end note< / em > ]< / p >
2004-11-28 03:35:12 +00:00
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1001" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics< / a > < / h3 >
2009-08-17 11:30:52 +00:00
< p > For any < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > s < tt class = "literal" > < span class = "pre" > c1< / span > < / tt > and < tt class = "literal" > < span class = "pre" > c2< / span > < / tt > :< / p >
2004-11-28 03:35:12 +00:00
< pre class = "literal-block" >
typedef < a href = "./modulus.html" class = "identifier" > modulus< / a > < c1,c2> ::type r;
< / pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr class = "field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > .< / p >
< / td >
2004-11-28 03:35:12 +00:00
< / tr >
2009-08-17 11:30:52 +00:00
< tr class = "field" > < th class = "field-name" > Precondition:< / th > < td class = "field-body" > < p class = "first" > < tt class = "literal" > < span class = "pre" > c2::value< / span > < span class = "pre" > !=< / span > < span class = "pre" > 0< / span > < / tt > < / p >
< / td >
2004-11-28 03:35:12 +00:00
< / tr >
< tr class = "field" > < th class = "field-name" > Semantics:< / th > < td class = "field-body" > < p class = "first" > Equivalent to< / p >
< pre class = "last literal-block" >
typedef < a href = "./integral-c.html" class = "identifier" > integral_c< / a > <
typeof(c1::value % c2::value)
, ( c1::value % c2::value )
> r;
< / pre >
< / td >
< / tr >
< / tbody >
< / table >
<!-- .......................................................................... -->
< pre class = "literal-block" >
typedef < a href = "./modulus.html" class = "identifier" > modulus< / a > < c1,c2> r;
< / pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr class = "field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > .< / p >
< / td >
2004-11-28 03:35:12 +00:00
< / tr >
2009-08-17 11:30:52 +00:00
< tr class = "field" > < th class = "field-name" > Precondition:< / th > < td class = "field-body" > < p class = "first" > < tt class = "literal" > < span class = "pre" > c2::value< / span > < span class = "pre" > !=< / span > < span class = "pre" > 0< / span > < / tt > < / p >
< / td >
2004-11-28 03:35:12 +00:00
< / tr >
< tr class = "field" > < th class = "field-name" > Semantics:< / th > < td class = "field-body" > < p class = "first" > Equivalent to< / p >
< pre class = "last literal-block" >
struct r : < a href = "./modulus.html" class = "identifier" > modulus< / a > < c1,c2> ::type {};
< / pre >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1002" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#complexity" name = "complexity" > Complexity< / a > < / h3 >
< p > Amortized constant time.< / p >
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1003" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#example" name = "example" > Example< / a > < / h3 >
< pre class = "literal-block" >
typedef < a href = "./modulus.html" class = "identifier" > modulus< / a > < < a href = "./int.html" class = "identifier" > int_< / a > < 10> , < a href = "./long.html" class = "identifier" > long_< / a > < 3> > ::type r;
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION< / a > ( r::value, ==, 1 );
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT< / a > (( is_same< r::< a href = "./value-type.html" class = "identifier" > value_type< / a > , long > ));
< / pre >
< / div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1004" >
2004-11-28 03:35:12 +00:00
< h3 > < a class = "subsection-title" href = "#see-also" name = "see-also" > See also< / a > < / h3 >
2009-08-17 11:30:52 +00:00
< p > < a class = "reference internal" href = "./metafunctions.html" > Metafunctions< / a > , < a class = "reference internal" href = "./numeric-metafunction.html" > Numeric Metafunction< / a > , < a class = "reference internal" href = "./numeric-cast.html" > numeric_cast< / a > , < a class = "reference internal" href = "./divides.html" > divides< / a > , < a class = "reference internal" href = "./times.html" > times< / a > , < a class = "reference internal" href = "./plus.html" > plus< / a > < / p >
2004-11-28 03:35:12 +00:00
<!-- Metafunctions/Arithmetic Operations//negate |60 -->
< / div >
< / div >
< div class = "footer-separator" > < / div >
< table class = "footer" > < tr class = "footer" > < td class = "header-group navigation-bar" > < span class = "navigation-group" > < a href = "./divides.html" class = "navigation-link" > Prev< / a > < a href = "./negate.html" class = "navigation-link" > Next< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./divides.html" class = "navigation-link" > Back< / a > < a href = "./negate.html" class = "navigation-link" > Along< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./arithmetic-operations.html" class = "navigation-link" > Up< / a > < a href = "../refmanual.html" class = "navigation-link" > Home< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC< / a > < / span > < / td >
2009-08-17 11:30:52 +00:00
< td > < div class = "copyright-footer" > < div class = "copyright" > Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams< / div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a class = "reference external" href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt< / a > )< / div > < / td > < / tr > < / table > < / body >
2004-11-28 03:35:12 +00:00
< / html >
