• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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:headers Library Headers]
7
8[section:general General]
9[table
10    [[Header                              ] [Includes                   ] [Related Concept         ]]
11    [[`<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. ] [-                       ]]
12    [[`<boost/range/metafunctions.hpp>`   ] [every metafunction         ] [-                       ]]
13    [[`<boost/range/functions.hpp>`       ] [every function             ] [-                       ]]
14    [[`<boost/range/value_type.hpp>`      ] [__range_value__            ] [__single_pass_range__   ]]
15    [[`<boost/range/iterator.hpp>`        ] [__range_iterator__         ] [__single_pass_range__   ]]
16    [[`<boost/range/difference_type.hpp>` ] [__range_difference__       ] [__forward_range__       ]]
17    [[`<boost/range/pointer.hpp>`         ] [__range_pointer__          ] [-]]
18    [[`<boost/range/category.hpp>`        ] [__range_category__         ] [-]]
19    [[`<boost/range/reverse_iterator.hpp>`] [__range_reverse_iterator__ ] [__bidirectional_range__ ]]
20    [[`<boost/range/begin.hpp>`           ] [__begin__ and __const_begin__ ] [__single_pass_range__   ]]
21    [[`<boost/range/end.hpp>`             ] [__end__ and __const_end__  ] [__single_pass_range__   ]]
22    [[`<boost/range/empty.hpp>`           ] [__empty__                  ] [__single_pass_range__   ]]
23    [[`<boost/range/distance.hpp>`        ] [__distance__               ] [__forward_range__       ]]
24    [[`<boost/range/size.hpp>`            ] [__size__                   ] [__random_access_range__ ]]
25    [[`<boost/range/rbegin.hpp>`          ] [__rbegin__ and __const_rbegin__] [__bidirectional_range__ ]]
26    [[`<boost/range/rend.hpp>`            ] [__rend__ and __const_rend__ ] [__bidirectional_range__ ]]
27    [[`<boost/range/as_array.hpp>`        ] [__as_array__               ] [-                       ]]
28    [[`<boost/range/as_literal.hpp>`      ] [__as_literal__             ] [-                       ]]
29    [[`<boost/range/iterator_range.hpp>`  ] [__iterator_range__         ] [-                       ]]
30    [[`<boost/range/sub_range.hpp>`       ] [__sub_range__              ] [-                       ]]
31    [[`<boost/range/concepts.hpp>`        ] [__range_concepts__         ] [-                       ]]
32    [[`<boost/range/adaptors.hpp>`        ] [every range adaptor        ] [-                       ]]
33    [[`<boost/range/algorithm.hpp>`       ] [every range equivalent of an STL algorithm ] [-                       ]]
34    [[`<boost/range/algorithm_ext.hpp>`   ] [every range algorithm that is an extension of the STL algorithms ] [-                       ]]
35    [[`<boost/range/counting_range.hpp>`  ] [ __counting_range__ ] [-]]
36    [[`<boost/range/istream_range.hpp>`   ] [ __istream_range__ ] [-]]
37    [[`<boost/range/irange.hpp>`          ] [ __irange__ ] [-]]
38    [[`<boost/range/join.hpp>`            ] [ __join__ ] [-]]
39]
40[endsect]
41
42[section:adaptors Adaptors]
43[table
44    [[Header                                        ][Includes                                           ]]
45    [[`<boost/range/adaptor/adjacent_filtered.hpp>`] [__range_adaptors_adjacent_filtered__ ]]
46    [[`<boost/range/adaptor/copied.hpp>`]            [__range_adaptors_copied__]]
47    [[`<boost/range/adaptor/filtered.hpp>`]          [__range_adaptors_filtered__]]
48    [[`<boost/range/adaptor/indexed.hpp>`]           [__range_adaptors_indexed__]]
49    [[`<boost/range/adaptor/indirected.hpp>`]        [__range_adaptors_indirected__]]
50    [[`<boost/range/adaptor/map.hpp>`]               [__range_adaptors_map_keys__ __range_adaptors_map_values__]]
51    [[`<boost/range/adaptor/replaced.hpp>`]          [__range_adaptors_replaced__]]
52    [[`<boost/range/adaptor/replaced_if.hpp>`]       [__range_adaptors_replaced_if__]]
53    [[`<boost/range/adaptor/reversed.hpp>`]          [__range_adaptors_reversed__]]
54    [[`<boost/range/adaptor/sliced.hpp>`]            [__range_adaptors_sliced__]]
55    [[`<boost/range/adaptor/strided.hpp>`]           [__range_adaptors_strided__]]
56    [[`<boost/range/adaptor/tokenized.hpp>`]         [__range_adaptors_tokenized__]]
57    [[`<boost/range/adaptor/transformed.hpp>`]       [__range_adaptors_transformed__]]
58    [[`<boost/range/adaptor/uniqued.hpp>`]           [__range_adaptors_uniqued__]]
59]
60[endsect]
61
62[section:algorithm Algorithm]
63[table
64    [[Header                                        ][Includes                                           ]]
65    [[`<boost/range/algorithm/adjacent_find.hpp>`]           [__range_algorithms_adjacent_find__]]
66    [[`<boost/range/algorithm/binary_search.hpp>`]           [__range_algorithms_binary_search__]]
67    [[`<boost/range/algorithm/copy.hpp>`]                    [__range_algorithms_copy__]]
68    [[`<boost/range/algorithm/copy_backward.hpp>`]           [__range_algorithms_copy_backward__]]
69    [[`<boost/range/algorithm/count.hpp>`]                   [__range_algorithms_count__]]
70    [[`<boost/range/algorithm/count_if.hpp>`]                [__range_algorithms_count_if__]]
71    [[`<boost/range/algorithm/equal.hpp>`]                   [__range_algorithms_equal__]]
72    [[`<boost/range/algorithm/equal_range.hpp>`]             [__range_algorithms_equal_range__]]
73    [[`<boost/range/algorithm/fill.hpp>`]                    [__range_algorithms_fill__]]
74    [[`<boost/range/algorithm/fill_n.hpp>`]                  [__range_algorithms_fill_n__]]
75    [[`<boost/range/algorithm/find.hpp>`]                    [__range_algorithms_find__]]
76    [[`<boost/range/algorithm/find_end.hpp>`]                [__range_algorithms_find_end__]]
77    [[`<boost/range/algorithm/find_first_of.hpp>`]           [__range_algorithms_find_first_of__]]
78    [[`<boost/range/algorithm/find_if.hpp>`]                 [__range_algorithms_find_if__]]
79    [[`<boost/range/algorithm/for_each.hpp>`]                [__range_algorithms_for_each__]]
80    [[`<boost/range/algorithm/generate.hpp>`]                [__range_algorithms_generate__]]
81    [[`<boost/range/algorithm/heap_algorithm.hpp>`]          [__range_algorithms_push_heap__
82                                                              __range_algorithms_pop_heap__
83                                                              __range_algorithms_make_heap__
84                                                              __range_algorithms_sort_heap__]]
85    [[`<boost/range/algorithm/inplace_merge.hpp>`]           [__range_algorithms_inplace_merge__]]
86    [[`<boost/range/algorithm/lexicographical_compare.hpp>`] [__range_algorithms_lexicographical_compare__]]
87    [[`<boost/range/algorithm/lower_bound.hpp>`]             [__range_algorithms_lower_bound__]]
88    [[`<boost/range/algorithm/max_element.hpp>`]             [__range_algorithms_max_element__]]
89    [[`<boost/range/algorithm/merge.hpp>`]                   [__range_algorithms_merge__]]
90    [[`<boost/range/algorithm/min_element.hpp>`]             [__range_algorithms_min_element__]]
91    [[`<boost/range/algorithm/mismatch.hpp>`]                [__range_algorithms_mismatch__]]
92    [[`<boost/range/algorithm/nth_element.hpp>`]             [__range_algorithms_nth_element__]]
93    [[`<boost/range/algorithm/partial_sort.hpp>`]            [__range_algorithms_partial_sort__]]
94    [[`<boost/range/algorithm/partition.hpp>`]               [__range_algorithms_partition__]]
95    [[`<boost/range/algorithm/permutation.hpp>`]             [__range_algorithms_next_permutation__
96                                                              __range_algorithms_prev_permutation__]]
97    [[`<boost/range/algorithm/random_shuffle.hpp>`]          [__range_algorithms_random_shuffle__]]
98    [[`<boost/range/algorithm/remove.hpp>`]                  [__range_algorithms_remove__]]
99    [[`<boost/range/algorithm/remove_copy.hpp>`]             [__range_algorithms_remove_copy__]]
100    [[`<boost/range/algorithm/remove_copy_if.hpp>`]          [__range_algorithms_remove_copy_if__]]
101    [[`<boost/range/algorithm/remove_if.hpp>`]               [__range_algorithms_remove_if__]]
102    [[`<boost/range/algorithm/replace.hpp>`]                 [__range_algorithms_replace__]]
103    [[`<boost/range/algorithm/replace_copy.hpp>`]            [__range_algorithms_replace_copy__]]
104    [[`<boost/range/algorithm/replace_copy_if.hpp>`]         [__range_algorithms_replace_copy_if__]]
105    [[`<boost/range/algorithm/replace_if.hpp>`]              [__range_algorithms_replace_if__]]
106    [[`<boost/range/algorithm/reverse.hpp>`]                 [__range_algorithms_reverse__]]
107    [[`<boost/range/algorithm/reverse_copy.hpp>`]            [__range_algorithms_reverse_copy__]]
108    [[`<boost/range/algorithm/rotate.hpp>`]                  [__range_algorithms_rotate__]]
109    [[`<boost/range/algorithm/rotate_copy.hpp>`]             [__range_algorithms_rotate_copy__]]
110    [[`<boost/range/algorithm/search.hpp>`]                  [__range_algorithms_search__]]
111    [[`<boost/range/algorithm/search_n.hpp>`]                [__range_algorithms_search_n__]]
112    [[`<boost/range/algorithm/set_algorithm.hpp>`]           [__range_algorithms_includes__
113                                                              __range_algorithms_set_union__
114                                                              __range_algorithms_set_intersection__
115                                                              __range_algorithms_set_difference__
116                                                              __range_algorithms_set_symmetric_difference__]]
117    [[`<boost/range/algorithm/sort.hpp>`]                    [__range_algorithms_sort__]]
118    [[`<boost/range/algorithm/stable_partition.hpp>`]        [__range_algorithms_stable_partition__]]
119    [[`<boost/range/algorithm/swap_ranges.hpp>`]             [__range_algorithms_swap_ranges__]]
120    [[`<boost/range/algorithm/transform.hpp>`]               [__range_algorithms_transform__]]
121    [[`<boost/range/algorithm/unique.hpp>`]                  [__range_algorithms_unique__]]
122    [[`<boost/range/algorithm/unique_copy.hpp>`]             [__range_algorithms_unique_copy__]]
123    [[`<boost/range/algorithm/upper_bound.hpp>`]             [__range_algorithms_upper_bound__]]
124]
125[endsect]
126
127[section:algorithm_ext Algorithm Extensions]
128[table
129    [[Header                                        ][Includes                                           ]]
130    [[`<boost/range/algorithm_ext/copy_n.hpp>`]     [__range_algorithm_ext_copy_n__]]
131    [[`<boost/range/algorithm_ext/erase.hpp>`]      [__range_algorithm_ext_erase__]]
132    [[`<boost/range/algorithm_ext/for_each.hpp>`]   [__range_algorithm_ext_for_each__]]
133    [[`<boost/range/algorithm_ext/insert.hpp>`]     [__range_algorithm_ext_insert__]]
134    [[`<boost/range/algorithm_ext/iota.hpp>`]       [__range_algorithm_ext_iota__]]
135    [[`<boost/range/algorithm_ext/is_sorted.hpp>`]  [__range_algorithm_ext_is_sorted__]]
136    [[`<boost/range/algorithm_ext/overwrite.hpp>`]  [__range_algorithm_ext_overwrite__]]
137    [[`<boost/range/algorithm_ext/push_back.hpp>`]  [__range_algorithm_ext_push_back__]]
138    [[`<boost/range/algorithm_ext/push_front.hpp>`] [__range_algorithm_ext_push_front__]]
139]
140[endsect]
141
142[endsect]
143
144