1<?xml version="1.0" encoding="utf-8" ?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 4<head> 5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> 7<title>The MPL Reference Manual: modulus</title> 8<link rel="stylesheet" href="../style.css" type="text/css" /> 9</head> 10<body class="docframe refmanual"> 11<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> 12<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> 13</tr></table><div class="header-separator"></div> 14<div class="section" id="modulus"> 15<h1><a class="toc-backref" href="./arithmetic-operations.html#id1540">modulus</a></h1> 16<div class="section" id="id996"> 17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> 18<pre class="literal-block"> 19template< 20 typename T1 21 , typename T2 22 > 23struct <a href="./modulus.html" class="identifier">modulus</a> 24{ 25 typedef <em>unspecified</em> type; 26}; 27</pre> 28</div> 29<div class="section" id="id997"> 30<h3><a class="subsection-title" href="#description" name="description">Description</a></h3> 31<p>Returns the modulus of its arguments.</p> 32</div> 33<div class="section" id="id998"> 34<h3><a class="subsection-title" href="#header" name="header">Header</a></h3> 35<pre class="literal-block"> 36#include <<a href="../../../../boost/mpl/modulus.hpp" class="header">boost/mpl/modulus.hpp</a>> 37#include <<a href="../../../../boost/mpl/arithmetic.hpp" class="header">boost/mpl/arithmetic.hpp</a>> 38</pre> 39</div> 40<div class="section" id="id999"> 41<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> 42<p><a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a></p> 43</div> 44<div class="section" id="id1000"> 45<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> 46<table border="1" class="docutils table"> 47<colgroup> 48<col width="17%" /> 49<col width="30%" /> 50<col width="53%" /> 51</colgroup> 52<thead valign="bottom"> 53<tr><th class="head">Parameter</th> 54<th class="head">Requirement</th> 55<th class="head">Description</th> 56</tr> 57</thead> 58<tbody valign="top"> 59<tr><td><tt class="literal"><span class="pre">T1</span></tt>, <tt class="literal"><span class="pre">T2</span></tt></td> 60<td><a class="reference internal" href="./integral-constant.html">Integral Constant</a></td> 61<td>Operation's arguments.</td> 62</tr> 63</tbody> 64</table> 65<p>[<em>Note:</em> The requirements listed in this specification 66are the ones imposed by the default implementation. See <a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a> concept 67for the details on how to provide an implementation for a user-defined numeric type 68that does not satisfy the <a class="reference internal" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p> 69</div> 70<div class="section" id="id1001"> 71<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> 72<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> 73<pre class="literal-block"> 74typedef <a href="./modulus.html" class="identifier">modulus</a><c1,c2>::type r; 75</pre> 76<table class="docutils field-list" frame="void" rules="none"> 77<col class="field-name" /> 78<col class="field-body" /> 79<tbody valign="top"> 80<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> 81</td> 82</tr> 83<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> 84</td> 85</tr> 86<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p> 87<pre class="last literal-block"> 88typedef <a href="./integral-c.html" class="identifier">integral_c</a>< 89 typeof(c1::value % c2::value) 90 , ( c1::value % c2::value ) 91 > r; 92</pre> 93</td> 94</tr> 95</tbody> 96</table> 97<!-- .......................................................................... --> 98<pre class="literal-block"> 99typedef <a href="./modulus.html" class="identifier">modulus</a><c1,c2> r; 100</pre> 101<table class="docutils field-list" frame="void" rules="none"> 102<col class="field-name" /> 103<col class="field-body" /> 104<tbody valign="top"> 105<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> 106</td> 107</tr> 108<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> 109</td> 110</tr> 111<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p> 112<pre class="last literal-block"> 113struct r : <a href="./modulus.html" class="identifier">modulus</a><c1,c2>::type {}; 114</pre> 115</td> 116</tr> 117</tbody> 118</table> 119</div> 120<div class="section" id="id1002"> 121<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3> 122<p>Amortized constant time.</p> 123</div> 124<div class="section" id="id1003"> 125<h3><a class="subsection-title" href="#example" name="example">Example</a></h3> 126<pre class="literal-block"> 127typedef <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; 128<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( r::value, ==, 1 ); 129<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< r::<a href="./value-type.html" class="identifier">value_type</a>, long > )); 130</pre> 131</div> 132<div class="section" id="id1004"> 133<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> 134<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> 135<!-- Metafunctions/Arithmetic Operations//negate |60 --> 136</div> 137</div> 138 139<div class="footer-separator"></div> 140<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> 141<td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div> 142Distributed under the Boost Software License, Version 1.0. (See accompanying 143file 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> 144</html> 145