greater-equal.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  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: greater_equal</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="./greater.html" class="navigation-link">Prev</a>&nbsp;<a href="./equal-to.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./greater.html" class="navigation-link">Back</a>&nbsp;<a href="./equal-to.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./comparisons.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="./comparisons.html" class="navigation-link">Comparisons</a> / <a href="./greater-equal.html" class="navigation-link">greater_equal</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="greater-equal">
  15. <h1><a class="toc-backref" href="./comparisons.html#id1546">greater_equal</a></h1>
  16. <div class="section" id="id1041">
  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. &gt;
  23. struct <a href="./greater-equal.html" class="identifier">greater_equal</a>
  24. {
  25. typedef <em>unspecified</em> type;
  26. };
  27. </pre>
  28. </div>
  29. <div class="section" id="id1042">
  30. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  31. <p>Returns a true-valued <a class="reference internal" href="./integral-constant.html">Integral Constant</a> if <tt class="literal"><span class="pre">T1</span></tt> is greater than or equal to <tt class="literal"><span class="pre">T2</span></tt>.</p>
  32. </div>
  33. <div class="section" id="id1043">
  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/greater_equal.hpp" class="header">boost/mpl/greater_equal.hpp</a>&gt;
  37. #include &lt;<a href="../../../../boost/mpl/comparison.hpp" class="header">boost/mpl/comparison.hpp</a>&gt;
  38. </pre>
  39. </div>
  40. <div class="section" id="id1044">
  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="id1045">
  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
  66. are the ones imposed by the default implementation. See <a class="reference internal" href="./numeric-metafunction.html">Numeric Metafunction</a> concept
  67. for the details on how to provide an implementation for a user-defined numeric type
  68. that 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="id1046">
  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">
  74. typedef <a href="./greater-equal.html" class="identifier">greater_equal</a>&lt;c1,c2&gt;::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">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  84. <pre class="last literal-block">
  85. typedef <a href="./bool.html" class="identifier">bool_</a>&lt; (c1::value &lt; c2::value) &gt; r;
  86. </pre>
  87. </td>
  88. </tr>
  89. </tbody>
  90. </table>
  91. <!-- .......................................................................... -->
  92. <pre class="literal-block">
  93. typedef <a href="./greater-equal.html" class="identifier">greater_equal</a>&lt;c1,c2&gt; r;
  94. </pre>
  95. <table class="docutils field-list" frame="void" rules="none">
  96. <col class="field-name" />
  97. <col class="field-body" />
  98. <tbody valign="top">
  99. <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>
  100. </td>
  101. </tr>
  102. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  103. <pre class="last literal-block">
  104. struct r : <a href="./greater-equal.html" class="identifier">greater_equal</a>&lt;c1,c2&gt;::type {};
  105. </pre>
  106. </td>
  107. </tr>
  108. </tbody>
  109. </table>
  110. </div>
  111. <div class="section" id="id1047">
  112. <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  113. <p>Amortized constant time.</p>
  114. </div>
  115. <div class="section" id="id1048">
  116. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  117. <pre class="literal-block">
  118. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./greater-equal.html" class="identifier">greater_equal</a>&lt; <a href="./int.html" class="identifier">int_</a>&lt;10&gt;, <a href="./int.html" class="identifier">int_</a>&lt;0&gt; &gt; ));
  119. <a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./greater-equal.html" class="identifier">greater_equal</a>&lt; <a href="./long.html" class="identifier">long_</a>&lt;0&gt;, <a href="./int.html" class="identifier">int_</a>&lt;10&gt; &gt; ));
  120. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./greater-equal.html" class="identifier">greater_equal</a>&lt; <a href="./long.html" class="identifier">long_</a>&lt;10&gt;, <a href="./int.html" class="identifier">int_</a>&lt;10&gt; > ));
  121. </pre>
  122. </div>
  123. <div class="section" id="id1049">
  124. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  125. <p><a class="reference internal" href="./comparisons.html">Comparisons</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="./greater.html">greater</a>, <a class="reference internal" href="./less.html">less</a>, <a class="reference internal" href="./equal-to.html">equal_to</a></p>
  126. <!-- Metafunctions/Comparisons//equal_to |50 -->
  127. </div>
  128. </div>
  129. <div class="footer-separator"></div>
  130. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./greater.html" class="navigation-link">Prev</a>&nbsp;<a href="./equal-to.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./greater.html" class="navigation-link">Back</a>&nbsp;<a href="./equal-to.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./comparisons.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>
  131. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  132. Distributed under the Boost Software License, Version 1.0. (See accompanying
  133. 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>
  134. </html>