[ceph.git] / ceph / src / boost / libs / iterator / doc / filter_iterator_abstract.rst

.. Copyright David Abrahams 2006. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

The filter iterator adaptor creates a view of an iterator range in
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.
Commit	Line	Data
7c673cae FG	1	.. Copyright David Abrahams 2006. Distributed under the Boost
	2	.. Software License, Version 1.0. (See accompanying
	3	.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
	4
	5	The filter iterator adaptor creates a view of an iterator range in
	6	which some elements of the range are skipped. A predicate function
	7	object controls which elements are skipped. When the predicate is
	8	applied to an element, if it returns ``true`` then the element is
	9	retained and if it returns ``false`` then the element is skipped
	10	over. When skipping over elements, it is necessary for the filter
	11	adaptor to know when to stop so as to avoid going past the end of the
	12	underlying range. A filter iterator is therefore constructed with pair
	13	of iterators indicating the range of elements in the unfiltered
	14	sequence to be traversed.
	15