From 1e3b131a849ddc2a6436a0d89a44320bda13ec16 Mon Sep 17 00:00:00 2001 From: Jeremy Siek Date: Tue, 13 Jan 2004 02:53:04 +0000 Subject: [PATCH] some changes from Dave [SVN r21658] --- doc/filter_iterator.rst | 2 +- doc/filter_iterator_abstract.rst | 19 ++++++++++--------- doc/filter_iterator_ref.rst | 2 +- doc/function_output_iterator.rst | 2 +- doc/indirect_iterator.rst | 2 +- doc/make_filter_iterator.rst | 16 +++++++++------- doc/permutation_iterator.rst | 2 +- doc/reverse_iterator.rst | 2 +- doc/reverse_iterator_ref.rst | 25 ++++--------------------- doc/transform_iterator.rst | 2 +- 10 files changed, 30 insertions(+), 44 deletions(-) diff --git a/doc/filter_iterator.rst b/doc/filter_iterator.rst index b4e3286..ceb7adc 100644 --- a/doc/filter_iterator.rst +++ b/doc/filter_iterator.rst @@ -16,7 +16,7 @@ :abstract: -.. include:: filter_iterator_abstract.rst + .. include:: filter_iterator_abstract.rst .. contents:: Table of Contents diff --git a/doc/filter_iterator_abstract.rst b/doc/filter_iterator_abstract.rst index 9517b23..4695478 100644 --- a/doc/filter_iterator_abstract.rst +++ b/doc/filter_iterator_abstract.rst @@ -1,10 +1,11 @@ The filter iterator adaptor creates a view of an iterator range in -which some elements of the range are skipped over. A predicate -function object controls which elements are skipped. When the -predicate is applied to an element, if it returns ``true`` then the -element is retained and if it returns ``false`` then the element is -skipped over. When skipping over elements, it is necessary for the -filter adaptor to know when to stop so as to avoid going past the end -of the underlying range. Therefore the constructor of the filter -iterator takes two iterator parameters: the position for the filtered -iterator and the end of the range. +which some elements of the range are skipped. A predicate function +object controls which elements are skipped. When the predicate is +applied to an element, if it returns ``true`` then the element is +retained and if it returns ``false`` then the element is skipped +over. When skipping over elements, it is necessary for the filter +adaptor to know when to stop so as to avoid going past the end of the +underlying range. A filter iterator is therefore constructed with pair +of iterators indicating the range of elements in the unfiltered +sequence to be traversed. + diff --git a/doc/filter_iterator_ref.rst b/doc/filter_iterator_ref.rst index c668555..172d732 100644 --- a/doc/filter_iterator_ref.rst +++ b/doc/filter_iterator_ref.rst @@ -54,7 +54,7 @@ Input Iterator. ``filter_iterator`` models .......................... -The concepts that ``filter_iterator`` models are dependent on what +The concepts that ``filter_iterator`` models are dependent on which concepts the ``Iterator`` argument models, as specified in the following tables. diff --git a/doc/function_output_iterator.rst b/doc/function_output_iterator.rst index 918ec79..01ac022 100644 --- a/doc/function_output_iterator.rst +++ b/doc/function_output_iterator.rst @@ -16,7 +16,7 @@ :abstract: -.. include:: function_output_iterator_abstract.rst + .. include:: function_output_iterator_abstract.rst .. contents:: Table of Contents diff --git a/doc/indirect_iterator.rst b/doc/indirect_iterator.rst index 3624834..b23afa8 100644 --- a/doc/indirect_iterator.rst +++ b/doc/indirect_iterator.rst @@ -16,7 +16,7 @@ :abstract: -.. include:: indirect_iterator_abstract.rst + .. include:: indirect_iterator_abstract.rst .. contents:: Table of Contents diff --git a/doc/make_filter_iterator.rst b/doc/make_filter_iterator.rst index 8400d9d..8ae5e08 100755 --- a/doc/make_filter_iterator.rst +++ b/doc/make_filter_iterator.rst @@ -5,17 +5,19 @@ filter_iterator make_filter_iterator(Predicate f, Iterator x, Iterator end = Iterator()); -:Returns: An instance of ``filter_iterator`` at - the first position in the range ``[x,end)`` such that - ``f(*this->base()) == true`` or else at position ``end``. - +:Returns: An instance of ``filter_iterator`` + where ``m_iter`` is either the first position in the range ``[x,end)`` such that + ``f(*this->base()) == true`` or else ``m_iter == end``. + The member ``m_pred`` is constructed from ``f`` and ``m_end`` from ``end``. :: template filter_iterator make_filter_iterator(Iterator x, Iterator end = Iterator()); -:Returns: An instance of ``filter_iterator`` at - the first position in the range ``[x,end)`` +:Returns: An instance of ``filter_iterator`` + where ``m_iter`` is either the first position in the range ``[x,end)`` such that ``f(*this->base()) == true``, where ``f`` is a default - constructed ``Predicate``, or else at position ``end``. \ No newline at end of file + constructed ``Predicate``, or else ``m_iter == end``. + The member ``m_pred`` is default constructed and ``m_end`` + is constructed from ``end``. \ No newline at end of file diff --git a/doc/permutation_iterator.rst b/doc/permutation_iterator.rst index 655bec8..11fa6e1 100644 --- a/doc/permutation_iterator.rst +++ b/doc/permutation_iterator.rst @@ -14,7 +14,7 @@ :abstract: -.. include:: permutation_iterator_abstract.rst + .. include:: permutation_iterator_abstract.rst .. contents:: Table of Contents diff --git a/doc/reverse_iterator.rst b/doc/reverse_iterator.rst index 000a770..0f4979b 100644 --- a/doc/reverse_iterator.rst +++ b/doc/reverse_iterator.rst @@ -16,7 +16,7 @@ :abstract: -.. include:: reverse_iterator_abstract.rst + .. include:: reverse_iterator_abstract.rst .. contents:: Table of Contents diff --git a/doc/reverse_iterator_ref.rst b/doc/reverse_iterator_ref.rst index 8403ad2..b675250 100644 --- a/doc/reverse_iterator_ref.rst +++ b/doc/reverse_iterator_ref.rst @@ -42,27 +42,10 @@ Iterator and Readable Iterator. ``reverse_iterator`` models ........................... -The concepts that ``reverse_iterator`` models are dependent on what -concepts the ``Iterator`` argument models, as specified in the -following tables. - -+----------------------------------+-------------------------------------+ -| If ``Iterator`` models | then ``reverse_iterator`` models | -+==================================+=====================================+ -| Bidirectional Traversal Iterator | Bidirectional Traversal Iterator | -+----------------------------------+-------------------------------------+ -| Random Access Traversal Iterator | Random Access Traversal Iterator | -+----------------------------------+-------------------------------------+ - -+--------------------------------+----------------------------------------------+ -| If ``Iterator`` models | then ``reverse_iterator`` models | -+================================+==============================================+ -| Readable Iterator | Readable Iterator | -+--------------------------------+----------------------------------------------+ -| Writable Iterator | Writable Iterator | -+--------------------------------+----------------------------------------------+ -| Lvalue Iterator | Lvalue Iterator | -+--------------------------------+----------------------------------------------+ +``reverse_iterator`` models the same standard traversal and access +iterator concepts that the ``Iterator`` argument models. In addition, +``reverse_iterator`` models the old iterator concepts specified in the +following table, depnding on what the ``Iterator`` argument models. +-------------------------------------------------------+----------------------------------+ diff --git a/doc/transform_iterator.rst b/doc/transform_iterator.rst index d49e35c..362db85 100644 --- a/doc/transform_iterator.rst +++ b/doc/transform_iterator.rst @@ -16,7 +16,7 @@ :abstract: -.. include:: transform_iterator_abstract.rst + .. include:: transform_iterator_abstract.rst .. contents:: Table of Contents