Ticket #5127: transform_iterator_doc.patch

File transform_iterator_doc.patch, 4.1 KB (added by mimomorin@…, 12 years ago)

A patch for transform_iterator_test's documents (against trunk)

  • libs/iterator/doc/transform_iterator.html

     
    9999</pre>
    100100<p>If <tt class="docutils literal"><span class="pre">Reference</span></tt> is <tt class="docutils literal"><span class="pre">use_default</span></tt> then the <tt class="docutils literal"><span class="pre">reference</span></tt> member of
    101101<tt class="docutils literal"><span class="pre">transform_iterator</span></tt> is
    102 <tt class="docutils literal"><span class="pre">result_of&lt;UnaryFunction(iterator_traits&lt;Iterator&gt;::reference)&gt;::type</span></tt>.
     102<tt class="docutils literal"><span class="pre">result_of&lt;const UnaryFunction(iterator_traits&lt;Iterator&gt;::reference)&gt;::type</span></tt>.
    103103Otherwise, <tt class="docutils literal"><span class="pre">reference</span></tt> is <tt class="docutils literal"><span class="pre">Reference</span></tt>.</p>
    104104<p>If <tt class="docutils literal"><span class="pre">Value</span></tt> is <tt class="docutils literal"><span class="pre">use_default</span></tt> then the <tt class="docutils literal"><span class="pre">value_type</span></tt> member is
    105105<tt class="docutils literal"><span class="pre">remove_cv&lt;remove_reference&lt;reference&gt;</span> <span class="pre">&gt;::type</span></tt>.  Otherwise,
     
    117117<div class="section" id="transform-iterator-requirements">
    118118<h1><a class="toc-backref" href="#id3"><tt class="docutils literal"><span class="pre">transform_iterator</span></tt> requirements</a></h1>
    119119<p>The type <tt class="docutils literal"><span class="pre">UnaryFunction</span></tt> must be Assignable, Copy Constructible, and
    120 the expression <tt class="docutils literal"><span class="pre">f(*i)</span></tt> must be valid where <tt class="docutils literal"><span class="pre">f</span></tt> is an object of
     120the expression <tt class="docutils literal"><span class="pre">f(*i)</span></tt> must be valid where <tt class="docutils literal"><span class="pre">f</span></tt> is a const object of
    121121type <tt class="docutils literal"><span class="pre">UnaryFunction</span></tt>, <tt class="docutils literal"><span class="pre">i</span></tt> is an object of type <tt class="docutils literal"><span class="pre">Iterator</span></tt>, and
    122122where the type of <tt class="docutils literal"><span class="pre">f(*i)</span></tt> must be
    123 <tt class="docutils literal"><span class="pre">result_of&lt;UnaryFunction(iterator_traits&lt;Iterator&gt;::reference)&gt;::type</span></tt>.</p>
     123<tt class="docutils literal"><span class="pre">result_of&lt;const UnaryFunction(iterator_traits&lt;Iterator&gt;::reference)&gt;::type</span></tt>.</p>
    124124<p>The argument <tt class="docutils literal"><span class="pre">Iterator</span></tt> shall model Readable Iterator.</p>
    125125</div>
    126126<div class="section" id="transform-iterator-models">
  • libs/iterator/doc/transform_iterator_ref.rst

     
    4141
    4242If ``Reference`` is ``use_default`` then the ``reference`` member of
    4343``transform_iterator`` is
    44 ``result_of<UnaryFunction(iterator_traits<Iterator>::reference)>::type``.
     44``result_of<const UnaryFunction(iterator_traits<Iterator>::reference)>::type``.
    4545Otherwise, ``reference`` is ``Reference``.
    4646
    4747If ``Value`` is ``use_default`` then the ``value_type`` member is
     
    6464...................................
    6565
    6666The type ``UnaryFunction`` must be Assignable, Copy Constructible, and
    67 the expression ``f(*i)`` must be valid where ``f`` is an object of
     67the expression ``f(*i)`` must be valid where ``f`` is a const object of
    6868type ``UnaryFunction``, ``i`` is an object of type ``Iterator``, and
    6969where the type of ``f(*i)`` must be
    70 ``result_of<UnaryFunction(iterator_traits<Iterator>::reference)>::type``.
     70``result_of<const UnaryFunction(iterator_traits<Iterator>::reference)>::type``.
    7171
    7272The argument ``Iterator`` shall model Readable Iterator. 
    7373