boost_mirror/iterator
1
0
Fork 0
mirror of https://github.com/boostorg/iterator.git synced 2025-05-09 23:23:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

updating documentation to reflect new and more sensible behavior

Browse Source 
[SVN r80468]
This commit is contained in:
Jeffrey Lee Hellrung, Jr. 2012-09-09 15:51:22 +00:00
parent 31c3971720
commit c6f3269f4a
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/function_input_iterator.rst
View File

@ -18,11 +18,14 @@ the iterator has been incremented. A Function Input Iterator models the
.. _InputIterator: http://www.sgi.com/tech/stl/InputIterator.html .. _InputIterator: http://www.sgi.com/tech/stl/InputIterator.html
Like the Generator Iterator, the Function Input Iterator takes a function The Function Input Iterator takes a function that models the Generator_ concept
that models the Generator_ concept (which is basically a nullary or 0-arity (which is basically a nullary or 0-arity function object). The first dereference
function object). Each increment of the function Function Input Iterator of the iterator at a given position invokes the generator function and stores
invokes the generator function and stores the value in the iterator. When and returns the result; subsequent dereferences at the same position simply
the iterator is dereferenced the stored value is returned. return the same stored result. Incrementing the iterator places it at a new
position, hence a subsequent dereference will generate a new value via another
invokation of the generator function. This ensures the generator function is
invoked precisely when the iterator is requested to return a (new) value.
.. _Generator: http://www.sgi.com/tech/stl/Generator.html .. _Generator: http://www.sgi.com/tech/stl/Generator.html