replace.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  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: replace</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="./transform.html" class="navigation-link">Prev</a>&nbsp;<a href="./replace-if.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./transform.html" class="navigation-link">Back</a>&nbsp;<a href="./replace-if.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./transformation-algorithms.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="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./transformation-algorithms.html" class="navigation-link">Transformation Algorithms</a> / <a href="./replace.html" class="navigation-link">replace</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="replace">
  15. <h1><a class="toc-backref" href="./transformation-algorithms.html#id1489">replace</a></h1>
  16. <div class="section" id="id642">
  17. <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18. <pre class="literal-block">
  19. template&lt;
  20. typename Sequence
  21. , typename OldType
  22. , typename NewType
  23. , typename In = <em>unspecified</em>
  24. &gt;
  25. struct <a href="./replace.html" class="identifier">replace</a>
  26. {
  27. typedef <em>unspecified</em> type;
  28. };
  29. </pre>
  30. </div>
  31. <div class="section" id="id643">
  32. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  33. <p>Returns a copy of the original sequence where every type identical to <tt class="literal"><span class="pre">OldType</span></tt>
  34. has been replaced with <tt class="literal"><span class="pre">NewType</span></tt>.</p>
  35. <p>[<em>Note:</em> This wording applies to a no-inserter version(s) of the algorithm. See the
  36. <cite>Expression semantics</cite> subsection for a precise specification of the algorithm's
  37. details in all cases — <em>end note</em>]</p>
  38. </div>
  39. <div class="section" id="id644">
  40. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  41. <pre class="literal-block">
  42. #include &lt;<a href="../../../../boost/mpl/replace.hpp" class="header">boost/mpl/replace.hpp</a>&gt;
  43. </pre>
  44. </div>
  45. <div class="section" id="id645">
  46. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  47. <p><a class="reference internal" href="./reversible-algorithm.html">Reversible Algorithm</a></p>
  48. </div>
  49. <div class="section" id="id646">
  50. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  51. <table border="1" class="docutils table">
  52. <colgroup>
  53. <col width="19%" />
  54. <col width="43%" />
  55. <col width="38%" />
  56. </colgroup>
  57. <thead valign="bottom">
  58. <tr><th class="head">Parameter</th>
  59. <th class="head">Requirement</th>
  60. <th class="head">Description</th>
  61. </tr>
  62. </thead>
  63. <tbody valign="top">
  64. <tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
  65. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  66. <td>A original sequence.</td>
  67. </tr>
  68. <tr><td><tt class="literal"><span class="pre">OldType</span></tt></td>
  69. <td>Any type</td>
  70. <td>A type to be replaced.</td>
  71. </tr>
  72. <tr><td><tt class="literal"><span class="pre">NewType</span></tt></td>
  73. <td>Any type</td>
  74. <td>A type to replace with.</td>
  75. </tr>
  76. <tr><td><tt class="literal"><span class="pre">In</span></tt></td>
  77. <td><a class="reference internal" href="./inserter.html">Inserter</a></td>
  78. <td>An inserter.</td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. </div>
  83. <div class="section" id="id647">
  84. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  85. <p>The semantics of an expression are defined only
  86. where they differ from, or are not defined in <a class="reference internal" href="./reversible-algorithm.html">Reversible Algorithm</a>.</p>
  87. <p>For any <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, an <a class="reference internal" href="./inserter.html">Inserter</a> <tt class="literal"><span class="pre">in</span></tt>, and arbitrary types <tt class="literal"><span class="pre">x</span></tt> and <tt class="literal"><span class="pre">y</span></tt>:</p>
  88. <pre class="literal-block">
  89. typedef <a href="./replace.html" class="identifier">replace</a>&lt;s,x,y,in&gt;::type r;
  90. </pre>
  91. <table class="docutils field-list" frame="void" rules="none">
  92. <col class="field-name" />
  93. <col class="field-body" />
  94. <tbody valign="top">
  95. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">A type.</p>
  96. </td>
  97. </tr>
  98. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  99. <pre class="last literal-block">
  100. typedef <a href="./replace-if.html" class="identifier">replace_if</a>&lt; s,y,is_same&lt;_,x&gt;,in &gt;::type r;
  101. </pre>
  102. </td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. </div>
  107. <div class="section" id="id648">
  108. <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  109. <p>Linear. Performs exactly <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span></tt> comparisons for
  110. identity / insertions.</p>
  111. </div>
  112. <div class="section" id="id649">
  113. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  114. <pre class="literal-block">
  115. typedef <a href="./vector.html" class="identifier">vector</a>&lt;int,float,char,float,float,double&gt; types;
  116. typedef <a href="./vector.html" class="identifier">vector</a>&lt;int,double,char,double,double,double&gt; expected;
  117. typedef <a href="./replace.html" class="identifier">replace</a>&lt; types,float,double &gt;::type result;
  118. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>&lt; result,expected > ));
  119. </pre>
  120. </div>
  121. <div class="section" id="id650">
  122. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  123. <p><a class="reference internal" href="./transformation-algorithms.html">Transformation Algorithms</a>, <a class="reference internal" href="./reversible-algorithm.html">Reversible Algorithm</a>, <a class="reference internal" href="./reverse-replace.html">reverse_replace</a>, <a class="reference internal" href="./replace-if.html">replace_if</a>, <a class="reference internal" href="./remove.html">remove</a>, <a class="reference internal" href="./transform.html">transform</a></p>
  124. <!-- Algorithms/Transformation Algorithms//replace_if |50 -->
  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="./transform.html" class="navigation-link">Prev</a>&nbsp;<a href="./replace-if.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./transform.html" class="navigation-link">Back</a>&nbsp;<a href="./replace-if.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./transformation-algorithms.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>