indirect.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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>indirect &#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="infix" href="infix.html" />
  25. <link rel="prev" title="implicit" href="implicit.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="implicit.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="infix.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="indirect">
  41. <h1>indirect<a class="headerlink" href="#indirect" 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/indirect.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 <code class="docutils literal"><span class="pre">indirect</span></code> function adaptor dereferences the object before calling it.</p>
  51. </div>
  52. <div class="section" id="synopsis">
  53. <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
  54. <div class="highlight-cpp"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="k">class</span> <span class="nc">F</span><span class="o">&gt;</span>
  55. <span class="k">constexpr</span> <span class="n">indirect_adaptor</span><span class="o">&lt;</span><span class="n">F</span><span class="o">&gt;</span> <span class="n">indirect</span><span class="p">(</span><span class="n">F</span> <span class="n">f</span><span class="p">);</span>
  56. </pre></div>
  57. </div>
  58. </div>
  59. <div class="section" id="semantics">
  60. <h2>Semantics<a class="headerlink" href="#semantics" title="Permalink to this headline">¶</a></h2>
  61. <div class="highlight-cpp"><div class="highlight"><pre><span class="n">assert</span><span class="p">(</span><span class="n">indirect</span><span class="p">(</span><span class="n">f</span><span class="p">)(</span><span class="n">xs</span><span class="p">...)</span> <span class="o">==</span> <span class="p">(</span><span class="o">*</span><span class="n">f</span><span class="p">)(</span><span class="n">xs</span><span class="p">...));</span>
  62. </pre></div>
  63. </div>
  64. </div>
  65. <div class="section" id="requirements">
  66. <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
  67. <p>F must be:</p>
  68. <ul class="simple">
  69. <li>MoveConstructible</li>
  70. <li>Dereferenceable</li>
  71. </ul>
  72. </div>
  73. <div class="section" id="example">
  74. <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
  75. <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>
  76. <span class="cp">#include</span> <span class="cpf">&lt;cassert&gt;</span><span class="cp"></span>
  77. <span class="cp">#include</span> <span class="cpf">&lt;memory&gt;</span><span class="cp"></span>
  78. <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>
  79. <span class="k">struct</span> <span class="n">sum</span>
  80. <span class="p">{</span>
  81. <span class="k">template</span><span class="o">&lt;</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="k">class</span> <span class="nc">U</span><span class="o">&gt;</span>
  82. <span class="n">T</span> <span class="k">operator</span><span class="p">()(</span><span class="n">T</span> <span class="n">x</span><span class="p">,</span> <span class="n">U</span> <span class="n">y</span><span class="p">)</span> <span class="k">const</span>
  83. <span class="p">{</span>
  84. <span class="k">return</span> <span class="n">x</span><span class="o">+</span><span class="n">y</span><span class="p">;</span>
  85. <span class="p">}</span>
  86. <span class="p">};</span>
  87. <span class="kt">int</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
  88. <span class="kt">int</span> <span class="n">r</span> <span class="o">=</span> <span class="n">indirect</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">make_unique</span><span class="o">&lt;</span><span class="n">sum</span><span class="o">&gt;</span><span class="p">())(</span><span class="mi">3</span><span class="p">,</span><span class="mi">2</span><span class="p">);</span>
  89. <span class="n">assert</span><span class="p">(</span><span class="n">r</span> <span class="o">==</span> <span class="mi">5</span><span class="p">);</span>
  90. <span class="p">}</span>
  91. </pre></div>
  92. </div>
  93. </div>
  94. </div>
  95. </div>
  96. </div>
  97. <div class="clearer"></div>
  98. </div>
  99. <div class="footer" role="contentinfo">
  100. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  101. <td align="left"></td>
  102. <td align="right"><div class="copyright-footer">
  103. &#169; Copyright 2016, Paul Fultz II.
  104. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
  105. <p>Distributed under the Boost Software License, Version 1.0.
  106. (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  107. <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  108. </p>
  109. </div></td>
  110. </tr></table>
  111. </div>
  112. </body>
  113. </html>