Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/modulus.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 9.1 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<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: modulus</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<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>
15<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>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="modulus">
18<h1><a class="toc-backref" href="./arithmetic-operations.html#id466" name="modulus">modulus</a></h1>
19<div class="section" id="modulus-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt;
23      typename T1
24    , typename T2
25    &gt;
26struct <a href="./modulus.html" class="identifier">modulus</a>
27{
28    typedef <em>unspecified</em> type;
29};
30</pre>
31</div>
32<div class="section" id="modulus-description">
33<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
34<p>Returns the modulus of its arguments.</p>
35</div>
36<div class="section" id="modulus-header">
37<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
38<pre class="literal-block">
39#include &lt;<a href="../../../../boost/mpl/modulus.hpp" class="header">boost/mpl/modulus.hpp</a>&gt;
40#include &lt;<a href="../../../../boost/mpl/arithmetic.hpp" class="header">boost/mpl/arithmetic.hpp</a>&gt;
41</pre>
42</div>
43<div class="section" id="modulus-model-of">
44<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
45<p><a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a></p>
46</div>
47<div class="section" id="modulus-parameters">
48<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
49<table border="1" class="table">
50<colgroup>
51<col width="17%" />
52<col width="30%" />
53<col width="53%" />
54</colgroup>
55<thead valign="bottom">
56<tr><th>Parameter</th>
57<th>Requirement</th>
58<th>Description</th>
59</tr>
60</thead>
61<tbody valign="top">
62<tr><td><tt class="literal"><span class="pre">T1</span></tt>, <tt class="literal"><span class="pre">T2</span></tt></td>
63<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
64<td>Operation's arguments.</td>
65</tr>
66</tbody>
67</table>
68<p>[<em>Note:</em> The requirements listed in this specification
69are the ones imposed by the default implementation. See <a class="reference" href="./numeric-metafunction.html">Numeric Metafunction</a> concept
70for the details on how to provide an implementation for a user-defined numeric type
71that does not satisfy the <a class="reference" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p>
72</div>
73<div class="section" id="modulus-expression-semantics">
74<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
75<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>
76<pre class="literal-block">
77typedef <a href="./modulus.html" class="identifier">modulus</a>&lt;c1,c2&gt;::type r;
78</pre>
79<table class="field-list" frame="void" rules="none">
80<col class="field-name" />
81<col class="field-body" />
82<tbody valign="top">
83<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>
84</tr>
85<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>
86</tr>
87<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
88<pre class="last literal-block">
89typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;
90      typeof(c1::value % c2::value)
91    , ( c1::value % c2::value )
92    &gt; r;
93</pre>
94</td>
95</tr>
96</tbody>
97</table>
98<!-- .......................................................................... -->
99<pre class="literal-block">
100typedef <a href="./modulus.html" class="identifier">modulus</a>&lt;c1,c2&gt; r;
101</pre>
102<table class="field-list" frame="void" rules="none">
103<col class="field-name" />
104<col class="field-body" />
105<tbody valign="top">
106<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>
107</tr>
108<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>
109</tr>
110<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
111<pre class="last literal-block">
112struct r : <a href="./modulus.html" class="identifier">modulus</a>&lt;c1,c2&gt;::type {};
113</pre>
114</td>
115</tr>
116</tbody>
117</table>
118</div>
119<div class="section" id="modulus-complexity">
120<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
121<p>Amortized constant time.</p>
122</div>
123<div class="section" id="modulus-example">
124<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
125<pre class="literal-block">
126typedef <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;
127<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( r::value, ==, 1 );
128<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 > ));
129</pre>
130</div>
131<div class="section" id="modulus-see-also">
132<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
133<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>
134<!-- modtime: November 10, 2004 05:03:02 +0000 -->
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>&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>
141</tr></table></body>
142</html>
Note: See TracBrowser for help on using the repository browser.