negate.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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: negate</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="./modulus.html" class="navigation-link">Prev</a>&nbsp;<a href="./comparisons.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./modulus.html" class="navigation-link">Back</a>&nbsp;Along</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="./negate.html" class="navigation-link">negate</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="negate">
  15. <h1><a class="toc-backref" href="./arithmetic-operations.html#id1541">negate</a></h1>
  16. <div class="section" id="id1005">
  17. <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18. <pre class="literal-block">
  19. template&lt;
  20. typename T
  21. &gt;
  22. struct <a href="./negate.html" class="identifier">negate</a>
  23. {
  24. typedef <em>unspecified</em> type;
  25. };
  26. </pre>
  27. </div>
  28. <div class="section" id="id1006">
  29. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  30. <p>Returns the negative (additive inverse) of its argument.</p>
  31. </div>
  32. <div class="section" id="id1007">
  33. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  34. <pre class="literal-block">
  35. #include &lt;<a href="../../../../boost/mpl/negate.hpp" class="header">boost/mpl/negate.hpp</a>&gt;
  36. #include &lt;<a href="../../../../boost/mpl/arithmetic.hpp" class="header">boost/mpl/arithmetic.hpp</a>&gt;
  37. </pre>
  38. </div>
  39. <div class="section" id="id1008">
  40. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  41. <p><a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a></p>
  42. </div>
  43. <div class="section" id="id1009">
  44. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  45. <table border="1" class="docutils table">
  46. <colgroup>
  47. <col width="17%" />
  48. <col width="30%" />
  49. <col width="53%" />
  50. </colgroup>
  51. <thead valign="bottom">
  52. <tr><th class="head">Parameter</th>
  53. <th class="head">Requirement</th>
  54. <th class="head">Description</th>
  55. </tr>
  56. </thead>
  57. <tbody valign="top">
  58. <tr><td><tt class="literal"><span class="pre">T</span></tt></td>
  59. <td><a class="reference internal" href="./integral-constant.html">Integral Constant</a></td>
  60. <td>Operation's argument.</td>
  61. </tr>
  62. </tbody>
  63. </table>
  64. <p>[<em>Note:</em> The requirements listed in this specification
  65. are the ones imposed by the default implementation. See <a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a> concept
  66. for the details on how to provide an implementation for a user-defined numeric type
  67. that does not satisfy the <a class="reference internal" href="./integral-constant.html">Integral Constant</a> requirements. — <em>end note</em>]</p>
  68. </div>
  69. <div class="section" id="id1010">
  70. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  71. <p>For any <a class="reference internal" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt>:</p>
  72. <pre class="literal-block">
  73. typedef <a href="./negate.html" class="identifier">negate</a>&lt;c&gt;::type r;
  74. </pre>
  75. <table class="docutils field-list" frame="void" rules="none">
  76. <col class="field-name" />
  77. <col class="field-body" />
  78. <tbody valign="top">
  79. <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>
  80. </td>
  81. </tr>
  82. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  83. <pre class="last literal-block">
  84. typedef <a href="./integral-c.html" class="identifier">integral_c</a>&lt; c::<a href="./value-type.html" class="identifier">value_type</a>, ( -c::value ) &gt; r;
  85. </pre>
  86. </td>
  87. </tr>
  88. </tbody>
  89. </table>
  90. <!-- .......................................................................... -->
  91. <pre class="literal-block">
  92. typedef <a href="./negate.html" class="identifier">negate</a>&lt;c&gt; r;
  93. </pre>
  94. <table class="docutils field-list" frame="void" rules="none">
  95. <col class="field-name" />
  96. <col class="field-body" />
  97. <tbody valign="top">
  98. <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>
  99. </td>
  100. </tr>
  101. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  102. <pre class="last literal-block">
  103. struct r : <a href="./negate.html" class="identifier">negate</a>&lt;c&gt;::type {};
  104. </pre>
  105. </td>
  106. </tr>
  107. </tbody>
  108. </table>
  109. </div>
  110. <div class="section" id="id1011">
  111. <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  112. <p>Amortized constant time.</p>
  113. </div>
  114. <div class="section" id="id1012">
  115. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  116. <pre class="literal-block">
  117. typedef <a href="./negate.html" class="identifier">negate</a>&lt; <a href="./int.html" class="identifier">int_</a>&lt;-10&gt; &gt;::type r;
  118. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( r::value, ==, 10 );
  119. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; r::<a href="./value-type.html" class="identifier">value_type</a>, int > ));
  120. </pre>
  121. </div>
  122. <div class="section" id="id1013">
  123. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  124. <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="./plus.html">plus</a>, <a class="reference internal" href="./minus.html">minus</a>, <a class="reference internal" href="./times.html">times</a></p>
  125. </div>
  126. </div>
  127. <div class="footer-separator"></div>
  128. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./modulus.html" class="navigation-link">Prev</a>&nbsp;<a href="./comparisons.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./modulus.html" class="navigation-link">Back</a>&nbsp;Along</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>
  129. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  130. Distributed under the Boost Software License, Version 1.0. (See accompanying
  131. 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>
  132. </html>