rend.xml 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!--
  3. Copyright 2012 Eric Niebler
  4. Distributed under the Boost
  5. Software License, Version 1.0. (See accompanying
  6. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  7. -->
  8. <header name="boost/proto/functional/range/rend.hpp">
  9. <para>Includes Proto callable <code><classname>boost::proto::functional::rend</classname></code>.</para>
  10. <namespace name="boost">
  11. <namespace name="proto">
  12. <namespace name="functional">
  13. <!-- proto::functional::rend -->
  14. <struct name="rend">
  15. <purpose>A <conceptname>PolymorphicFunctionObject</conceptname> type that invokes the
  16. <code>boost::rend()</code> accessor function on its arguments.</purpose>
  17. <description>
  18. <para>
  19. A <conceptname>PolymorphicFunctionObject</conceptname> type that invokes the
  20. <code>boost::rend()</code> accessor function on its arguments.</para>
  21. </description>
  22. <inherit>
  23. <type><classname>proto::callable</classname></type>
  24. </inherit>
  25. <struct-specialization name="result">
  26. <template>
  27. <template-type-parameter name="This"/>
  28. <template-type-parameter name="Range"/>
  29. </template>
  30. <specialization>
  31. <template-arg>This(Range)</template-arg>
  32. </specialization>
  33. <inherit>
  34. <type>boost::range_reverse_iterator&lt;
  35. typename boost::remove_reference&lt;Range&gt;::type
  36. &gt;</type>
  37. </inherit>
  38. </struct-specialization>
  39. <method-group name="public member functions">
  40. <method name="operator()" cv="const">
  41. <type>typename boost::range_reverse_iterator&lt; Range &gt;::type</type>
  42. <template>
  43. <template-type-parameter name="Range"/>
  44. </template>
  45. <parameter name="rng">
  46. <paramtype>Range &amp;</paramtype>
  47. </parameter>
  48. <returns>
  49. <para><code>boost::rend(rng)</code></para>
  50. </returns>
  51. </method>
  52. <method name="operator()" cv="const">
  53. <type>typename boost::range_reverse_iterator&lt; Range const &gt;::type</type>
  54. <template>
  55. <template-type-parameter name="Range"/>
  56. </template>
  57. <parameter name="rng">
  58. <paramtype>Range const &amp;</paramtype>
  59. </parameter>
  60. <returns>
  61. <para><code>boost::rend(rng)</code></para>
  62. </returns>
  63. </method>
  64. </method-group>
  65. </struct>
  66. </namespace>
  67. </namespace>
  68. </namespace>
  69. </header>