placeholders.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>placeholders &#8212; Boost.HigherOrderFunctions 0.6 documentation</title>
  7. <link rel="stylesheet" href="../../../_static/boostbook.css" type="text/css" />
  8. <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../../',
  12. VERSION: '0.6',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true,
  16. SOURCELINK_SUFFIX: '.txt'
  17. };
  18. </script>
  19. <script type="text/javascript" src="../../../_static/jquery.js"></script>
  20. <script type="text/javascript" src="../../../_static/underscore.js"></script>
  21. <script type="text/javascript" src="../../../_static/doctools.js"></script>
  22. <link rel="index" title="Index" href="../../../genindex.html" />
  23. <link rel="search" title="Search" href="../../../search.html" />
  24. <link rel="next" title="Traits" href="../../../doc/src/traits.html" />
  25. <link rel="prev" title="identity" href="identity.html" />
  26. </head>
  27. <body role="document">
  28. <table cellpadding="2" width="100%"><tr>
  29. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86"src="../../../_static/boost.png"></td>
  30. </tr></table>
  31. <div class="spirit-nav">
  32. <a accesskey="p" href="identity.html"><img src="../../../_static/prev.png" alt="Prev"></a>
  33. <a accesskey="u" href="../../../doc/src/reference.html"><img src="../../../_static/up.png" alt="Up"></a>
  34. <a accesskey="h" href="../../../doc/index.html"><img src="../../../_static/home.png" alt="Home"></a>
  35. <a accesskey="n" href="../../../doc/src/traits.html"><img src="../../../_static/next.png" alt="Next"></a>
  36. </div>
  37. <div class="document">
  38. <div class="chapter">
  39. <div class="body" role="main">
  40. <div class="section" id="placeholders">
  41. <h1>placeholders<a class="headerlink" href="#placeholders" title="Permalink to this headline">¶</a></h1>
  42. <div class="section" id="header">
  43. <h2>Header<a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h2>
  44. <div class="highlight-cpp"><div class="highlight"><pre><span class="cp">#include</span> <span class="cpf">&lt;boost/hof/placeholders.hpp&gt;</span><span class="cp"></span>
  45. </pre></div>
  46. </div>
  47. </div>
  48. <div class="section" id="description">
  49. <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  50. <p>The placeholders provide <code class="docutils literal"><span class="pre">std::bind</span></code> compatible placeholders that
  51. additionally provide basic C++ operators that creates bind expressions.
  52. Each bind expression supports <code class="docutils literal"><span class="pre">constexpr</span></code> function evaluation.</p>
  53. </div>
  54. <div class="section" id="synopsis">
  55. <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
  56. <div class="highlight-cpp"><div class="highlight"><pre><span class="k">namespace</span> <span class="n">placeholders</span> <span class="p">{</span>
  57. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">1</span><span class="o">&gt;</span> <span class="n">_1</span> <span class="o">=</span> <span class="p">{};</span>
  58. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">2</span><span class="o">&gt;</span> <span class="n">_2</span> <span class="o">=</span> <span class="p">{};</span>
  59. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">3</span><span class="o">&gt;</span> <span class="n">_3</span> <span class="o">=</span> <span class="p">{};</span>
  60. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">4</span><span class="o">&gt;</span> <span class="n">_4</span> <span class="o">=</span> <span class="p">{};</span>
  61. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">5</span><span class="o">&gt;</span> <span class="n">_5</span> <span class="o">=</span> <span class="p">{};</span>
  62. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">6</span><span class="o">&gt;</span> <span class="n">_6</span> <span class="o">=</span> <span class="p">{};</span>
  63. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">7</span><span class="o">&gt;</span> <span class="n">_7</span> <span class="o">=</span> <span class="p">{};</span>
  64. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span> <span class="n">_8</span> <span class="o">=</span> <span class="p">{};</span>
  65. <span class="n">placeholder</span><span class="o">&lt;</span><span class="mi">9</span><span class="o">&gt;</span> <span class="n">_9</span> <span class="o">=</span> <span class="p">{};</span>
  66. <span class="p">}</span>
  67. </pre></div>
  68. </div>
  69. </div>
  70. <div class="section" id="operators">
  71. <h2>Operators<a class="headerlink" href="#operators" title="Permalink to this headline">¶</a></h2>
  72. <ul class="simple">
  73. <li>Binary operators: +,-,*,/,%,&gt;&gt;,&lt;&lt;,&gt;,&lt;,&lt;=,&gt;=,==,!=,&amp;,^,|,&amp;&amp;,||</li>
  74. <li>Assign operators: +=,-=,*=,/=,%=,&gt;&gt;=,&lt;&lt;=,&amp;=,|=,^=</li>
  75. <li>Unary operators: !,~,+,-,*,++,&#8211;</li>
  76. </ul>
  77. </div>
  78. <div class="section" id="example">
  79. <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
  80. <div class="highlight-cpp"><div class="highlight"><pre><span class="cp">#include</span> <span class="cpf">&lt;boost/hof.hpp&gt;</span><span class="cp"></span>
  81. <span class="cp">#include</span> <span class="cpf">&lt;cassert&gt;</span><span class="cp"></span>
  82. <span class="k">using</span> <span class="k">namespace</span> <span class="n">boost</span><span class="o">::</span><span class="n">hof</span><span class="p">;</span>
  83. <span class="kt">int</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
  84. <span class="k">auto</span> <span class="n">sum</span> <span class="o">=</span> <span class="n">_1</span> <span class="o">+</span> <span class="n">_2</span><span class="p">;</span>
  85. <span class="n">assert</span><span class="p">(</span><span class="mi">3</span> <span class="o">==</span> <span class="n">sum</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
  86. <span class="p">}</span>
  87. </pre></div>
  88. </div>
  89. </div>
  90. </div>
  91. <div class="section" id="unamed-placeholder">
  92. <h1>unamed placeholder<a class="headerlink" href="#unamed-placeholder" title="Permalink to this headline">¶</a></h1>
  93. <div class="section" id="id1">
  94. <h2>Header<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
  95. <div class="highlight-cpp"><div class="highlight"><pre><span class="cp">#include</span> <span class="cpf">&lt;boost/hof/placeholders.hpp&gt;</span><span class="cp"></span>
  96. </pre></div>
  97. </div>
  98. </div>
  99. <div class="section" id="id2">
  100. <h2>Description<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
  101. <p>The unamed placeholder can be used to build simple functions from C++
  102. operators.</p>
  103. <p>Note: The function produced by the unamed placeholder is not a bind expression.</p>
  104. </div>
  105. <div class="section" id="id3">
  106. <h2>Synopsis<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
  107. <div class="highlight-cpp"><div class="highlight"><pre><span class="k">namespace</span> <span class="n">placeholders</span> <span class="p">{</span>
  108. <span class="cm">/* unspecified */</span> <span class="n">_</span> <span class="o">=</span> <span class="p">{};</span>
  109. <span class="p">}</span>
  110. </pre></div>
  111. </div>
  112. </div>
  113. <div class="section" id="id4">
  114. <h2>Example<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
  115. <div class="highlight-cpp"><div class="highlight"><pre><span class="cp">#include</span> <span class="cpf">&lt;boost/hof.hpp&gt;</span><span class="cp"></span>
  116. <span class="cp">#include</span> <span class="cpf">&lt;cassert&gt;</span><span class="cp"></span>
  117. <span class="k">using</span> <span class="k">namespace</span> <span class="n">boost</span><span class="o">::</span><span class="n">hof</span><span class="p">;</span>
  118. <span class="kt">int</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
  119. <span class="k">auto</span> <span class="n">sum</span> <span class="o">=</span> <span class="n">_</span> <span class="o">+</span> <span class="n">_</span><span class="p">;</span>
  120. <span class="n">assert</span><span class="p">(</span><span class="mi">3</span> <span class="o">==</span> <span class="n">sum</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
  121. <span class="p">}</span>
  122. </pre></div>
  123. </div>
  124. </div>
  125. </div>
  126. </div>
  127. </div>
  128. <div class="clearer"></div>
  129. </div>
  130. <div class="footer" role="contentinfo">
  131. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  132. <td align="left"></td>
  133. <td align="right"><div class="copyright-footer">
  134. &#169; Copyright 2016, Paul Fultz II.
  135. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
  136. <p>Distributed under the Boost Software License, Version 1.0.
  137. (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  138. <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  139. </p>
  140. </div></td>
  141. </tr></table>
  142. </div>
  143. </body>
  144. </html>