[Boost-bugs] [Boost C++ Libraries] #9367: Minor typo in Boost.Algorithm

Subject: [Boost-bugs] [Boost C++ Libraries] #9367: Minor typo in Boost.Algorithm
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-11-12 03:55:57

#9367: Minor typo in Boost.Algorithm
-------------------------------------+-----------------------
 Reporter:  oss.2012.team+2013C@…    |      Owner:  marshall
     Type:  Bugs                     |     Status:  new
Milestone:  To Be Determined         |  Component:  algorithm
  Version:  Boost Development Trunk  |   Severity:  Cosmetic
 Keywords:                           |
-------------------------------------+-----------------------
 Patch attached for fixing it.

 Additional comments:

 In `ordered-hpp.qbk`, the iterator requirements for `is_sorted` say
   The is_sorted functions will work on all kinds of iterators (except
 output iterators).
 So I think it would be better to use `InputIterator` rather than
 `Iterator` for template parameters:
 {{{
 #!diff
 Index: libs/algorithm/doc/ordered-hpp.qbk
 ===================================================================
 --- libs/algorithm/doc/ordered-hpp.qbk  (revision 86541)
 +++ libs/algorithm/doc/ordered-hpp.qbk  (working copy)
 @@ -19,11 +19,11 @@

  ``
  namespace boost { namespace algorithm {
 -       template <typename Iterator, typename Pred>
 -       bool is_sorted ( Iterator first, Iterator last, Pred p );
 +       template <typename InputIterator, typename Pred>
 +       bool is_sorted ( InputIterator first, InputIterator last, Pred p
 );

 -       template <typename Iterator>
 -       bool is_sorted ( Iterator first, Iterator last );
 +       template <typename InputIterator>
 +       bool is_sorted ( InputIterator first, InputIterator last );


         template <typename Range, typename Pred>
 }}}
 Ditto for is_decreasing/increasing and is_strictly_decreasing/increasing.

 In `is_sorted.hpp`, the DOXYGEN comments for `is_sorted` use
 `ForwardIterator`.
 Is that a typo of `InputIterator`?
 Ditto for is_decreasing/increasing and is_strictly_decreasing/increasing.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/9367>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.