Squashed 'third_party/boostorg/range/' content from commit 4cfd4d8
Change-Id: I641c49f21039952b16f888223a952503e43a28a9
git-subtree-dir: third_party/boostorg/range
git-subtree-split: 4cfd4d8287ca949d7f29256adf3e796a0d1775ec
diff --git a/doc/headers.qbk b/doc/headers.qbk
new file mode 100644
index 0000000..2e5ae02
--- /dev/null
+++ b/doc/headers.qbk
@@ -0,0 +1,143 @@
+[/
+ Copyright 2010 Neil Groves
+ 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)
+/]
+[section:headers Library Headers]
+
+[section:general General]
+[table
+ [[Header ] [Includes ] [Related Concept ]]
+ [[`<boost/range.hpp>` ] [everything from Boost.Range version 1 (Boost versions 1.42 and below). Includes the core range functions and metafunctions, but excludes Range Adaptors and Range Algorithms. ] [- ]]
+ [[`<boost/range/metafunctions.hpp>` ] [every metafunction ] [- ]]
+ [[`<boost/range/functions.hpp>` ] [every function ] [- ]]
+ [[`<boost/range/value_type.hpp>` ] [__range_value__ ] [__single_pass_range__ ]]
+ [[`<boost/range/iterator.hpp>` ] [__range_iterator__ ] [__single_pass_range__ ]]
+ [[`<boost/range/difference_type.hpp>` ] [__range_difference__ ] [__forward_range__ ]]
+ [[`<boost/range/pointer.hpp>` ] [__range_pointer__ ] [-]]
+ [[`<boost/range/category.hpp>` ] [__range_category__ ] [-]]
+ [[`<boost/range/reverse_iterator.hpp>`] [__range_reverse_iterator__ ] [__bidirectional_range__ ]]
+ [[`<boost/range/begin.hpp>` ] [__begin__ and __const_begin__ ] [__single_pass_range__ ]]
+ [[`<boost/range/end.hpp>` ] [__end__ and __const_end__ ] [__single_pass_range__ ]]
+ [[`<boost/range/empty.hpp>` ] [__empty__ ] [__single_pass_range__ ]]
+ [[`<boost/range/distance.hpp>` ] [__distance__ ] [__forward_range__ ]]
+ [[`<boost/range/size.hpp>` ] [__size__ ] [__random_access_range__ ]]
+ [[`<boost/range/rbegin.hpp>` ] [__rbegin__ and __const_rbegin__] [__bidirectional_range__ ]]
+ [[`<boost/range/rend.hpp>` ] [__rend__ and __const_rend__ ] [__bidirectional_range__ ]]
+ [[`<boost/range/as_array.hpp>` ] [__as_array__ ] [- ]]
+ [[`<boost/range/as_literal.hpp>` ] [__as_literal__ ] [- ]]
+ [[`<boost/range/iterator_range.hpp>` ] [__iterator_range__ ] [- ]]
+ [[`<boost/range/sub_range.hpp>` ] [__sub_range__ ] [- ]]
+ [[`<boost/range/concepts.hpp>` ] [__range_concepts__ ] [- ]]
+ [[`<boost/range/adaptors.hpp>` ] [every range adaptor ] [- ]]
+ [[`<boost/range/algorithm.hpp>` ] [every range equivalent of an STL algorithm ] [- ]]
+ [[`<boost/range/algorithm_ext.hpp>` ] [every range algorithm that is an extension of the STL algorithms ] [- ]]
+ [[`<boost/range/counting_range.hpp>` ] [ __counting_range__ ] [-]]
+ [[`<boost/range/istream_range.hpp>` ] [ __istream_range__ ] [-]]
+ [[`<boost/range/irange.hpp>` ] [ __irange__ ] [-]]
+ [[`<boost/range/join.hpp>` ] [ __join__ ] [-]]
+]
+[endsect]
+
+[section:adaptors Adaptors]
+[table
+ [[Header ][Includes ]]
+ [[`<boost/range/adaptor/adjacent_filtered.hpp>`] [__range_adaptors_adjacent_filtered__ ]]
+ [[`<boost/range/adaptor/copied.hpp>`] [__range_adaptors_copied__]]
+ [[`<boost/range/adaptor/filtered.hpp>`] [__range_adaptors_filtered__]]
+ [[`<boost/range/adaptor/indexed.hpp>`] [__range_adaptors_indexed__]]
+ [[`<boost/range/adaptor/indirected.hpp>`] [__range_adaptors_indirected__]]
+ [[`<boost/range/adaptor/map.hpp>`] [__range_adaptors_map_keys__ __range_adaptors_map_values__]]
+ [[`<boost/range/adaptor/replaced.hpp>`] [__range_adaptors_replaced__]]
+ [[`<boost/range/adaptor/replaced_if.hpp>`] [__range_adaptors_replaced_if__]]
+ [[`<boost/range/adaptor/reversed.hpp>`] [__range_adaptors_reversed__]]
+ [[`<boost/range/adaptor/sliced.hpp>`] [__range_adaptors_sliced__]]
+ [[`<boost/range/adaptor/strided.hpp>`] [__range_adaptors_strided__]]
+ [[`<boost/range/adaptor/tokenized.hpp>`] [__range_adaptors_tokenized__]]
+ [[`<boost/range/adaptor/transformed.hpp>`] [__range_adaptors_transformed__]]
+ [[`<boost/range/adaptor/uniqued.hpp>`] [__range_adaptors_uniqued__]]
+]
+[endsect]
+
+[section:algorithm Algorithm]
+[table
+ [[Header ][Includes ]]
+ [[`<boost/range/algorithm/adjacent_find.hpp>`] [__range_algorithms_adjacent_find__]]
+ [[`<boost/range/algorithm/binary_search.hpp>`] [__range_algorithms_binary_search__]]
+ [[`<boost/range/algorithm/copy.hpp>`] [__range_algorithms_copy__]]
+ [[`<boost/range/algorithm/copy_backward.hpp>`] [__range_algorithms_copy_backward__]]
+ [[`<boost/range/algorithm/count.hpp>`] [__range_algorithms_count__]]
+ [[`<boost/range/algorithm/count_if.hpp>`] [__range_algorithms_count_if__]]
+ [[`<boost/range/algorithm/equal.hpp>`] [__range_algorithms_equal__]]
+ [[`<boost/range/algorithm/equal_range.hpp>`] [__range_algorithms_equal_range__]]
+ [[`<boost/range/algorithm/fill.hpp>`] [__range_algorithms_fill__]]
+ [[`<boost/range/algorithm/fill_n.hpp>`] [__range_algorithms_fill_n__]]
+ [[`<boost/range/algorithm/find.hpp>`] [__range_algorithms_find__]]
+ [[`<boost/range/algorithm/find_end.hpp>`] [__range_algorithms_find_end__]]
+ [[`<boost/range/algorithm/find_first_of.hpp>`] [__range_algorithms_find_first_of__]]
+ [[`<boost/range/algorithm/find_if.hpp>`] [__range_algorithms_find_if__]]
+ [[`<boost/range/algorithm/for_each.hpp>`] [__range_algorithms_for_each__]]
+ [[`<boost/range/algorithm/generate.hpp>`] [__range_algorithms_generate__]]
+ [[`<boost/range/algorithm/heap_algorithm.hpp>`] [__range_algorithms_push_heap__
+ __range_algorithms_pop_heap__
+ __range_algorithms_make_heap__
+ __range_algorithms_sort_heap__]]
+ [[`<boost/range/algorithm/inplace_merge.hpp>`] [__range_algorithms_inplace_merge__]]
+ [[`<boost/range/algorithm/lexicographical_compare.hpp>`] [__range_algorithms_lexicographical_compare__]]
+ [[`<boost/range/algorithm/lower_bound.hpp>`] [__range_algorithms_lower_bound__]]
+ [[`<boost/range/algorithm/max_element.hpp>`] [__range_algorithms_max_element__]]
+ [[`<boost/range/algorithm/merge.hpp>`] [__range_algorithms_merge__]]
+ [[`<boost/range/algorithm/min_element.hpp>`] [__range_algorithms_min_element__]]
+ [[`<boost/range/algorithm/mismatch.hpp>`] [__range_algorithms_mismatch__]]
+ [[`<boost/range/algorithm/nth_element.hpp>`] [__range_algorithms_nth_element__]]
+ [[`<boost/range/algorithm/partial_sort.hpp>`] [__range_algorithms_partial_sort__]]
+ [[`<boost/range/algorithm/partition.hpp>`] [__range_algorithms_partition__]]
+ [[`<boost/range/algorithm/permutation.hpp>`] [__range_algorithms_next_permutation__
+ __range_algorithms_prev_permutation__]]
+ [[`<boost/range/algorithm/random_shuffle.hpp>`] [__range_algorithms_random_shuffle__]]
+ [[`<boost/range/algorithm/remove.hpp>`] [__range_algorithms_remove__]]
+ [[`<boost/range/algorithm/remove_copy.hpp>`] [__range_algorithms_remove_copy__]]
+ [[`<boost/range/algorithm/remove_copy_if.hpp>`] [__range_algorithms_remove_copy_if__]]
+ [[`<boost/range/algorithm/remove_if.hpp>`] [__range_algorithms_remove_if__]]
+ [[`<boost/range/algorithm/replace.hpp>`] [__range_algorithms_replace__]]
+ [[`<boost/range/algorithm/replace_copy.hpp>`] [__range_algorithms_replace_copy__]]
+ [[`<boost/range/algorithm/replace_copy_if.hpp>`] [__range_algorithms_replace_copy_if__]]
+ [[`<boost/range/algorithm/replace_if.hpp>`] [__range_algorithms_replace_if__]]
+ [[`<boost/range/algorithm/reverse.hpp>`] [__range_algorithms_reverse__]]
+ [[`<boost/range/algorithm/reverse_copy.hpp>`] [__range_algorithms_reverse_copy__]]
+ [[`<boost/range/algorithm/rotate.hpp>`] [__range_algorithms_rotate__]]
+ [[`<boost/range/algorithm/rotate_copy.hpp>`] [__range_algorithms_rotate_copy__]]
+ [[`<boost/range/algorithm/search.hpp>`] [__range_algorithms_search__]]
+ [[`<boost/range/algorithm/search_n.hpp>`] [__range_algorithms_search_n__]]
+ [[`<boost/range/algorithm/set_algorithm.hpp>`] [__range_algorithms_includes__
+ __range_algorithms_set_union__
+ __range_algorithms_set_intersection__
+ __range_algorithms_set_difference__
+ __range_algorithms_set_symmetric_difference__]]
+ [[`<boost/range/algorithm/sort.hpp>`] [__range_algorithms_sort__]]
+ [[`<boost/range/algorithm/stable_partition.hpp>`] [__range_algorithms_stable_partition__]]
+ [[`<boost/range/algorithm/swap_ranges.hpp>`] [__range_algorithms_swap_ranges__]]
+ [[`<boost/range/algorithm/transform.hpp>`] [__range_algorithms_transform__]]
+ [[`<boost/range/algorithm/unique.hpp>`] [__range_algorithms_unique__]]
+ [[`<boost/range/algorithm/unique_copy.hpp>`] [__range_algorithms_unique_copy__]]
+ [[`<boost/range/algorithm/upper_bound.hpp>`] [__range_algorithms_upper_bound__]]
+]
+[endsect]
+
+[section:algorithm_ext Algorithm Extensions]
+[table
+ [[Header ][Includes ]]
+ [[`<boost/range/algorithm_ext/copy_n.hpp>`] [__range_algorithm_ext_copy_n__]]
+ [[`<boost/range/algorithm_ext/erase.hpp>`] [__range_algorithm_ext_erase__]]
+ [[`<boost/range/algorithm_ext/for_each.hpp>`] [__range_algorithm_ext_for_each__]]
+ [[`<boost/range/algorithm_ext/insert.hpp>`] [__range_algorithm_ext_insert__]]
+ [[`<boost/range/algorithm_ext/iota.hpp>`] [__range_algorithm_ext_iota__]]
+ [[`<boost/range/algorithm_ext/is_sorted.hpp>`] [__range_algorithm_ext_is_sorted__]]
+ [[`<boost/range/algorithm_ext/overwrite.hpp>`] [__range_algorithm_ext_overwrite__]]
+ [[`<boost/range/algorithm_ext/push_back.hpp>`] [__range_algorithm_ext_push_back__]]
+ [[`<boost/range/algorithm_ext/push_front.hpp>`] [__range_algorithm_ext_push_front__]]
+]
+[endsect]
+
+[endsect]
+