ceph/src/boost/libs/algorithm/doc/all_of.qbk

   1 [/ File all_of.qbk]
   2
   3 [section:all_of all_of]
   4
   5 [/license
   6 Copyright (c) 2010-2012 Marshall Clow
   7
   8 Distributed under the Boost Software License, Version 1.0.
   9 (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  10 ]
  11
  12 The header file 'boost/algorithm/cxx11/all_of.hpp' contains four variants of a single algorithm, `all_of`. The algorithm tests all the elements of a sequence and returns true if they all share a  property.
  13
  14 The routine `all_of` takes a sequence and a predicate. It will return true if the predicate returns true when applied to every element in the sequence.
  15
  16 The routine `all_of_equal` takes a sequence and a value. It will return true if every element in the sequence compares equal to the passed in value.
  17
  18 Both routines come in two forms; the first one takes two iterators to define the range. The second form takes a single range parameter, and uses Boost.Range to traverse it.
  19
  20
  21 [heading interface]
  22
  23 The function `all_of` returns true if the predicate returns true for every item in the sequence.  There are two versions; one takes two iterators, and the other takes a range.
  24
  25 ``
  26 namespace boost { namespace algorithm {
  27 template<typename InputIterator, typename Predicate>
  28         bool all_of ( InputIterator first, InputIterator last, Predicate p );
  29 template<typename Range, typename Predicate>
  30         bool all_of ( const Range &r, Predicate p );
  31 }}
  32 ``
  33
  34 The function `all_of_equal` is similar to `all_of`, but instead of taking a predicate to test the elements of the sequence, it takes a value to compare against.
  35
  36 ``
  37 namespace boost { namespace algorithm {
  38 template<typename InputIterator, typename V>
  39         bool all_of_equal ( InputIterator first, InputIterator last, V const &val );
  40 template<typename Range, typename V>
  41         bool all_of_equal ( const Range &r, V const &val );
  42 }}
  43 ``
  44
  45 [heading Examples]
  46
  47 Given the container `c` containing `{ 0, 1, 2, 3, 14, 15 }`, then
  48 ``
  49 bool isOdd ( int i ) { return i % 2 == 1; }
  50 bool lessThan10 ( int i ) { return i < 10; }
  51
  52 using boost::algorithm;
  53 all_of ( c, isOdd ) --> false
  54 all_of ( c.begin (), c.end (), lessThan10 ) --> false
  55 all_of ( c.begin (), c.begin () + 3, lessThan10 ) --> true
  56 all_of ( c.end (), c.end (), isOdd ) --> true  // empty range
  57 all_of_equal ( c, 3 ) --> false
  58 all_of_equal ( c.begin () + 3, c.begin () + 4, 3 ) --> true
  59 all_of_equal ( c.begin (), c.begin (), 99 ) --> true  // empty range
  60 ``
  61
  62 [heading Iterator Requirements]
  63
  64 `all_of` and `all_of_equal` work on all iterators except output iterators.
  65
  66 [heading Complexity]
  67
  68 All of the variants of `all_of` and `all_of_equal` run in ['O(N)] (linear) time; that is, they compare against each element in the list once. If any of the comparisons fail, the algorithm will terminate immediately, without examining the remaining members of the sequence.
  69
  70 [heading Exception Safety]
  71
  72 All of the variants of `all_of` and `all_of_equal` take their parameters by value or const reference, and do not depend upon any global state. Therefore, all the routines in this file provide the strong exception guarantee.
  73
  74 [heading Notes]
  75
  76 * The routine `all_of` is also available as part of the C++11 standard.
  77
  78 * `all_of` and `all_of_equal` both return true for empty ranges, no matter what is passed to test against. When there are no items in the sequence to test, they all satisfy the condition to be tested against.
  79
  80 * The second parameter to `all_of_value` is a template parameter, rather than deduced from the first parameter (`std::iterator_traits<InputIterator>::value_type`) because that allows more flexibility for callers, and takes advantage of built-in comparisons for the type that is pointed to by the iterator.  The function is defined to return true if, for all elements in the sequence, the expression `*iter == val` evaluates to true (where `iter` is an iterator to each element in the sequence)
  81
  82 [endsect]
  83
  84 [/ File all_of.qbk
  85 Copyright 2011 Marshall Clow
  86 Distributed under the Boost Software License, Version 1.0.
  87 (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt).
  88 ]
  89