divides.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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: divides</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="./times.html" class="navigation-link">Prev</a>&nbsp;<a href="./modulus.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./times.html" class="navigation-link">Back</a>&nbsp;<a href="./modulus.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="./divides.html" class="navigation-link">divides</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="divides">
  15. <h1><a class="toc-backref" href="./arithmetic-operations.html#id1539">divides</a></h1>
  16. <div class="section" id="id987">
  17. <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18. <pre class="literal-block">
  19. template&lt;
  20. typename T1
  21. , typename T2
  22. , typename T3 = <em>unspecified</em>
  23. <em>...</em>
  24. , typename T<em>n</em> = <em>unspecified</em>
  25. &gt;
  26. struct <a href="./divides.html" class="identifier">divides</a>
  27. {
  28. typedef <em>unspecified</em> type;
  29. };
  30. </pre>
  31. </div>
  32. <div class="section" id="id988">
  33. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  34. <p>Returns the quotient of its arguments.</p>
  35. </div>
  36. <div class="section" id="id989">
  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/divides.hpp" class="header">boost/mpl/divides.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="id990">
  44. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  45. <p><a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a></p>
  46. </div>
  47. <div class="section" id="id991">
  48. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  49. <table border="1" class="docutils table">
  50. <colgroup>
  51. <col width="17%" />
  52. <col width="30%" />
  53. <col width="53%" />
  54. </colgroup>
  55. <thead valign="bottom">
  56. <tr><th class="head">Parameter</th>
  57. <th class="head">Requirement</th>
  58. <th class="head">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>,... <tt class="literal"><span class="pre">Tn</span></tt></td>
  63. <td><a class="reference internal" 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
  69. are the ones imposed by the default implementation. See <a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a> concept
  70. for the details on how to provide an implementation for a user-defined numeric type
  71. that does not satisfy the <a class="reference internal" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p>
  72. </div>
  73. <div class="section" id="id992">
  74. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  75. <p>For any <a class="reference internal" href="./integral-constant.html">Integral Constant</a>s <em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>:</p>
  76. <pre class="literal-block">
  77. typedef <a href="./divides.html" class="identifier">divides</a>&lt;c1,<em>...</em>c<em>n</em>&gt;::type r;
  78. </pre>
  79. <table class="docutils 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"><p class="first"><a class="reference internal" href="./integral-constant.html">Integral Constant</a>.</p>
  84. </td>
  85. </tr>
  86. <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>, <em>...</em> <tt class="literal"><span class="pre">cn::value</span> <span class="pre">!=</span> <span class="pre">0</span></tt>.</p>
  87. </td>
  88. </tr>
  89. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  90. <pre class="last literal-block">
  91. typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt;
  92. typeof(c1::value / c2::value)
  93. , ( c1::value / c2::value )
  94. &gt; c;
  95. typedef <a href="./divides.html" class="identifier">divides</a>&lt;c,c3,<em>...</em>c<em>n</em>&gt;::type r;
  96. </pre>
  97. </td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. <!-- .......................................................................... -->
  102. <pre class="literal-block">
  103. typedef <a href="./divides.html" class="identifier">divides</a>&lt;c1,<em>...</em>c<em>n</em>&gt; r;
  104. </pre>
  105. <table class="docutils field-list" frame="void" rules="none">
  106. <col class="field-name" />
  107. <col class="field-body" />
  108. <tbody valign="top">
  109. <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>
  110. </td>
  111. </tr>
  112. <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>, <em>...</em> <tt class="literal"><span class="pre">cn::value</span> <span class="pre">!=</span> <span class="pre">0</span></tt>.</p>
  113. </td>
  114. </tr>
  115. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  116. <pre class="last literal-block">
  117. struct r : <a href="./divides.html" class="identifier">divides</a>&lt;c1,<em>...</em>c<em>n</em>&gt;::type {};
  118. </pre>
  119. </td>
  120. </tr>
  121. </tbody>
  122. </table>
  123. </div>
  124. <div class="section" id="id993">
  125. <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  126. <p>Amortized constant time.</p>
  127. </div>
  128. <div class="section" id="id994">
  129. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  130. <pre class="literal-block">
  131. typedef <a href="./divides.html" class="identifier">divides</a>&lt; <a href="./int.html" class="identifier">int_</a>&lt;-10&gt;, <a href="./int.html" class="identifier">int_</a>&lt;3&gt;, <a href="./long.html" class="identifier">long_</a>&lt;1&gt; &gt;::type r;
  132. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( r::value, ==, -3 );
  133. <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 > ));
  134. </pre>
  135. </div>
  136. <div class="section" id="id995">
  137. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  138. <p><a class="reference internal" href="./arithmetic-operations.html">Arithmetic Operations</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="./times.html">times</a>, <a class="reference internal" href="./modulus.html">modulus</a>, <a class="reference internal" href="./plus.html">plus</a></p>
  139. <!-- Metafunctions/Arithmetic Operations//modulus |50 -->
  140. </div>
  141. </div>
  142. <div class="footer-separator"></div>
  143. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./times.html" class="navigation-link">Prev</a>&nbsp;<a href="./modulus.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./times.html" class="navigation-link">Back</a>&nbsp;<a href="./modulus.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>
  144. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  145. Distributed under the Boost Software License, Version 1.0. (See accompanying
  146. 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>
  147. </html>