libs/range/doc/reference/adaptors/adjacent_filtered.qbk

   1 [/
   2     Copyright 2010 Neil Groves
   3     Distributed under the Boost Software License, Version 1.0.
   4     (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   5 /]
   6 [section:adjacent_filtered adjacent_filtered]
   7
   8 [table
   9     [[Syntax] [Code]]
  10     [[Pipe] [`rng | boost::adaptors::adjacent_filtered(bi_pred)`]]
  11     [[Function] [`boost::adaptors::adjacent_filter(rng, bi_pred)`]]
  12 ]
  13
  14 * [*Precondition:]  The `value_type` of the range is convertible to both argument types of `bi_pred`.
  15 * [*Postcondition:] For all adjacent elements `[x,y]` in the returned range, `bi_pred(x,y)` is `true`.
  16 * [*Throws:] Whatever the copy constructor of `bi_pred` might throw.
  17 * [*Range Category:] __forward_range__
  18 * [*Return Type:] `boost::adjacent_filtered_range<decltype(rng), decltype(bi_pred)>`
  19 * [*Returned Range Category:] The minimum of the range category of `rng` and __forward_range__
  20
  21 [section:adjacent_filtered_example adjacent_filtered example]
  22 [import ../../../test/adaptor_test/adjacent_filtered_example.cpp]
  23 [adjacent_filtered_example]
  24 [endsect]
  25
  26 This would produce the output:
  27 ``
  28 1,2,3,4,5,6,
  29 ``
  30 [endsect]
  31
  32