boostorg/iterator
1
0
Fork 1
mirror of https://github.com/boostorg/iterator.git synced 2025-07-29 04:17:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

filled out some missing operator--, added a comment about the operations and concepts,

Browse Source 
and added some text to the indirect iterator example


[SVN r21629]
This commit is contained in:
Jeremy Siek
2004-01-12 15:53:04 +00:00
parent 0074f50573
commit 4a3fd9984d
18 changed files with 482 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
doc/counting_iterator_ref.rst
View File

@ -12,8 +12,11 @@
counting_iterator(counting_iterator const& rhs);
explicit counting_iterator(Incrementable x);
Incrementable base() const;
reference operator*() const;
counting_iterator& operator++();
counting_iterator& operator--();
private:
Incrementable current; // exposition
Incrementable m_inc; // exposition
};
@ -61,6 +64,11 @@ required::
``counting_iterator`` operations
................................
In addition to the operations required by the concepts modeled by
``counting_iterator``, ``counting_iterator`` provides the following
operations.
``counting_iterator();``
:Returns: A default constructed instance of ``counting_iterator``.
@ -74,20 +82,27 @@ required::
``explicit counting_iterator(Incrementable x);``
:Returns: An instance of ``counting_iterator`` with ``current``
:Returns: An instance of ``counting_iterator`` with ``m_inc``
constructed from ``x``.
``reference operator*() const;``
:Returns: ``current``
:Returns: ``m_inc``
``counting_iterator& operator++();``
:Effects: ``++current``
:Effects: ``++m_inc``
:Returns: ``*this``
``counting_iterator& operator--();``
:Effects: ``--m_inc``
:Returns: ``*this``
``Incrementable base() const;``
:Returns: ``current``
:Returns: ``m_inc``