Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/modulus.html @ 13

Last change on this file since 13 was 12, checked in by landauf, 18 years ago

added boost
File size: 8.9 KB
Line 
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.3.6: 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>&nbsp;<a href="./negate.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./divides.html" class="navigation-link">Back</a>&nbsp;<a href="./negate.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./arithmetic-operations.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</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#id466" name="modulus">modulus</a></h1>
16<div class="section" id="modulus-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt;
20      typename T1
21    , typename T2
22    &gt;
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="modulus-description">
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="modulus-header">
34<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
35<pre class="literal-block">
36#include &lt;<a href="../../../../boost/mpl/modulus.hpp" class="header">boost/mpl/modulus.hpp</a>&gt;
37#include &lt;<a href="../../../../boost/mpl/arithmetic.hpp" class="header">boost/mpl/arithmetic.hpp</a>&gt;
38</pre>
39</div>
40<div class="section" id="modulus-model-of">
41<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
42<p><a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a></p>
43</div>
44<div class="section" id="modulus-parameters">
45<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
46<table border="1" class="table">
47<colgroup>
48<col width="17%" />
49<col width="30%" />
50<col width="53%" />
51</colgroup>
52<thead valign="bottom">
53<tr><th>Parameter</th>
54<th>Requirement</th>
55<th>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" 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" 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" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p>
69</div>
70<div class="section" id="modulus-expression-semantics">
71<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
72<p>For any <a class="reference" 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>&lt;c1,c2&gt;::type r;
75</pre>
76<table class="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"><a class="reference" href="./integral-constant.html">Integral Constant</a>.</td>
81</tr>
82<tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><tt class="literal"><span class="pre">c2::value</span> <span class="pre">!=</span> <span class="pre">0</span></tt></td>
83</tr>
84<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
85<pre class="last literal-block">
86typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;
87      typeof(c1::value % c2::value)
88    , ( c1::value % c2::value )
89    &gt; r;
90</pre>
91</td>
92</tr>
93</tbody>
94</table>
95<!-- .......................................................................... -->
96<pre class="literal-block">
97typedef <a href="./modulus.html" class="identifier">modulus</a>&lt;c1,c2&gt; r;
98</pre>
99<table class="field-list" frame="void" rules="none">
100<col class="field-name" />
101<col class="field-body" />
102<tbody valign="top">
103<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference" href="./integral-constant.html">Integral Constant</a>.</td>
104</tr>
105<tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><tt class="literal"><span class="pre">c2::value</span> <span class="pre">!=</span> <span class="pre">0</span></tt></td>
106</tr>
107<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
108<pre class="last literal-block">
109struct r : <a href="./modulus.html" class="identifier">modulus</a>&lt;c1,c2&gt;::type {};
110</pre>
111</td>
112</tr>
113</tbody>
114</table>
115</div>
116<div class="section" id="modulus-complexity">
117<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
118<p>Amortized constant time.</p>
119</div>
120<div class="section" id="modulus-example">
121<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
122<pre class="literal-block">
123typedef <a href="./modulus.html" class="identifier">modulus</a>&lt; <a href="./int.html" class="identifier">int_</a>&lt;10&gt;, <a href="./long.html" class="identifier">long_</a>&lt;3&gt; &gt;::type r;
124<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( r::value, ==, 1 );
125<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; r::<a href="./value-type.html" class="identifier">value_type</a>, long > ));
126</pre>
127</div>
128<div class="section" id="modulus-see-also">
129<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
130<p><a class="reference" href="./metafunctions.html">Metafunctions</a>, <a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a>, <a class="refentry reference" href="./numeric-cast.html"><tt class="refentry literal"><span class="pre">numeric_cast</span></tt></a>, <a class="refentry reference" href="./divides.html"><tt class="refentry literal"><span class="pre">divides</span></tt></a>, <a class="refentry reference" href="./times.html"><tt class="refentry literal"><span class="pre">times</span></tt></a>, <a class="refentry reference" href="./plus.html"><tt class="refentry literal"><span class="pre">plus</span></tt></a></p>
131<!-- modtime: November 10, 2004 05:03:02 +0000 -->
132<!-- Metafunctions/Arithmetic Operations//negate |60 -->
133</div>
134</div>
135
136<div class="footer-separator"></div>
137<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>&nbsp;<a href="./negate.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./divides.html" class="navigation-link">Back</a>&nbsp;<a href="./negate.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./arithmetic-operations.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
138</tr></table></body>
139</html>
Note: See TracBrowser for help on using the repository browser.