enable_if.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>enable_if_</title>
  5. <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.TypeTraits">
  8. <link rel="up" href="../reference.html" title="Alphabetical Reference">
  9. <link rel="prev" href="detected_or.html" title="detected_or">
  10. <link rel="next" href="extent.html" title="extent">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="detected_or.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="extent.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h3 class="title">
  27. <a name="boost_typetraits.reference.enable_if"></a><a class="link" href="enable_if.html" title="enable_if_">enable_if_</a>
  28. </h3></div></div></div>
  29. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> <span class="identifier">B</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">=</span> <span class="keyword">void</span><span class="special">&gt;</span>
  30. <span class="keyword">struct</span> <span class="identifier">enable_if_</span><span class="special">;</span>
  31. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> <span class="identifier">B</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">=</span> <span class="keyword">void</span><span class="special">&gt;</span>
  32. <span class="keyword">using</span> <span class="identifier">enable_if_t</span> <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">enable_if_</span><span class="special">&lt;</span><span class="identifier">B</span><span class="special">,</span> <span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">;</span>
  33. </pre>
  34. <p>
  35. <span class="bold"><strong>type:</strong></span> If <code class="computeroutput"><span class="identifier">B</span></code>
  36. is true, then the member <code class="computeroutput"><span class="identifier">type</span></code>
  37. is defined to be <code class="computeroutput"><span class="identifier">T</span></code>. Otherwise
  38. there is no member <code class="computeroutput"><span class="identifier">type</span></code>.
  39. </p>
  40. <p>
  41. <span class="bold"><strong>Header:</strong></span> <code class="computeroutput"><span class="preprocessor">#include</span>
  42. <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">type_traits</span><span class="special">/</span><span class="identifier">enable_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  43. </p>
  44. <div class="note"><table border="0" summary="Note">
  45. <tr>
  46. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  47. <th align="left">Note</th>
  48. </tr>
  49. <tr><td align="left" valign="top"><p>
  50. The trait has the name <code class="computeroutput"><span class="identifier">enable_if_</span></code>
  51. (with a trailing underscore) but behaves like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span></code>
  52. or <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_c</span></code>. The existing trait with
  53. the name <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span></code> has a different interface.
  54. </p></td></tr>
  55. </table></div>
  56. <p>
  57. <span class="bold"><strong>Examples:</strong></span>
  58. </p>
  59. <p>
  60. The following function can be used to destroy each element of an array and
  61. specially handle arrays of trivially destructible types.
  62. </p>
  63. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  64. <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_</span><span class="special">&lt;!</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_trivial_destructor</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">&gt;::</span><span class="identifier">type</span>
  65. <span class="identifier">destroy</span><span class="special">(</span><span class="identifier">T</span><span class="special">*</span> <span class="identifier">ptr</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">)</span>
  66. <span class="special">{</span>
  67. <span class="keyword">while</span> <span class="special">(</span><span class="identifier">size</span> <span class="special">&gt;</span> <span class="number">0</span><span class="special">)</span> <span class="special">{</span>
  68. <span class="identifier">ptr</span><span class="special">[--</span><span class="identifier">size</span><span class="special">].~</span><span class="identifier">T</span><span class="special">();</span>
  69. <span class="special">}</span>
  70. <span class="special">}</span>
  71. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  72. <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_</span><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_trivial_destructor</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">&gt;::</span><span class="identifier">type</span>
  73. <span class="identifier">destroy</span><span class="special">(</span><span class="identifier">T</span><span class="special">*,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="special">{</span> <span class="special">}</span>
  74. </pre>
  75. <p>
  76. <span class="bold"><strong>Compiler Compatibility:</strong></span> All current compilers
  77. are supported by this trait. The type alias <code class="computeroutput"><span class="identifier">enable_if_t</span></code>
  78. is only available if the compiler supports template aliases.
  79. </p>
  80. </div>
  81. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  82. <td align="left"></td>
  83. <td align="right"><div class="copyright-footer">Copyright &#169; 2000, 2011 Adobe Systems Inc, David Abrahams,
  84. Frederic Bron, Steve Cleary, Beman Dawes, Aleksey Gurtovoy, Howard Hinnant,
  85. Jesse Jones, Mat Marcus, Itay Maman, John Maddock, Alexander Nasonov, Thorsten
  86. Ottosen, Roman Perepelitsa, Robert Ramey, Jeremy Siek, Robert Stewart and Steven
  87. Watanabe<p>
  88. Distributed under the Boost Software License, Version 1.0. (See accompanying
  89. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  90. </p>
  91. </div></td>
  92. </tr></table>
  93. <hr>
  94. <div class="spirit-nav">
  95. <a accesskey="p" href="detected_or.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="extent.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  96. </div>
  97. </body>
  98. </html>