diff options
Diffstat (limited to 'libs/range/doc')
295 files changed, 34090 insertions, 0 deletions
diff --git a/libs/range/doc/Jamfile.v2 b/libs/range/doc/Jamfile.v2 new file mode 100644 index 0000000000..82a8d7f11b --- /dev/null +++ b/libs/range/doc/Jamfile.v2 @@ -0,0 +1,30 @@ +#// Boost.Range library +#// +#// Copyright Thorsten Ottosen 2003-2008. Use, modification and +#// distribution is subject to 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) +#// +#// For more information, see http://www.boost.org/libs/range/ +#// + +project boost/libs/range/doc ; +using boostbook ; +using quickbook ; + +path-constant images_location : html ; + +boostbook quickbook + : + boost_range.qbk + : + <xsl:param>boost.root=../../../.. + <xsl:param>chunk.section.depth=4 + <xsl:param>chunk.first.sections=1 + <xsl:param>toc.section.depth=3 + <xsl:param>toc.max.depth=3 + <xsl:param>generate.section.toc.level=4 + <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html + <format>pdf:<xsl:param>img.src.path=$(images_location)/ + ; + diff --git a/libs/range/doc/boost_range.qbk b/libs/range/doc/boost_range.qbk new file mode 100644 index 0000000000..be09bc6a5b --- /dev/null +++ b/libs/range/doc/boost_range.qbk @@ -0,0 +1,197 @@ +[/============================================================================== + Copyright (C) 2003-2010 Thorsten Ottosen, Neil Groves + + Use, modification and distribution is subject to 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 +==============================================================================/] +[library Range + [quickbook 1.5] + [version 2.0] + [authors [Ottosen, Thorsten], [Groves, Neil]] + [copyright 2003-2010 Thorsten Ottosen, Neil Groves] + [purpose Half-open range library] + [license + 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]) + ] +] + +[/ Converted to Quickbook format by Darren Garvey, 2007] + +[def __note__ [$images/note.png]] +[def __alert__ [$images/alert.png]] +[def __tip__ [$images/tip.png]] +[def __caution__ [$images/caution.png]] + +[def __boost_range_home__ [link range Boost.Range]] +[def __ranges__ [link range.concepts Ranges]] +[def __range_concepts__ [link range.concepts Range concepts]] +[def __forward_range__ [link range.concepts.forward_range Forward Range]] +[def __single_pass_range__ [link range.concepts.single_pass_range Single Pass Range]] +[def __bidirectional_range__ [link range.concepts.bidirectional_range Bidirectional Range]] +[def __random_access_range__ [link range.concepts.random_access_range Random Access Range]] + +[def __iterator_range__ [link range.reference.utilities.iterator_range `iterator_range`]] +[def __sub_range__ [link range.reference.utilities.sub_range `sub_range`]] +[def __minimal_interface__ [link range.reference.extending minimal interface]] +[def __range_result_iterator__ [link range.reference.concept_implementation.semantics.metafunctions `range_result_iterator`]] +[def __extending_for_udts__ [link range.reference.extending Extending the library for UDTs]] +[def __implementation_of_metafunctions__ [link range.reference.concept_implementation.semantics.metafunctions Implementation of metafunctions]] +[def __implementation_of_functions__ [link range.reference.concept_implementation.semantics.functions Implementation of functions]] + +[def __range_value__ [link range.reference.concept_implementation.semantics.metafunctions `range_value`]] +[def __range_iterator__ [link range.reference.concept_implementation.semantics.metafunctions `range_iterator`]] +[def __range_difference__ [link range.reference.concept_implementation.semantics.metafunctions `range_difference`]] +[def __range_pointer__ [link range.reference.concept_implementation.semantics.metafunctions `range_pointer`]] +[def __range_category__ [link range.reference.concept_implementation.semantics.metafunctions `range_category`]] +[def __range_reverse_iterator__ [link range.reference.concept_implementation.semantics.metafunctions `range_reverse_iterator`]] +[def __begin__ [link range.reference.concept_implementation.semantics.functions `begin`]] +[def __const_begin__ [link range.reference.concept_implementation.semantics.functions `const_begin`]] +[def __end__ [link range.reference.concept_implementation.semantics.functions `end`]] +[def __const_end__ [link range.reference.concept_implementation.semantics.functions `const_end`]] +[def __empty__ [link range.reference.concept_implementation.semantics.functions `empty`]] +[def __distance__ [link range.reference.concept_implementation.semantics.functions `distance`]] +[def __size__ [link range.reference.concept_implementation.semantics.functions `size`]] +[def __rbegin__ [link range.reference.concept_implementation.semantics.functions `rbegin`]] +[def __const_rbegin__ [link range.reference.concept_implementation.semantics.functions `const_rbegin`]] +[def __rend__ [link range.reference.concept_implementation.semantics.functions `rend`]] +[def __const_rend__ [link range.reference.concept_implementation.semantics.functions `const_rend`]] +[def __as_array__ [link range.reference.concept_implementation.semantics.functions `as_array`]] +[def __as_literal__ [link range.reference.concept_implementation.semantics.functions `as_literal`]] +[def __counting_range__ [link range.reference.ranges.counting_range `counting_range`]] +[def __irange__ [link range.reference.ranges.irange `irange`]] +[def __istream_range__ [link range.reference.ranges.istream_range `istream_range`]] +[def __join__ [link range.reference.utilities.join `join`]] + +[def __range_adaptors__ [link range.reference.adaptors Range adaptors]] +[def __range_adaptors_adjacent_filtered__ [link range.reference.adaptors.reference.adjacent_filtered adjacent_filtered]] +[def __range_adaptors_copied__ [link range.reference.adaptors.reference.copied copied]] +[def __range_adaptors_filtered__ [link range.reference.adaptors.reference.filtered filtered]] +[def __range_adaptors_indexed__ [link range.reference.adaptors.reference.indexed indexed]] +[def __range_adaptors_indirected__ [link range.reference.adaptors.reference.indirected indirected]] +[def __range_adaptors_map_keys__ [link range.reference.adaptors.reference.map_keys map_keys]] +[def __range_adaptors_map_values__ [link range.reference.adaptors.reference.map_values map_values]] +[def __range_adaptors_replaced__ [link range.reference.adaptors.reference.replaced replaced]] +[def __range_adaptors_replaced_if__ [link range.reference.adaptors.reference.replaced_if replaced_if]] +[def __range_adaptors_reversed__ [link range.reference.adaptors.reference.reversed reversed]] +[def __range_adaptors_sliced__ [link range.reference.adaptors.reference.sliced sliced]] +[def __range_adaptors_strided__ [link range.reference.adaptors.reference.strided strided]] +[def __range_adaptors_type_erased__ [link range.reference.adaptors.reference.type_erased type_erased]] +[def __range_adaptors_tokenized__ [link range.reference.adaptors.reference.tokenized tokenized]] +[def __range_adaptors_transformed__ [link range.reference.adaptors.reference.transformed transformed]] +[def __range_adaptors_uniqued__ [link range.reference.adaptors.reference.uniqued uniqued]] + + +[def __range_algorithms__ [link range.reference.algorithms Range algorithms]] +[def __range_algorithms_adjacent_find__ [link range.reference.algorithms.non_mutating.adjacent_find adjacent_find]] +[def __range_algorithms_binary_search__ [link range.reference.algorithms.non_mutating.binary_search binary_search]] +[def __range_algorithms_count__ [link range.reference.algorithms.non_mutating.count count]] +[def __range_algorithms_count_if__ [link range.reference.algorithms.non_mutating.count_if count_if]] +[def __range_algorithms_equal__ [link range.reference.algorithms.non_mutating.equal equal]] +[def __range_algorithms_equal_range__ [link range.reference.algorithms.non_mutating.equal_range equal_range]] +[def __range_algorithms_for_each__ [link range.reference.algorithms.non_mutating.for_each for_each]] +[def __range_algorithms_find__ [link range.reference.algorithms.non_mutating.find find]] +[def __range_algorithms_find_end__ [link range.reference.algorithms.non_mutating.find_end find_end]] +[def __range_algorithms_find_first_of__ [link range.reference.algorithms.non_mutating.find_first_of find_first_of]] +[def __range_algorithms_find_if__ [link range.reference.algorithms.non_mutating.find_if find_if]] +[def __range_algorithms_lexicographical_compare__ [link range.reference.algorithms.non_mutating.lexicographical_compare lexicographical_compare]] +[def __range_algorithms_lower_bound__ [link range.reference.algorithms.non_mutating.lower_bound lower_bound]] +[def __range_algorithms_max_element__ [link range.reference.algorithms.non_mutating.max_element max_element]] +[def __range_algorithms_min_element__ [link range.reference.algorithms.non_mutating.min_element min_element]] +[def __range_algorithms_mismatch__ [link range.reference.algorithms.non_mutating.mismatch mismatch]] +[def __range_algorithms_search__ [link range.reference.algorithms.non_mutating.search search]] +[def __range_algorithms_search_n__ [link range.reference.algorithms.non_mutating.search_n search_n]] +[def __range_algorithms_upper_bound__ [link range.reference.algorithms.non_mutating.upper_bound upper_bound]] + +[def __range_algorithms_copy__ [link range.reference.algorithms.mutating.copy copy]] +[def __range_algorithms_copy_backward__ [link range.reference.algorithms.mutating.copy_backward copy_backward]] +[def __range_algorithms_fill__ [link range.reference.algorithms.mutating.fill fill]] +[def __range_algorithms_fill_n__ [link range.reference.algorithms.mutating.fill_n fill_n]] +[def __range_algorithms_generate__ [link range.reference.algorithms.mutating.generate generate]] +[def __range_algorithms_inplace_merge__ [link range.reference.algorithms.mutating.inplace_merge inplace_merge]] +[def __range_algorithms_merge__ [link range.reference.algorithms.mutating.merge merge]] +[def __range_algorithms_nth_element__ [link range.reference.algorithms.mutating.nth_element nth_element]] +[def __range_algorithms_partial_sort__ [link range.reference.algorithms.mutating.partial_sort partial_sort]] +[def __range_algorithms_partition__ [link range.reference.algorithms.mutating.partition partition]] +[def __range_algorithms_random_shuffle__ [link range.reference.algorithms.mutating.random_shuffle random_shuffle]] +[def __range_algorithms_remove__ [link range.reference.algorithms.mutating.remove remove]] +[def __range_algorithms_remove_copy__ [link range.reference.algorithms.mutating.remove_copy remove_copy]] +[def __range_algorithms_remove_copy_if__ [link range.reference.algorithms.mutating.remove_copy_if remove_copy_if]] +[def __range_algorithms_remove_if__ [link range.reference.algorithms.mutating.remove_if remove_if]] +[def __range_algorithms_replace__ [link range.reference.algorithms.mutating.replace replace]] +[def __range_algorithms_replace_copy__ [link range.reference.algorithms.mutating.replace_copy replace_copy]] +[def __range_algorithms_replace_copy_if__ [link range.reference.algorithms.mutating.replace_copy_if replace_copy_if]] +[def __range_algorithms_replace_if__ [link range.reference.algorithms.mutating.replace_if replace_if]] +[def __range_algorithms_reverse__ [link range.reference.algorithms.mutating.reverse reverse]] +[def __range_algorithms_reverse_copy__ [link range.reference.algorithms.mutating.reverse_copy reverse_copy]] +[def __range_algorithms_rotate__ [link range.reference.algorithms.mutating.rotate rotate]] +[def __range_algorithms_rotate_copy__ [link range.reference.algorithms.mutating.rotate_copy rotate_copy]] +[def __range_algorithms_sort__ [link range.reference.algorithms.mutating.sort sort]] +[def __range_algorithms_stable_partition__ [link range.reference.algorithms.mutating.stable_partition stable_partition]] +[def __range_algorithms_stable_sort__ [link range.reference.algorithms.mutating.stable_sort stable_sort]] +[def __range_algorithms_swap_ranges__ [link range.reference.algorithms.mutating.swap_ranges swap_ranges]] +[def __range_algorithms_transform__ [link range.reference.algorithms.mutating.transform transform]] +[def __range_algorithms_unique__ [link range.reference.algorithms.mutating.unique unique]] +[def __range_algorithms_unique_copy__ [link range.reference.algorithms.mutating.unique_copy unique_copy]] + +[def __range_algorithms_includes__ [link range.reference.algorithms.set.includes includes]] +[def __range_algorithms_set_union__ [link range.reference.algorithms.set.set_union set_union]] +[def __range_algorithms_set_intersection__ [link range.reference.algorithms.set.set_intersection set_intersection]] +[def __range_algorithms_set_difference__ [link range.reference.algorithms.set.set_difference set_difference]] +[def __range_algorithms_set_symmetric_difference__ [link range.reference.algorithms.set.set_symmetric_difference set_symmetric_difference]] + +[def __range_algorithms_push_heap__ [link range.reference.algorithms.heap.push_heap push_heap]] +[def __range_algorithms_pop_heap__ [link range.reference.algorithms.heap.pop_heap pop_heap]] +[def __range_algorithms_make_heap__ [link range.reference.algorithms.heap.make_heap make_heap]] +[def __range_algorithms_sort_heap__ [link range.reference.algorithms.heap.sort_heap sort_heap]] + +[def __range_algorithms_next_permutation__ [link range.reference.algorithms.permutation.next_permutation next_permutation]] +[def __range_algorithms_prev_permutation__ [link range.reference.algorithms.permutation.prev_permutation prev_permutation]] + +[def __range_algorithm_ext_copy_n__ [link range.reference.algorithms.new.copy_n copy_n]] +[def __range_algorithm_ext_erase__ [link range.reference.algorithms.new.erase erase]] +[def __range_algorithm_ext_for_each__ [link range.reference.algorithms.new.for_each for_each]] +[def __range_algorithm_ext_insert__ [link range.reference.algorithms.new.insert insert]] +[def __range_algorithm_ext_iota__ [link range.reference.algorithms.new.iota iota]] +[def __range_algorithm_ext_is_sorted__ [link range.reference.algorithms.new.is_sorted is_sorted]] +[def __range_algorithm_ext_overwrite__ [link range.reference.algorithms.new.overwrite overwrite]] +[def __range_algorithm_ext_push_back__ [link range.reference.algorithms.new.push_back push_back]] +[def __range_algorithm_ext_push_front__ [link range.reference.algorithms.new.push_front push_front]] + +[def __single_pass_iterator__ [@boost:/libs/iterator/doc/new-iter-concepts.html#singls-pass-iterators-lib-single-pass-iterators Single Pass Iterator]] +[def __forward_traversal_iterator__ [@boost:/libs/iterator/doc/new-iter-concepts.html#forward-traversal-iterators-lib-forward-traversal-iterators Forward Traversal Iterator]] +[def __bidirectional_traversal_iterator__ [@boost:/libs/iterator/doc/new-iter-concepts.html#bidirectional-traversal-iterators-lib-bidirectional-traversal-iterators Bidirectional Traversal Iterator]] +[def __random_access_traversal_iterator__ [@boost:/libs/iterator/doc/new-iter-concepts.html#random-access-traversal-iterators-lib-random-access-traversal-iterators Random Access Traversal Iterator]] +[def __new_style_iterators__ [@boost:/libs/iterator/doc/new-iter-concepts.html new style iterators]] +[def __iterator_concepts__ [@boost:/libs/iterator/doc/iterator_concepts.html Iterator concepts]] + +[def __container__ [@http://www.sgi.com/Technology/STL/Container.html Container]] +[def __metafunctions__ [@boost:/libs/mpl/doc/refmanual/metafunction.html metafunctions]] +[def __concept_check__ [@boost:/libs/concept_check/index.html Boost Concept Check library]] +[def __boost_array__ [@boost:/libs/array/index.html boost::array]] +[def __the_forwarding_problem__ [@http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2002/n1385.htm The Forwarding Problem]] + +[def __sgi_inner_product__ [@http://www.sgi.com/tech/stl/inner_product.html inner_product]] +[def __sgi_partial_sum__ [@http://www.sgi.com/tech/stl/partial_sum.html partial_sum]] +[def __type_erasure_article__ [@http://www.artima.com/cppsource/type_erasure.html type erasure article]] + +Boost.Range is a collection of concepts and utilities, range-based algorithms, +as well as range adaptors that allow for efficient and expressive code. + +Using Boost.Range inplace of the standard library alternatives results in more +readable code and in many cases greater efficiency. + +[include introduction.qbk] +[include concepts.qbk] +[include reference.qbk] +[include style.qbk] +[include headers.qbk] +[include examples.qbk] +[include mfc_atl.qbk] +[include upgrade.qbk] +[include portability.qbk] +[include faq.qbk] +[include history_ack.qbk] + diff --git a/libs/range/doc/concepts.qbk b/libs/range/doc/concepts.qbk new file mode 100644 index 0000000000..f379e18fba --- /dev/null +++ b/libs/range/doc/concepts.qbk @@ -0,0 +1,255 @@ +[/ + 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:concepts Range Concepts] + +[section Overview] + +A Range is a [*/concept/] similar to the STL [@http://www.sgi.com/Technology/STL/Container.html Container] concept. A Range provides iterators for accessing a half-open range `[first,one_past_last)` of elements and provides information about the number of elements in the Range. However, a Range has fewer requirements than a Container. + +The motivation for the Range concept is that there are many useful Container-like types that do not meet the full requirements of Container, and many algorithms that can be written with this reduced set of requirements. In particular, a Range does not necessarily + +* own the elements that can be accessed through it, +* have copy semantics, + +Because of the second requirement, a Range object must be passed by (const or non-const) reference in generic code. + +The operations that can be performed on a Range is dependent on the [@boost:/libs/iterator/doc/new-iter-concepts.html#iterator-traversal-concepts-lib-iterator-traversal traversal category] of the underlying iterator type. Therefore the range concepts are named to reflect which traversal category its iterators support. See also terminology and style guidelines. for more information about naming of ranges. + +The concepts described below specifies associated types as [@boost:/libs/mpl/doc/refmanual/metafunction.html metafunctions] and all functions as free-standing functions to allow for a layer of indirection. + +[endsect] + + +[section Single Pass Range] + +[heading Notation] + +[table + [] + [[`X`] [A type that is a model of __single_pass_range__.]] + [[`a`] [Object of type X.]] +] + +[heading Description] + +A range `X` where `boost::range_iterator<X>::type` is a model of __single_pass_iterator__. + +[heading Associated types] + +[table + [] + [[Iterator type ] [`boost::range_iterator<X>::type` ] [The type of iterator used to iterate through a Range's elements. The iterator's value type is expected to be the Range's value type. A conversion from the iterator type to the `const` iterator type must exist.]] + [[Const iterator type] [`boost::range_iterator<const X>::type`] [A type of iterator that may be used to examine, but not to modify, a Range's elements.]] +] + +[heading Valid expressions] + +The following expressions must be valid. + +[table + [[Name ] [Expression ] [Return type ]] + [[Beginning of range] [`boost::begin(a)`] [`boost::range_iterator<X>::type` if `a` is mutable, `boost::range_iterator<const X>::type` otherwise]] + [[End of range ] [`boost::end(a)` ] [`boost::range_iterator<X>::type` if `a` is mutable, `boost::range_iterator<const X>::type` otherwise]] +] + +[heading Expression semantics] + +[table + [[Expression ] [Semantics ] [Postcondition]] + [[`boost::begin(a)`] [Returns an iterator pointing to the first element in the Range. ] [`boost::begin(a)` is either dereferenceable or past-the-end. It is past-the-end if and only if `boost::distance(a) == 0`.]] + [[`boost::end(a)` ] [Returns an iterator pointing one past the last element in the Range. ] [`boost::end(a)` is past-the-end.]] +] + +[heading Complexity guarantees] + +`boost::end(a)` is at most amortized linear time, `boost::begin(a)` is amortized constant time. For most practical purposes, one can expect both to be amortized constant time. + +[heading Invariants] + +[table + [] + [[Valid range ] [For any Range `a`, `[boost::begin(a),boost::end(a))` is a valid range, that is, `boost::end(a)` is reachable from `boost::begin(a)` in a finite number of increments.]] + + [[Completeness] [An algorithm that iterates through the range `[boost::begin(a),boost::end(a))` will pass through every element of `a`.]] +] + +[heading See also] + +__extending_for_udts__ + +__implementation_of_metafunctions__ + +__implementation_of_functions__ + +__container__ + +[endsect] + + +[section Forward Range] + +[heading Notation] + +[table + [] + [[`X`] [A type that is a model of __forward_range__.]] + [[`a`] [Object of type X.]] +] + +[heading Description] + +A range `X` where `boost::range_iterator<X>::type` is a model of __forward_traversal_iterator__. + +[heading Refinement of] + +__single_pass_range__ + +[heading Associated types] + +[table + [] + [[Distance type] [`boost::range_difference<X>::type`] [A signed integral type used to represent the distance between two of the Range's iterators. This type must be the same as the iterator's distance type.]] + [[Size type ] [`boost::range_size<X>::type` ] [An unsigned integral type that can represent any nonnegative value of the Range's distance type.]] +] + +[heading See also] + +__implementation_of_metafunctions__ + +__implementation_of_functions__ + +[endsect] + + +[section Bidirectional Range] + +[heading Notation] + +[table + [] + [[`X`] [A type that is a model of __bidirectional_range__.]] + [[`a`] [Object of type X.]] +] + +[heading Description] + +This concept provides access to iterators that traverse in both directions (forward and reverse). The `boost::range_iterator<X>::type` iterator must meet all of the requirements of __bidirectional_traversal_iterator__. + +[heading Refinement of] + +__forward_range__ + +[heading Associated types] + +[table + [] + [[Reverse Iterator type ] [`boost::range_reverse_iterator<X>::type` ] [The type of iterator used to iterate through a Range's elements in reverse order. The iterator's value type is expected to be the Range's value type. A conversion from the reverse iterator type to the const reverse iterator type must exist.]] + + [[Const reverse iterator type] [`boost::range_reverse_iterator<const X>::type`] [A type of reverse iterator that may be used to examine, but not to modify, a Range's elements.]] +] + +[heading Valid expressions] + +[table + [[Name ] [Expression ] [Return type] [Semantics]] + [[Beginning of range] [`boost::rbegin(a)`] [`boost::range_reverse_iterator<X>::type` if `a` is mutable `boost::range_reverse_iterator<const X>::type` otherwise.] [Equivalent to `boost::range_reverse_iterator<X>::type(boost::end(a))`.]] + + [[End of range ] [`boost::rend(a)` ] [`boost::range_reverse_iterator<X>::type` if `a` is mutable, `boost::range_reverse_iterator<const X>::type` otherwise.] [Equivalent to `boost::range_reverse_iterator<X>::type(boost::begin(a))`.]] +] + +[heading Complexity guarantees] + +`boost::rbegin(a)` has the same complexity as `boost::end(a)` and `boost::rend(a)` has the same complexity as `boost::begin(a)` from __forward_range__. + +[heading Invariants] + +[table + [] + [[Valid reverse range] [For any Bidirectional Range a, `[boost::rbegin(a),boost::rend(a))` is a valid range, that is, `boost::rend(a)` is reachable from `boost::rbegin(a)` in a finite number of increments.]] + + [[Completeness ] [An algorithm that iterates through the range `[boost::rbegin(a),boost::rend(a))` will pass through every element of `a`.]] +] + +[heading See also] + +__implementation_of_metafunctions__ + +__implementation_of_functions__ + +[endsect] + + +[section Random Access Range] + +[heading Description] + +A range `X` where `boost::range_iterator<X>::type` is a model of __random_access_traversal_iterator__. + +[heading Refinement of] + +__bidirectional_range__ + +[heading Valid expressions] + +[table + [[Name ] [Expression ] [Return type ]] + [[Size of range] [`boost::size(a)`] [`boost::range_size<X>::type`]] +] + +[heading Expression semantics] + +[table + [[Expression ] [Semantics] [Postcondition]] + [[`boost::size(a)`] [Returns the size of the Range, that is, its number of elements. Note `boost::size(a) == 0u` is equivalent to `boost::empty(a)`.] [`boost::size(a) >= 0`]] +] + +[heading Complexity guarantees] + +`boost::size(a)` completes in amortized constant time. + +[heading Invariants] + +[table + [] + [[Range size] [`boost::size(a)` is equal to the `boost::end(a)` - `boost::begin(a)`.]] +] + +[endsect] + + +[section Concept Checking] + +Each of the range concepts has a corresponding concept checking class in the file [@boost:/boost/range/concepts.hpp `<boost/range/concepts.hpp>`]. These classes may be used in conjunction with the __concept_check__ to ensure that the type of a template parameter is compatible with a range concept. If not, a meaningful compile time error is generated. Checks are provided for the range concepts related to iterator traversal categories. For example, the following line checks that the type `T` models the __forward_range__ concept. + +`` +BOOST_CONCEPT_ASSERT(( ForwardRangeConcept<T> )); +`` + +An additional concept check is required for the value access property of the range based on the range's iterator type. For example to check for a ForwardReadableRange, the following code is required. + +`` +BOOST_CONCEPT_ASSERT(( ForwardRangeConcept<T> )); +BOOST_CONCEPT_ASSERT(( ReadableIteratorConcept<typename range_iterator<T>::type> )); +`` + +The following range concept checking classes are provided. + +* Class SinglePassRangeConcept checks for __single_pass_range__ +* Class ForwardRangeConcept checks for __forward_range__ +* Class BidirectionalRangeConcept checks for __bidirectional_range__ +* Class RandomAccessRangeConcept checks for __random_access_range__ + +[heading See also] + +[link range.style_guide Range Terminology and style guidelines] + +__iterator_concepts__ + +__concept_check__ + +[endsect] +[endsect] + diff --git a/libs/range/doc/example.cpp b/libs/range/doc/example.cpp new file mode 100644 index 0000000000..d3dec7cb00 --- /dev/null +++ b/libs/range/doc/example.cpp @@ -0,0 +1,151 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2008. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// + +#include <boost/range.hpp> +#include <iterator> // for std::iterator_traits, std::distance() + +namespace Foo +{ + // + // Our sample UDT. A 'Pair' + // will work as a range when the stored + // elements are iterators. + // + template< class T > + struct Pair + { + T first, last; + }; + +} // namespace 'Foo' + +namespace boost +{ + // + // Specialize metafunctions. We must include the range.hpp header. + // We must open the 'boost' namespace. + // + /* + template< class T > + struct range_value< Foo::Pair<T> > + { + typedef typename std::iterator_traits<T>::value_type type; + }; + */ + + template< class T > + struct range_iterator< Foo::Pair<T> > + { + typedef T type; + }; + + template< class T > + struct range_const_iterator< Foo::Pair<T> > + { + // + // Remark: this is defined similar to 'range_iterator' + // because the 'Pair' type does not distinguish + // between an iterator and a const_iterator. + // + typedef T type; + }; + + /* + template< class T > + struct range_difference< Foo::Pair<T> > + { + typedef typename std::iterator_traits<T>::difference_type type; + }; + */ + + template< class T > + struct range_size< Foo::Pair<T> > + { + int static_assertion[ sizeof( std::size_t ) >= + sizeof( typename range_difference< Foo::Pair<T> >::type ) ]; + typedef std::size_t type; + }; + +} // namespace 'boost' + +namespace Foo +{ + // + // The required functions. These should be defined in + // the same namespace as 'Pair', in this case + // in namespace 'Foo'. + // + + template< class T > + inline T boost_range_begin( Pair<T>& x ) + { + return x.first; + } + + template< class T > + inline T boost_range_begin( const Pair<T>& x ) + { + return x.first; + } + + template< class T > + inline T boost_range_end( Pair<T>& x ) + { + return x.last; + } + + template< class T > + inline T boost_range_end( const Pair<T>& x ) + { + return x.last; + } + + template< class T > + inline typename boost::range_size< Pair<T> >::type + boost_range_size( const Pair<T>& x ) + { + return std::distance(x.first,x.last); + } + +} // namespace 'Foo' + +#include <vector> + +int main() +{ + typedef std::vector<int>::iterator iter; + std::vector<int> vec; + vec.push_back( 42 ); + Foo::Pair<iter> pair = { vec.begin(), vec.end() }; + const Foo::Pair<iter>& cpair = pair; + // + // Notice that we call 'begin' etc with qualification. + // + iter i = boost::begin( pair ); + iter e = boost::end( pair ); + i = boost::begin( cpair ); + e = boost::end( cpair ); + boost::range_size< Foo::Pair<iter> >::type s = boost::size( pair ); + s = boost::size( cpair ); + boost::range_const_reverse_iterator< Foo::Pair<iter> >::type + ri = boost::rbegin( cpair ), + re = boost::rend( cpair ); + + // + // Test metafunctions + // + + boost::range_value< Foo::Pair<iter> >::type + v = *boost::begin(pair); + + boost::range_difference< Foo::Pair<iter> >::type + d = boost::end(pair) - boost::begin(pair); +} + diff --git a/libs/range/doc/examples.qbk b/libs/range/doc/examples.qbk new file mode 100644 index 0000000000..1dfb924216 --- /dev/null +++ b/libs/range/doc/examples.qbk @@ -0,0 +1,28 @@ +[/ + 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:examples Examples] + +Some examples are given in the accompanying test files: + +* [@http://www.boost.org/libs/range/test/string.cpp string.cpp] shows how to implement a container version of `std::find()` that works with `char[]`,`wchar_t[]`,`char*`,`wchar_t*`. + +* [@http://www.boost.org/libs/range/test/algorithm_example.cpp algorithm_example.cpp] shows the replace example from the introduction. + +* [@http://www.boost.org/libs/range/test/iterator_range.cpp iterator_range.cpp] + +* [@http://www.boost.org/libs/range/test/sub_range.cpp sub_range.cpp] + +* [@http://www.boost.org/libs/range/test/iterator_pair.cpp iterator_pair.cpp] + +* [@http://www.boost.org/libs/range/test/reversible_range.cpp reversible_range.cpp] + +* [@http://www.boost.org/libs/range/test/std_container.cpp std_container.cpp] + +* [@http://www.boost.org/libs/range/test/array.cpp array.cpp] + +[endsect] + + diff --git a/libs/range/doc/faq.qbk b/libs/range/doc/faq.qbk new file mode 100644 index 0000000000..ada6361597 --- /dev/null +++ b/libs/range/doc/faq.qbk @@ -0,0 +1,30 @@ +[/ + 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:faq FAQ] + +1. ['[*Why is there no difference between `range_iterator<C>::type` and `range_const_iterator<C>::type` for `std::pair<iterator, iterator>`?]] + +[:In general it is not possible nor desirable to find a corresponding `const_iterator`. When it is possible to come up with one, the client might choose to construct a `std::pair<const_iterator,const_iterator>` object.] + +[:Note that an __iterator_range__ is somewhat more convenient than a `pair` and that a __sub_range__ does propagate const-ness.] + +2. ['[*Why is there not supplied more types or more functions?]] + +[:The library has been kept small because its current interface will serve most purposes. If and when a genuine need arises for more functionality, it can be implemented.] + +3. ['[*How should I implement generic algorithms for ranges?]] + +[:One should always start with a generic algorithm that takes two iterators (or more) as input. Then use Boost.Range to build handier versions on top of the iterator based algorithm. Please notice that once the range version of the algorithm is done, it makes sense not to expose the iterator version in the public interface.] + +4. ['[*Why is there no Incrementable Range concept?]] + +[:Even though we speak of incrementable iterators, it would not make much sense for ranges; for example, we cannot determine the size and emptiness of a range since we cannot even compare its iterators.] + +[:Note also that incrementable iterators are derived from output iterators and so there exist no output range.] + +[endsect] + + diff --git a/libs/range/doc/headers.qbk b/libs/range/doc/headers.qbk new file mode 100644 index 0000000000..0012c6a7bd --- /dev/null +++ b/libs/range/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 metafunctinos, 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] + diff --git a/libs/range/doc/history_ack.qbk b/libs/range/doc/history_ack.qbk new file mode 100644 index 0000000000..f8c39e432c --- /dev/null +++ b/libs/range/doc/history_ack.qbk @@ -0,0 +1,58 @@ +[/ + 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:history_ack History and Acknowledgement] + +[heading Version 1 - before Boost 1.43] +The library have been under way for a long time. Dietmar Kühl originally intended to submit an `array_traits` class template which had most of the functionality present now, but only for arrays and standard containers. + +Meanwhile work on algorithms for containers in various contexts showed the need for handling pairs of iterators, and string libraries needed special treatment of character arrays. In the end it made sense to formalize the minimal requirements of these similar concepts. And the results are the Range concepts found in this library. + +The term Range was adopted because of paragraph 24.1/7 from the C++ standard: + +Most of the library's algorithmic templates that operate on data structures have interfaces that use ranges. A range is a pair of iterators that designate the beginning and end of the computation. A range [i, i) is an empty range; in general, a range [i, j) refers to the elements in the data structure starting with the one pointed to by i and up to but not including the one pointed to by j. Range [i, j) is valid if and only if j is reachable from i. The result of the application of functions in the library to invalid ranges is undefined. + +Special thanks goes to + +* Pavol Droba for help with documentation and implementation +* Pavel Vozenilek for help with porting the library +* Jonathan Turkanis and John Torjo for help with documentation +* Hartmut Kaiser for being review manager +* Jonathan Turkanis for porting the lib (as far sa possible) to vc6 and vc7. + +The concept checks and their documentation was provided by Daniel Walker. + +[heading Version 2 - Boost 1.43 and beyond] +This version introduced Range Adaptors and Range Algorithms. This version 2 is +the result of a merge of all of the RangeEx features into Boost.Range. + +There were an enormous number of very significant contributors through all +stages of this library. + +Prior to Boost.RangeEx there had been a number of Range library implementations, +these include library implementations by Eric Niebler, Adobe, +Shunsuke Sogame etc. Eric Niebler contributed the Range Adaptor idea which is +arguably the single biggest innovation in this library. Inevitably a great deal +of commonality evolved in each of these libraries, but a considerable amount +of effort was expended to learn from all of the divergent techniques. + +The people in the following list all made contributions in the form of reviews, +user feedback, design suggestions, or defect detection: + +* Thorsten Ottosen: review management, design advice, documentation feedback +* Eric Niebler: early implementation, and review feedback +* Joel de Guzman: review +* Mathias Gaunard: review +* David Abrahams: implementation advice +* Robert Jones: defect reports, usage feedback +* Sean Parent: contributed experience from the Adobe range library +* Arno Schoedl: implementations, and review +* Rogier van Dalen: review +* Vincente Botet: review, documentation feedback + +Regardless of how I write this section it will never truly fairly capture the +gratitude that I feel to all who have contributed. Thank you everyone. + +[endsect] diff --git a/libs/range/doc/html/index.html b/libs/range/doc/html/index.html new file mode 100644 index 0000000000..1be23d5682 --- /dev/null +++ b/libs/range/doc/html/index.html @@ -0,0 +1,153 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Chapter 1. Range 2.0</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Chapter 1. Range 2.0"> +<link rel="next" href="range/introduction.html" title="Introduction"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"><a accesskey="n" href="range/introduction.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div> +<div class="chapter"> +<div class="titlepage"><div> +<div><h2 class="title"> +<a name="range"></a>Chapter 1. Range 2.0</h2></div> +<div><div class="author"><h3 class="author"> +<span class="firstname">Thorsten</span> <span class="surname">Ottosen</span> +</h3></div></div> +<div><div class="author"><h3 class="author"> +<span class="firstname">Neil</span> <span class="surname">Groves</span> +</h3></div></div> +<div><p class="copyright">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves</p></div> +<div><div class="legalnotice"> +<a name="id607962"></a><p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></div> +</div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="range/introduction.html">Introduction</a></span></dt> +<dt><span class="section"><a href="range/concepts.html">Range Concepts</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/concepts/overview.html">Overview</a></span></dt> +<dt><span class="section"><a href="range/concepts/single_pass_range.html">Single Pass Range</a></span></dt> +<dt><span class="section"><a href="range/concepts/forward_range.html">Forward Range</a></span></dt> +<dt><span class="section"><a href="range/concepts/bidirectional_range.html">Bidirectional Range</a></span></dt> +<dt><span class="section"><a href="range/concepts/random_access_range.html">Random Access Range</a></span></dt> +<dt><span class="section"><a href="range/concepts/concept_checking.html">Concept Checking</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/reference.html">Reference</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/overview.html">Overview</a></span></dt> +<dt><span class="section"><a href="range/reference/concept_implementation.html">Range concept + implementation</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/concept_implementation/synopsis.html">Synopsis</a></span></dt> +<dt><span class="section"><a href="range/reference/concept_implementation/semantics.html">Semantics</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/reference/adaptors.html">Range Adaptors</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/adaptors/introduction.html">Introduction + and motivation</a></span></dt> +<dt><span class="section"><a href="range/reference/adaptors/general_requirements.html">General + Requirements</a></span></dt> +<dt><span class="section"><a href="range/reference/adaptors/reference.html">Reference</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/reference/algorithms.html">Range Algorithms</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/algorithms/introduction.html">Introduction + and motivation</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/mutating.html">Mutating algorithms</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/non_mutating.html">Non-mutating + algorithms</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/set.html">Set algorithms</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/heap.html">Heap algorithms</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/permutation.html">Permutation + algorithms</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/new.html">New algorithms</a></span></dt> +<dt><span class="section"><a href="range/reference/algorithms/numeric.html">Numeric algorithms</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/reference/ranges.html">Provided Ranges</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/ranges/any_range.html">any_range</a></span></dt> +<dt><span class="section"><a href="range/reference/ranges/counting_range.html">counting_range</a></span></dt> +<dt><span class="section"><a href="range/reference/ranges/istream_range.html">istream_range</a></span></dt> +<dt><span class="section"><a href="range/reference/ranges/irange.html">irange</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/reference/utilities.html">Utilities</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/utilities/iterator_range.html">Class <code class="computeroutput"><span class="identifier">iterator_range</span></code></a></span></dt> +<dt><span class="section"><a href="range/reference/utilities/sub_range.html">Class <code class="computeroutput"><span class="identifier">sub_range</span></code></a></span></dt> +<dt><span class="section"><a href="range/reference/utilities/join.html">Function join</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/reference/extending.html">Extending the library</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/reference/extending/method_1.html">Method 1: provide + member functions and nested types</a></span></dt> +<dt><span class="section"><a href="range/reference/extending/method_2.html">Method 2: provide + free-standing functions and specialize metafunctions</a></span></dt> +<dt><span class="section"><a href="range/reference/extending/method_3.html">Method 3: provide + range adaptor implementations</a></span></dt> +</dl></dd> +</dl></dd> +<dt><span class="section"><a href="range/style_guide.html">Terminology and style guidelines</a></span></dt> +<dt><span class="section"><a href="range/headers.html">Library Headers</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/headers/general.html">General</a></span></dt> +<dt><span class="section"><a href="range/headers/adaptors.html">Adaptors</a></span></dt> +<dt><span class="section"><a href="range/headers/algorithm.html">Algorithm</a></span></dt> +<dt><span class="section"><a href="range/headers/algorithm_ext.html">Algorithm Extensions</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/examples.html">Examples</a></span></dt> +<dt><span class="section"><a href="range/mfc_atl.html">MFC/ATL (courtesy of Shunsuke Sogame)</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/mfc_atl/requirements.html">Requirements</a></span></dt> +<dt><span class="section"><a href="range/mfc_atl/mfc_ranges.html">MFC Ranges</a></span></dt> +<dt><span class="section"><a href="range/mfc_atl/atl_ranges.html">ATL Ranges</a></span></dt> +<dt><span class="section"><a href="range/mfc_atl/const_ranges.html">const Ranges</a></span></dt> +<dt><span class="section"><a href="range/mfc_atl/references.html">References</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/upgrade.html">Upgrade version of Boost.Range</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="range/upgrade/upgrade_from_1_45.html">Upgrade from version + 1.45</a></span></dt> +<dt><span class="section"><a href="range/upgrade/upgrade_from_1_42.html">Upgrade from version + 1.42</a></span></dt> +<dt><span class="section"><a href="range/upgrade/upgrade_from_1_34.html">Upgrade from version + 1.34</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="range/portability.html">Portability</a></span></dt> +<dt><span class="section"><a href="range/faq.html">FAQ</a></span></dt> +<dt><span class="section"><a href="range/history_ack.html">History and Acknowledgement</a></span></dt> +</dl> +</div> +<p> + Boost.Range is a collection of concepts and utilities, range-based algorithms, + as well as range adaptors that allow for efficient and expressive code. + </p> +<p> + Using Boost.Range inplace of the standard library alternatives results in more + readable code and in many cases greater efficiency. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"><p><small>Last revised: January 01, 2011 at 16:31:27 GMT</small></p></td> +<td align="right"><div class="copyright-footer"></div></td> +</tr></table> +<hr> +<div class="spirit-nav"><a accesskey="n" href="range/introduction.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div> +</body> +</html> diff --git a/libs/range/doc/html/quickbook_HTML.manifest b/libs/range/doc/html/quickbook_HTML.manifest new file mode 100644 index 0000000000..1b32f72e81 --- /dev/null +++ b/libs/range/doc/html/quickbook_HTML.manifest @@ -0,0 +1,155 @@ +index.html +range/introduction.html +range/concepts.html +range/concepts/overview.html +range/concepts/single_pass_range.html +range/concepts/forward_range.html +range/concepts/bidirectional_range.html +range/concepts/random_access_range.html +range/concepts/concept_checking.html +range/reference.html +range/reference/overview.html +range/reference/concept_implementation.html +range/reference/concept_implementation/synopsis.html +range/reference/concept_implementation/semantics.html +range/reference/concept_implementation/semantics/metafunctions.html +range/reference/concept_implementation/semantics/functions.html +range/reference/adaptors.html +range/reference/adaptors/introduction.html +range/reference/adaptors/general_requirements.html +range/reference/adaptors/reference.html +range/reference/adaptors/reference/adjacent_filtered.html +range/reference/adaptors/reference/copied.html +range/reference/adaptors/reference/filtered.html +range/reference/adaptors/reference/indexed.html +range/reference/adaptors/reference/indirected.html +range/reference/adaptors/reference/map_keys.html +range/reference/adaptors/reference/map_values.html +range/reference/adaptors/reference/replaced.html +range/reference/adaptors/reference/replaced_if.html +range/reference/adaptors/reference/reversed.html +range/reference/adaptors/reference/sliced.html +range/reference/adaptors/reference/strided.html +range/reference/adaptors/reference/type_erased.html +range/reference/adaptors/reference/tokenized.html +range/reference/adaptors/reference/transformed.html +range/reference/adaptors/reference/uniqued.html +range/reference/algorithms.html +range/reference/algorithms/introduction.html +range/reference/algorithms/mutating.html +range/reference/algorithms/mutating/copy.html +range/reference/algorithms/mutating/copy_backward.html +range/reference/algorithms/mutating/fill.html +range/reference/algorithms/mutating/fill_n.html +range/reference/algorithms/mutating/generate.html +range/reference/algorithms/mutating/inplace_merge.html +range/reference/algorithms/mutating/merge.html +range/reference/algorithms/mutating/nth_element.html +range/reference/algorithms/mutating/partial_sort.html +range/reference/algorithms/mutating/partition.html +range/reference/algorithms/mutating/random_shuffle.html +range/reference/algorithms/mutating/remove.html +range/reference/algorithms/mutating/remove_copy.html +range/reference/algorithms/mutating/remove_copy_if.html +range/reference/algorithms/mutating/remove_if.html +range/reference/algorithms/mutating/replace.html +range/reference/algorithms/mutating/replace_copy.html +range/reference/algorithms/mutating/replace_copy_if.html +range/reference/algorithms/mutating/replace_if.html +range/reference/algorithms/mutating/reverse.html +range/reference/algorithms/mutating/reverse_copy.html +range/reference/algorithms/mutating/rotate.html +range/reference/algorithms/mutating/rotate_copy.html +range/reference/algorithms/mutating/sort.html +range/reference/algorithms/mutating/stable_partition.html +range/reference/algorithms/mutating/stable_sort.html +range/reference/algorithms/mutating/swap_ranges.html +range/reference/algorithms/mutating/transform.html +range/reference/algorithms/mutating/unique.html +range/reference/algorithms/mutating/unique_copy.html +range/reference/algorithms/non_mutating.html +range/reference/algorithms/non_mutating/adjacent_find.html +range/reference/algorithms/non_mutating/binary_search.html +range/reference/algorithms/non_mutating/count.html +range/reference/algorithms/non_mutating/count_if.html +range/reference/algorithms/non_mutating/equal.html +range/reference/algorithms/non_mutating/equal_range.html +range/reference/algorithms/non_mutating/for_each.html +range/reference/algorithms/non_mutating/find.html +range/reference/algorithms/non_mutating/find_end.html +range/reference/algorithms/non_mutating/find_first_of.html +range/reference/algorithms/non_mutating/find_if.html +range/reference/algorithms/non_mutating/lexicographical_compare.html +range/reference/algorithms/non_mutating/lower_bound.html +range/reference/algorithms/non_mutating/max_element.html +range/reference/algorithms/non_mutating/min_element.html +range/reference/algorithms/non_mutating/mismatch.html +range/reference/algorithms/non_mutating/search.html +range/reference/algorithms/non_mutating/search_n.html +range/reference/algorithms/non_mutating/upper_bound.html +range/reference/algorithms/set.html +range/reference/algorithms/set/includes.html +range/reference/algorithms/set/set_union.html +range/reference/algorithms/set/set_intersection.html +range/reference/algorithms/set/set_difference.html +range/reference/algorithms/set/set_symmetric_difference.html +range/reference/algorithms/heap.html +range/reference/algorithms/heap/push_heap.html +range/reference/algorithms/heap/pop_heap.html +range/reference/algorithms/heap/make_heap.html +range/reference/algorithms/heap/sort_heap.html +range/reference/algorithms/permutation.html +range/reference/algorithms/permutation/next_permutation.html +range/reference/algorithms/permutation/prev_permutation.html +range/reference/algorithms/new.html +range/reference/algorithms/new/copy_n.html +range/reference/algorithms/new/erase.html +range/reference/algorithms/new/for_each.html +range/reference/algorithms/new/insert.html +range/reference/algorithms/new/iota.html +range/reference/algorithms/new/is_sorted.html +range/reference/algorithms/new/overwrite.html +range/reference/algorithms/new/push_back.html +range/reference/algorithms/new/push_front.html +range/reference/algorithms/new/remove_erase.html +range/reference/algorithms/new/remove_erase_if.html +range/reference/algorithms/numeric.html +range/reference/algorithms/numeric/accumulate.html +range/reference/algorithms/numeric/adjacent_difference.html +range/reference/algorithms/numeric/inner_product.html +range/reference/algorithms/numeric/partial_sum.html +range/reference/ranges.html +range/reference/ranges/any_range.html +range/reference/ranges/counting_range.html +range/reference/ranges/istream_range.html +range/reference/ranges/irange.html +range/reference/utilities.html +range/reference/utilities/iterator_range.html +range/reference/utilities/sub_range.html +range/reference/utilities/join.html +range/reference/extending.html +range/reference/extending/method_1.html +range/reference/extending/method_2.html +range/reference/extending/method_3.html +range/reference/extending/method_3/method_3_1.html +range/reference/extending/method_3/method_3_2.html +range/style_guide.html +range/headers.html +range/headers/general.html +range/headers/adaptors.html +range/headers/algorithm.html +range/headers/algorithm_ext.html +range/examples.html +range/mfc_atl.html +range/mfc_atl/requirements.html +range/mfc_atl/mfc_ranges.html +range/mfc_atl/atl_ranges.html +range/mfc_atl/const_ranges.html +range/mfc_atl/references.html +range/upgrade.html +range/upgrade/upgrade_from_1_45.html +range/upgrade/upgrade_from_1_42.html +range/upgrade/upgrade_from_1_34.html +range/portability.html +range/faq.html +range/history_ack.html diff --git a/libs/range/doc/html/range/concepts.html b/libs/range/doc/html/range/concepts.html new file mode 100644 index 0000000000..c3c92a8aeb --- /dev/null +++ b/libs/range/doc/html/range/concepts.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Range Concepts</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="introduction.html" title="Introduction"> +<link rel="next" href="concepts/overview.html" title="Overview"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="introduction.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concepts/overview.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.concepts"></a><a class="link" href="concepts.html" title="Range Concepts">Range Concepts</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="concepts/overview.html">Overview</a></span></dt> +<dt><span class="section"><a href="concepts/single_pass_range.html">Single Pass Range</a></span></dt> +<dt><span class="section"><a href="concepts/forward_range.html">Forward Range</a></span></dt> +<dt><span class="section"><a href="concepts/bidirectional_range.html">Bidirectional Range</a></span></dt> +<dt><span class="section"><a href="concepts/random_access_range.html">Random Access Range</a></span></dt> +<dt><span class="section"><a href="concepts/concept_checking.html">Concept Checking</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="introduction.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concepts/overview.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/concepts/bidirectional_range.html b/libs/range/doc/html/range/concepts/bidirectional_range.html new file mode 100644 index 0000000000..6e3dc8c3ee --- /dev/null +++ b/libs/range/doc/html/range/concepts/bidirectional_range.html @@ -0,0 +1,300 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Bidirectional Range</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concepts.html" title="Range Concepts"> +<link rel="prev" href="forward_range.html" title="Forward Range"> +<link rel="next" href="random_access_range.html" title="Random Access Range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="forward_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="random_access_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.concepts.bidirectional_range"></a><a class="link" href="bidirectional_range.html" title="Bidirectional Range">Bidirectional Range</a> +</h3></div></div></div> +<a name="range.concepts.bidirectional_range.notation"></a><h5> +<a name="id650256"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.notation">Notation</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">X</span></code> + </p> + </td> +<td> + <p> + A type that is a model of <a class="link" href="bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a>. + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">a</span></code> + </p> + </td> +<td> + <p> + Object of type X. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.bidirectional_range.description"></a><h5> +<a name="id650345"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.description">Description</a> + </h5> +<p> + This concept provides access to iterators that traverse in both directions + (forward and reverse). The <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> iterator must meet all of the requirements + of <a href="../../../../../../libs/iterator/doc/new-iter-concepts.html#bidirectional-traversal-iterators-lib-bidirectional-traversal-iterators" target="_top">Bidirectional + Traversal Iterator</a>. + </p> +<a name="range.concepts.bidirectional_range.refinement_of"></a><h5> +<a name="id650403"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.refinement_of">Refinement + of</a> + </h5> +<p> + <a class="link" href="forward_range.html" title="Forward Range">Forward Range</a> + </p> +<a name="range.concepts.bidirectional_range.associated_types"></a><h5> +<a name="id650426"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.associated_types">Associated + types</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + Reverse Iterator type + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + The type of iterator used to iterate through a Range's elements + in reverse order. The iterator's value type is expected to be the + Range's value type. A conversion from the reverse iterator type + to the const reverse iterator type must exist. + </p> + </td> +</tr> +<tr> +<td> + <p> + Const reverse iterator type + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + A type of reverse iterator that may be used to examine, but not + to modify, a Range's elements. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.bidirectional_range.valid_expressions"></a><h5> +<a name="id650581"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.valid_expressions">Valid + expressions</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return type + </p> + </th> +<th> + <p> + Semantics + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Beginning of range + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> if <code class="computeroutput"><span class="identifier">a</span></code> + is mutable <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> otherwise. + </p> + </td> +<td> + <p> + Equivalent to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code>. + </p> + </td> +</tr> +<tr> +<td> + <p> + End of range + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> if <code class="computeroutput"><span class="identifier">a</span></code> + is mutable, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> otherwise. + </p> + </td> +<td> + <p> + Equivalent to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code>. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.bidirectional_range.complexity_guarantees"></a><h5> +<a name="id651042"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.complexity_guarantees">Complexity + guarantees</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> has + the same complexity as <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> and + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> has the same complexity as <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> from + <a class="link" href="forward_range.html" title="Forward Range">Forward Range</a>. + </p> +<a name="range.concepts.bidirectional_range.invariants"></a><h5> +<a name="id651182"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.invariants">Invariants</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + Valid reverse range + </p> + </td> +<td> + <p> + For any Bidirectional Range a, <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">a</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code> + is a valid range, that is, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> is reachable from <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + in a finite number of increments. + </p> + </td> +</tr> +<tr> +<td> + <p> + Completeness + </p> + </td> +<td> + <p> + An algorithm that iterates through the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">a</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code> + will pass through every element of <code class="computeroutput"><span class="identifier">a</span></code>. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.bidirectional_range.see_also"></a><h5> +<a name="id651431"></a> + <a class="link" href="bidirectional_range.html#range.concepts.bidirectional_range.see_also">See also</a> + </h5> +<p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions">Implementation + of metafunctions</a> + </p> +<p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions">Implementation + of functions</a> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="forward_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="random_access_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/concepts/concept_checking.html b/libs/range/doc/html/range/concepts/concept_checking.html new file mode 100644 index 0000000000..20a2fbbe35 --- /dev/null +++ b/libs/range/doc/html/range/concepts/concept_checking.html @@ -0,0 +1,108 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Concept Checking</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concepts.html" title="Range Concepts"> +<link rel="prev" href="random_access_range.html" title="Random Access Range"> +<link rel="next" href="../reference.html" title="Reference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="random_access_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.concepts.concept_checking"></a><a class="link" href="concept_checking.html" title="Concept Checking">Concept Checking</a> +</h3></div></div></div> +<p> + Each of the range concepts has a corresponding concept checking class in + the file <a href="../../../../../../boost/range/concepts.hpp" target="_top"><code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">concepts</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a>. + These classes may be used in conjunction with the <a href="../../../../../../libs/concept_check/index.html" target="_top">Boost + Concept Check library</a> to ensure that the type of a template parameter + is compatible with a range concept. If not, a meaningful compile time error + is generated. Checks are provided for the range concepts related to iterator + traversal categories. For example, the following line checks that the type + <code class="computeroutput"><span class="identifier">T</span></code> models the <a class="link" href="forward_range.html" title="Forward Range">Forward + Range</a> concept. + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">BOOST_CONCEPT_ASSERT</span><span class="special">((</span> <span class="identifier">ForwardRangeConcept</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="special">));</span> +</pre> +<p> + </p> +<p> + An additional concept check is required for the value access property of + the range based on the range's iterator type. For example to check for a + ForwardReadableRange, the following code is required. + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">BOOST_CONCEPT_ASSERT</span><span class="special">((</span> <span class="identifier">ForwardRangeConcept</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="special">));</span> +<span class="identifier">BOOST_CONCEPT_ASSERT</span><span class="special">((</span> <span class="identifier">ReadableIteratorConcept</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> <span class="special">));</span> +</pre> +<p> + </p> +<p> + The following range concept checking classes are provided. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Class SinglePassRangeConcept checks for <a class="link" href="single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + Class ForwardRangeConcept checks for <a class="link" href="forward_range.html" title="Forward Range">Forward + Range</a> + </li> +<li class="listitem"> + Class BidirectionalRangeConcept checks for <a class="link" href="bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </li> +<li class="listitem"> + Class RandomAccessRangeConcept checks for <a class="link" href="random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +</ul></div> +<a name="range.concepts.concept_checking.see_also"></a><h5> +<a name="id652377"></a> + <a class="link" href="concept_checking.html#range.concepts.concept_checking.see_also">See also</a> + </h5> +<p> + <a class="link" href="../style_guide.html" title="Terminology and style guidelines">Range Terminology and style guidelines</a> + </p> +<p> + <a href="../../../../../../libs/iterator/doc/iterator_concepts.html" target="_top">Iterator concepts</a> + </p> +<p> + <a href="../../../../../../libs/concept_check/index.html" target="_top">Boost Concept Check library</a> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="random_access_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/concepts/forward_range.html b/libs/range/doc/html/range/concepts/forward_range.html new file mode 100644 index 0000000000..7937f8cbc7 --- /dev/null +++ b/libs/range/doc/html/range/concepts/forward_range.html @@ -0,0 +1,160 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Forward Range</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concepts.html" title="Range Concepts"> +<link rel="prev" href="single_pass_range.html" title="Single Pass Range"> +<link rel="next" href="bidirectional_range.html" title="Bidirectional Range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="single_pass_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="bidirectional_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.concepts.forward_range"></a><a class="link" href="forward_range.html" title="Forward Range">Forward Range</a> +</h3></div></div></div> +<a name="range.concepts.forward_range.notation"></a><h5> +<a name="id649886"></a> + <a class="link" href="forward_range.html#range.concepts.forward_range.notation">Notation</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">X</span></code> + </p> + </td> +<td> + <p> + A type that is a model of <a class="link" href="forward_range.html" title="Forward Range">Forward + Range</a>. + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">a</span></code> + </p> + </td> +<td> + <p> + Object of type X. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.forward_range.description"></a><h5> +<a name="id649974"></a> + <a class="link" href="forward_range.html#range.concepts.forward_range.description">Description</a> + </h5> +<p> + A range <code class="computeroutput"><span class="identifier">X</span></code> where <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> is a model of <a href="../../../../../../libs/iterator/doc/new-iter-concepts.html#forward-traversal-iterators-lib-forward-traversal-iterators" target="_top">Forward + Traversal Iterator</a>. + </p> +<a name="range.concepts.forward_range.refinement_of"></a><h5> +<a name="id650039"></a> + <a class="link" href="forward_range.html#range.concepts.forward_range.refinement_of">Refinement of</a> + </h5> +<p> + <a class="link" href="single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> +<a name="range.concepts.forward_range.associated_types"></a><h5> +<a name="id650062"></a> + <a class="link" href="forward_range.html#range.concepts.forward_range.associated_types">Associated + types</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + Distance type + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + A signed integral type used to represent the distance between two + of the Range's iterators. This type must be the same as the iterator's + distance type. + </p> + </td> +</tr> +<tr> +<td> + <p> + Size type + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_size</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + An unsigned integral type that can represent any nonnegative value + of the Range's distance type. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.forward_range.see_also"></a><h5> +<a name="id650211"></a> + <a class="link" href="forward_range.html#range.concepts.forward_range.see_also">See also</a> + </h5> +<p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions">Implementation + of metafunctions</a> + </p> +<p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions">Implementation + of functions</a> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="single_pass_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="bidirectional_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/concepts/overview.html b/libs/range/doc/html/range/concepts/overview.html new file mode 100644 index 0000000000..bded544c57 --- /dev/null +++ b/libs/range/doc/html/range/concepts/overview.html @@ -0,0 +1,79 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Overview</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concepts.html" title="Range Concepts"> +<link rel="prev" href="../concepts.html" title="Range Concepts"> +<link rel="next" href="single_pass_range.html" title="Single Pass Range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../concepts.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="single_pass_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.concepts.overview"></a><a class="link" href="overview.html" title="Overview">Overview</a> +</h3></div></div></div> +<p> + A Range is a <span class="bold"><strong><span class="emphasis"><em>concept</em></span></strong></span> + similar to the STL <a href="http://www.sgi.com/Technology/STL/Container.html" target="_top">Container</a> + concept. A Range provides iterators for accessing a half-open range <code class="computeroutput"><span class="special">[</span><span class="identifier">first</span><span class="special">,</span><span class="identifier">one_past_last</span><span class="special">)</span></code> of elements and provides information about + the number of elements in the Range. However, a Range has fewer requirements + than a Container. + </p> +<p> + The motivation for the Range concept is that there are many useful Container-like + types that do not meet the full requirements of Container, and many algorithms + that can be written with this reduced set of requirements. In particular, + a Range does not necessarily + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + own the elements that can be accessed through it, + </li> +<li class="listitem"> + have copy semantics, + </li> +</ul></div> +<p> + Because of the second requirement, a Range object must be passed by (const + or non-const) reference in generic code. + </p> +<p> + The operations that can be performed on a Range is dependent on the <a href="../../../../../../libs/iterator/doc/new-iter-concepts.html#iterator-traversal-concepts-lib-iterator-traversal" target="_top">traversal + category</a> of the underlying iterator type. Therefore the range concepts + are named to reflect which traversal category its iterators support. See + also terminology and style guidelines. for more information about naming + of ranges. + </p> +<p> + The concepts described below specifies associated types as <a href="../../../../../../libs/mpl/doc/refmanual/metafunction.html" target="_top">metafunctions</a> + and all functions as free-standing functions to allow for a layer of indirection. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../concepts.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="single_pass_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/concepts/random_access_range.html b/libs/range/doc/html/range/concepts/random_access_range.html new file mode 100644 index 0000000000..3124ddcc45 --- /dev/null +++ b/libs/range/doc/html/range/concepts/random_access_range.html @@ -0,0 +1,187 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Random Access Range</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concepts.html" title="Range Concepts"> +<link rel="prev" href="bidirectional_range.html" title="Bidirectional Range"> +<link rel="next" href="concept_checking.html" title="Concept Checking"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="bidirectional_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concept_checking.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.concepts.random_access_range"></a><a class="link" href="random_access_range.html" title="Random Access Range">Random Access Range</a> +</h3></div></div></div> +<a name="range.concepts.random_access_range.description"></a><h5> +<a name="id651477"></a> + <a class="link" href="random_access_range.html#range.concepts.random_access_range.description">Description</a> + </h5> +<p> + A range <code class="computeroutput"><span class="identifier">X</span></code> where <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> is a model of <a href="../../../../../../libs/iterator/doc/new-iter-concepts.html#random-access-traversal-iterators-lib-random-access-traversal-iterators" target="_top">Random + Access Traversal Iterator</a>. + </p> +<a name="range.concepts.random_access_range.refinement_of"></a><h5> +<a name="id651543"></a> + <a class="link" href="random_access_range.html#range.concepts.random_access_range.refinement_of">Refinement + of</a> + </h5> +<p> + <a class="link" href="bidirectional_range.html" title="Bidirectional Range">Bidirectional Range</a> + </p> +<a name="range.concepts.random_access_range.valid_expressions"></a><h5> +<a name="id651566"></a> + <a class="link" href="random_access_range.html#range.concepts.random_access_range.valid_expressions">Valid + expressions</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return type + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> + Size of range + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_size</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +</tr></tbody> +</table></div> +<a name="range.concepts.random_access_range.expression_semantics"></a><h5> +<a name="id651704"></a> + <a class="link" href="random_access_range.html#range.concepts.random_access_range.expression_semantics">Expression + semantics</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Semantics + </p> + </th> +<th> + <p> + Postcondition + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + Returns the size of the Range, that is, its number of elements. + Note <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span> + <span class="special">==</span> <span class="number">0u</span></code> + is equivalent to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">empty</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>. + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span> + <span class="special">>=</span> <span class="number">0</span></code> + </p> + </td> +</tr></tbody> +</table></div> +<a name="range.concepts.random_access_range.complexity_guarantees"></a><h5> +<a name="id651919"></a> + <a class="link" href="random_access_range.html#range.concepts.random_access_range.complexity_guarantees">Complexity + guarantees</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> completes in amortized constant time. + </p> +<a name="range.concepts.random_access_range.invariants"></a><h5> +<a name="id651967"></a> + <a class="link" href="random_access_range.html#range.concepts.random_access_range.invariants">Invariants</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody><tr> +<td> + <p> + Range size + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + is equal to the <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> - <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>. + </p> + </td> +</tr></tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="bidirectional_range.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concept_checking.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/concepts/single_pass_range.html b/libs/range/doc/html/range/concepts/single_pass_range.html new file mode 100644 index 0000000000..273692a252 --- /dev/null +++ b/libs/range/doc/html/range/concepts/single_pass_range.html @@ -0,0 +1,350 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Single Pass Range</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concepts.html" title="Range Concepts"> +<link rel="prev" href="overview.html" title="Overview"> +<link rel="next" href="forward_range.html" title="Forward Range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="forward_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.concepts.single_pass_range"></a><a class="link" href="single_pass_range.html" title="Single Pass Range">Single Pass Range</a> +</h3></div></div></div> +<a name="range.concepts.single_pass_range.notation"></a><h5> +<a name="id648593"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.notation">Notation</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">X</span></code> + </p> + </td> +<td> + <p> + A type that is a model of <a class="link" href="single_pass_range.html" title="Single Pass Range">Single + Pass Range</a>. + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">a</span></code> + </p> + </td> +<td> + <p> + Object of type X. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.single_pass_range.description"></a><h5> +<a name="id648686"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.description">Description</a> + </h5> +<p> + A range <code class="computeroutput"><span class="identifier">X</span></code> where <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> is a model of <a href="../../../../../../libs/iterator/doc/new-iter-concepts.html#singls-pass-iterators-lib-single-pass-iterators" target="_top">Single + Pass Iterator</a>. + </p> +<a name="range.concepts.single_pass_range.associated_types"></a><h5> +<a name="id648751"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.associated_types">Associated + types</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + Iterator type + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + The type of iterator used to iterate through a Range's elements. + The iterator's value type is expected to be the Range's value type. + A conversion from the iterator type to the <code class="computeroutput"><span class="keyword">const</span></code> + iterator type must exist. + </p> + </td> +</tr> +<tr> +<td> + <p> + Const iterator type + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + A type of iterator that may be used to examine, but not to modify, + a Range's elements. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.single_pass_range.valid_expressions"></a><h5> +<a name="id648914"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.valid_expressions">Valid + expressions</a> + </h5> +<p> + The following expressions must be valid. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return type + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Beginning of range + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> if <code class="computeroutput"><span class="identifier">a</span></code> + is mutable, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> otherwise + </p> + </td> +</tr> +<tr> +<td> + <p> + End of range + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> if <code class="computeroutput"><span class="identifier">a</span></code> + is mutable, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> otherwise + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.single_pass_range.expression_semantics"></a><h5> +<a name="id649233"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.expression_semantics">Expression + semantics</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Semantics + </p> + </th> +<th> + <p> + Postcondition + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + Returns an iterator pointing to the first element in the Range. + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + is either dereferenceable or past-the-end. It is past-the-end if + and only if <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span> <span class="special">==</span> <span class="number">0</span></code>. + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + Returns an iterator pointing one past the last element in the Range. + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + is past-the-end. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.single_pass_range.complexity_guarantees"></a><h5> +<a name="id649490"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.complexity_guarantees">Complexity + guarantees</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> is at most amortized linear time, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> is amortized + constant time. For most practical purposes, one can expect both to be amortized + constant time. + </p> +<a name="range.concepts.single_pass_range.invariants"></a><h5> +<a name="id649567"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.invariants">Invariants</a> + </h5> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + Valid range + </p> + </td> +<td> + <p> + For any Range <code class="computeroutput"><span class="identifier">a</span></code>, + <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code> is a valid range, that is, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> + is reachable from <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code> in a finite number of increments. + </p> + </td> +</tr> +<tr> +<td> + <p> + Completeness + </p> + </td> +<td> + <p> + An algorithm that iterates through the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">a</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code> + will pass through every element of <code class="computeroutput"><span class="identifier">a</span></code>. + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.concepts.single_pass_range.see_also"></a><h5> +<a name="id649823"></a> + <a class="link" href="single_pass_range.html#range.concepts.single_pass_range.see_also">See also</a> + </h5> +<p> + <a class="link" href="../reference/extending.html" title="Extending the library">Extending the library for UDTs</a> + </p> +<p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions">Implementation + of metafunctions</a> + </p> +<p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions">Implementation + of functions</a> + </p> +<p> + <a href="http://www.sgi.com/Technology/STL/Container.html" target="_top">Container</a> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="forward_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/examples.html b/libs/range/doc/html/range/examples.html new file mode 100644 index 0000000000..5a4201b899 --- /dev/null +++ b/libs/range/doc/html/range/examples.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Examples</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="headers/algorithm_ext.html" title="Algorithm Extensions"> +<link rel="next" href="mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="headers/algorithm_ext.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mfc_atl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.examples"></a><a class="link" href="examples.html" title="Examples">Examples</a> +</h2></div></div></div> +<p> + Some examples are given in the accompanying test files: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/string.cpp" target="_top">string.cpp</a> + shows how to implement a container version of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">find</span><span class="special">()</span></code> that works with <code class="computeroutput"><span class="keyword">char</span><span class="special">[]</span></code>,<code class="computeroutput"><span class="keyword">wchar_t</span><span class="special">[]</span></code>,<code class="computeroutput"><span class="keyword">char</span><span class="special">*</span></code>,<code class="computeroutput"><span class="keyword">wchar_t</span><span class="special">*</span></code>. + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/algorithm_example.cpp" target="_top">algorithm_example.cpp</a> + shows the replace example from the introduction. + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/iterator_range.cpp" target="_top">iterator_range.cpp</a> + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/sub_range.cpp" target="_top">sub_range.cpp</a> + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/iterator_pair.cpp" target="_top">iterator_pair.cpp</a> + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/reversible_range.cpp" target="_top">reversible_range.cpp</a> + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/std_container.cpp" target="_top">std_container.cpp</a> + </li> +<li class="listitem"> + <a href="http://www.boost.org/libs/range/test/array.cpp" target="_top">array.cpp</a> + </li> +</ul></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="headers/algorithm_ext.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mfc_atl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/faq.html b/libs/range/doc/html/range/faq.html new file mode 100644 index 0000000000..6a689f13ba --- /dev/null +++ b/libs/range/doc/html/range/faq.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>FAQ</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="portability.html" title="Portability"> +<link rel="next" href="history_ack.html" title="History and Acknowledgement"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="portability.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="history_ack.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.faq"></a><a class="link" href="faq.html" title="FAQ">FAQ</a> +</h2></div></div></div> +<p> + 1. <span class="emphasis"><em><span class="bold"><strong>Why is there no difference between <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">C</span><span class="special">>::</span><span class="identifier">type</span></code> + and <code class="computeroutput"><span class="identifier">range_const_iterator</span><span class="special"><</span><span class="identifier">C</span><span class="special">>::</span><span class="identifier">type</span></code> + for <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">iterator</span><span class="special">></span></code>?</strong></span></em></span> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + In general it is not possible nor desirable to find a corresponding <code class="computeroutput"><span class="identifier">const_iterator</span></code>. When it is possible to + come up with one, the client might choose to construct a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">const_iterator</span><span class="special">,</span><span class="identifier">const_iterator</span><span class="special">></span></code> object. + </p></blockquote></div> +<div class="blockquote"><blockquote class="blockquote"><p> + Note that an <a class="link" href="reference/utilities/iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> is somewhat more + convenient than a <code class="computeroutput"><span class="identifier">pair</span></code> and + that a <a class="link" href="reference/utilities/sub_range.html" title="Class sub_range"><code class="computeroutput"><span class="identifier">sub_range</span></code></a> does propagate const-ness. + </p></blockquote></div> +<p> + 2. <span class="emphasis"><em><span class="bold"><strong>Why is there not supplied more types or + more functions?</strong></span></em></span> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + The library has been kept small because its current interface will serve + most purposes. If and when a genuine need arises for more functionality, + it can be implemented. + </p></blockquote></div> +<p> + 3. <span class="emphasis"><em><span class="bold"><strong>How should I implement generic algorithms + for ranges?</strong></span></em></span> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + One should always start with a generic algorithm that takes two iterators + (or more) as input. Then use Boost.Range to build handier versions on top + of the iterator based algorithm. Please notice that once the range version + of the algorithm is done, it makes sense not to expose the iterator version + in the public interface. + </p></blockquote></div> +<p> + 4. <span class="emphasis"><em><span class="bold"><strong>Why is there no Incrementable Range concept?</strong></span></em></span> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + Even though we speak of incrementable iterators, it would not make much sense + for ranges; for example, we cannot determine the size and emptiness of a + range since we cannot even compare its iterators. + </p></blockquote></div> +<div class="blockquote"><blockquote class="blockquote"><p> + Note also that incrementable iterators are derived from output iterators + and so there exist no output range. + </p></blockquote></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="portability.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="history_ack.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/headers.html b/libs/range/doc/html/range/headers.html new file mode 100644 index 0000000000..b4ce7e3ed4 --- /dev/null +++ b/libs/range/doc/html/range/headers.html @@ -0,0 +1,49 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Library Headers</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="style_guide.html" title="Terminology and style guidelines"> +<link rel="next" href="headers/general.html" title="General"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="style_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="headers/general.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.headers"></a><a class="link" href="headers.html" title="Library Headers">Library Headers</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="headers/general.html">General</a></span></dt> +<dt><span class="section"><a href="headers/adaptors.html">Adaptors</a></span></dt> +<dt><span class="section"><a href="headers/algorithm.html">Algorithm</a></span></dt> +<dt><span class="section"><a href="headers/algorithm_ext.html">Algorithm Extensions</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="style_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="headers/general.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/headers/adaptors.html b/libs/range/doc/html/range/headers/adaptors.html new file mode 100644 index 0000000000..1d2952eba0 --- /dev/null +++ b/libs/range/doc/html/range/headers/adaptors.html @@ -0,0 +1,232 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Adaptors</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../headers.html" title="Library Headers"> +<link rel="prev" href="general.html" title="General"> +<link rel="next" href="algorithm.html" title="Algorithm"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="general.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.headers.adaptors"></a><a class="link" href="adaptors.html" title="Adaptors">Adaptors</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">adjacent_filtered</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/adjacent_filtered.html" title="adjacent_filtered">adjacent_filtered</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">copied</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/copied.html" title="copied">copied</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">filtered</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/filtered.html" title="filtered">filtered</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">indexed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/indexed.html" title="indexed">indexed</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">indirected</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">.</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/indirected.html" title="indirected">indirected</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/map_keys.html" title="map_keys">map_keys</a> + <a class="link" href="../reference/adaptors/reference/map_values.html" title="map_values">map_values</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">replaced</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/replaced.html" title="replaced">replaced</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">replaced_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/replaced_if.html" title="replaced_if">replaced_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">reversed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/reversed.html" title="reversed">reversed</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">sliced</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/sliced.html" title="sliced">sliced</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">strided</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/strided.html" title="strided">strided</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">tokenized</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/tokenized.html" title="tokenized">tokenized</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">transformed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/transformed.html" title="transformed">transformed</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">uniqued</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/uniqued.html" title="uniqued">uniqued</a> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="general.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/headers/algorithm.html b/libs/range/doc/html/range/headers/algorithm.html new file mode 100644 index 0000000000..40bac9017e --- /dev/null +++ b/libs/range/doc/html/range/headers/algorithm.html @@ -0,0 +1,683 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Algorithm</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../headers.html" title="Library Headers"> +<link rel="prev" href="adaptors.html" title="Adaptors"> +<link rel="next" href="algorithm_ext.html" title="Algorithm Extensions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adaptors.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm_ext.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.headers.algorithm"></a><a class="link" href="algorithm.html" title="Algorithm">Algorithm</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">adjacent_find</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/adjacent_find.html" title="adjacent_find">adjacent_find</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">binary_search</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/binary_search.html" title="binary_search">binary_search</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/copy.html" title="copy">copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy_backward</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/copy_backward.html" title="copy_backward">copy_backward</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">count</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/count.html" title="count">count</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">count_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/count_if.html" title="count_if">count_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">equal</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/equal.html" title="equal">equal</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">equal_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/equal_range.html" title="equal_range">equal_range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">fill</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/fill.html" title="fill">fill</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">fill_n</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/fill_n.html" title="fill_n">fill_n</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find.html" title="find">find</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_end</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find_end.html" title="find_end">find_end</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_first_of</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find_first_of.html" title="find_first_of">find_first_of</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find_if.html" title="find_if">find_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/for_each.html" title="for_each">for_each</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">generate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/generate.html" title="generate">generate</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/heap/push_heap.html" title="push_heap">push_heap</a> + <a class="link" href="../reference/algorithms/heap/pop_heap.html" title="pop_heap">pop_heap</a> + <a class="link" href="../reference/algorithms/heap/make_heap.html" title="make_heap">make_heap</a> + <a class="link" href="../reference/algorithms/heap/sort_heap.html" title="sort_heap">sort_heap</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">inplace_merge</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/inplace_merge.html" title="inplace_merge">inplace_merge</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">lexicographical_compare</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/lexicographical_compare.html" title="lexicographical_compare">lexicographical_compare</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">lower_bound</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/lower_bound.html" title="lower_bound">lower_bound</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">max_element</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/max_element.html" title="max_element">max_element</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">merge</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/merge.html" title="merge">merge</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">min_element</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/min_element.html" title="min_element">min_element</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">mismatch</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/mismatch.html" title="mismatch">mismatch</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">nth_element</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/nth_element.html" title="nth_element">nth_element</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partial_sort</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/partial_sort.html" title="partial_sort">partial_sort</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partition</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/partition.html" title="partition">partition</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">permutation</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/permutation/next_permutation.html" title="next_permutation">next_permutation</a> + <a class="link" href="../reference/algorithms/permutation/prev_permutation.html" title="prev_permutation">prev_permutation</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">random_shuffle</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/random_shuffle.html" title="random_shuffle">random_shuffle</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove.html" title="remove">remove</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove_copy.html" title="remove_copy">remove_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_copy_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove_copy_if.html" title="remove_copy_if">remove_copy_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove_if.html" title="remove_if">remove_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace.html" title="replace">replace</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace_copy.html" title="replace_copy">replace_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_copy_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace_copy_if.html" title="replace_copy_if">replace_copy_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace_if.html" title="replace_if">replace_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">reverse</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/reverse.html" title="reverse">reverse</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">reverse_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/reverse_copy.html" title="reverse_copy">reverse_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">rotate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/rotate.html" title="rotate">rotate</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">rotate_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/rotate_copy.html" title="rotate_copy">rotate_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">search</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/search.html" title="search">search</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">search_n</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/search_n.html" title="search_n">search_n</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/set/includes.html" title="includes">includes</a> + <a class="link" href="../reference/algorithms/set/set_union.html" title="set_union">set_union</a> + <a class="link" href="../reference/algorithms/set/set_intersection.html" title="set_intersection">set_intersection</a> + <a class="link" href="../reference/algorithms/set/set_difference.html" title="set_difference">set_difference</a> + <a class="link" href="../reference/algorithms/set/set_symmetric_difference.html" title="set_symmetric_difference">set_symmetric_difference</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">sort</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/sort.html" title="sort">sort</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">stable_partition</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/stable_partition.html" title="stable_partition">stable_partition</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">swap_ranges</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/swap_ranges.html" title="swap_ranges">swap_ranges</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">transform</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/transform.html" title="transform">transform</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">unique</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/unique.html" title="unique">unique</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">unique_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/unique_copy.html" title="unique_copy">unique_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">upper_bound</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/upper_bound.html" title="upper_bound">upper_bound</a> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adaptors.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm_ext.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/headers/algorithm_ext.html b/libs/range/doc/html/range/headers/algorithm_ext.html new file mode 100644 index 0000000000..4a623390af --- /dev/null +++ b/libs/range/doc/html/range/headers/algorithm_ext.html @@ -0,0 +1,171 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Algorithm Extensions</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../headers.html" title="Library Headers"> +<link rel="prev" href="algorithm.html" title="Algorithm"> +<link rel="next" href="../examples.html" title="Examples"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.headers.algorithm_ext"></a><a class="link" href="algorithm_ext.html" title="Algorithm Extensions">Algorithm Extensions</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">copy_n</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/copy_n.html" title="copy_n">copy_n</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/erase.html" title="erase">erase</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/for_each.html" title="for_each">for_each</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">insert</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/insert.html" title="insert">insert</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">iota</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/iota.html" title="iota">iota</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">is_sorted</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/is_sorted.html" title="is_sorted">is_sorted</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">overwrite</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/overwrite.html" title="overwrite">overwrite</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">push_back</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/push_back.html" title="push_back">push_back</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">push_front</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/push_front.html" title="push_front">push_front</a> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/headers/general.html b/libs/range/doc/html/range/headers/general.html new file mode 100644 index 0000000000..ea122b8963 --- /dev/null +++ b/libs/range/doc/html/range/headers/general.html @@ -0,0 +1,551 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>General</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../headers.html" title="Library Headers"> +<link rel="prev" href="../headers.html" title="Library Headers"> +<link rel="next" href="adaptors.html" title="Adaptors"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../headers.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adaptors.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.headers.general"></a><a class="link" href="general.html" title="General">General</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +<th> + <p> + Related Concept + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + everything from Boost.Range version 1 (Boost versions 1.42 and + below). Includes the core range functions and metafunctinos, but + excludes Range Adaptors and Range Algorithms. + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">metafunctions</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every metafunction + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">functions</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every function + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">value_type</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_value</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_iterator</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">difference_type</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_difference</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">pointer</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_pointer</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">category</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_category</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">reverse_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_reverse_iterator</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">begin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">begin</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_begin</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">end</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">end</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_end</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">empty</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">empty</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">distance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">distance</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">size</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">size</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">rbegin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">rbegin</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_rbegin</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">rend</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">rend</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_rend</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">as_array</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">as_array</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">as_literal</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">as_literal</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">iterator_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/utilities/iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">sub_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/utilities/sub_range.html" title="Class sub_range"><code class="computeroutput"><span class="identifier">sub_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">concepts</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts.html" title="Range Concepts">Range concepts</a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptors</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every range adaptor + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every range equivalent of an STL algorithm + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every range algorithm that is an extension of the STL algorithms + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">counting_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/ranges/counting_range.html" title="counting_range"><code class="computeroutput"><span class="identifier">counting_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">istream_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/ranges/istream_range.html" title="istream_range"><code class="computeroutput"><span class="identifier">istream_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">irange</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/ranges/irange.html" title="irange"><code class="computeroutput"><span class="identifier">irange</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">join</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/utilities/join.html" title="Function join"><code class="computeroutput"><span class="identifier">join</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../headers.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adaptors.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/history_ack.html b/libs/range/doc/html/range/history_ack.html new file mode 100644 index 0000000000..49355b5daf --- /dev/null +++ b/libs/range/doc/html/range/history_ack.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>History and Acknowledgement</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="faq.html" title="FAQ"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="faq.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.history_ack"></a><a class="link" href="history_ack.html" title="History and Acknowledgement">History and Acknowledgement</a> +</h2></div></div></div> +<a name="range.history_ack.version_1___before_boost_1_43"></a><h4> +<a name="id786758"></a> + <a class="link" href="history_ack.html#range.history_ack.version_1___before_boost_1_43">Version 1 - + before Boost 1.43</a> + </h4> +<p> + The library have been under way for a long time. Dietmar Kühl originally intended + to submit an <code class="computeroutput"><span class="identifier">array_traits</span></code> class + template which had most of the functionality present now, but only for arrays + and standard containers. + </p> +<p> + Meanwhile work on algorithms for containers in various contexts showed the + need for handling pairs of iterators, and string libraries needed special treatment + of character arrays. In the end it made sense to formalize the minimal requirements + of these similar concepts. And the results are the Range concepts found in + this library. + </p> +<p> + The term Range was adopted because of paragraph 24.1/7 from the C++ standard: + </p> +<p> + Most of the library's algorithmic templates that operate on data structures + have interfaces that use ranges. A range is a pair of iterators that designate + the beginning and end of the computation. A range [i, i) is an empty range; + in general, a range [i, j) refers to the elements in the data structure starting + with the one pointed to by i and up to but not including the one pointed to + by j. Range [i, j) is valid if and only if j is reachable from i. The result + of the application of functions in the library to invalid ranges is undefined. + </p> +<p> + Special thanks goes to + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Pavol Droba for help with documentation and implementation + </li> +<li class="listitem"> + Pavel Vozenilek for help with porting the library + </li> +<li class="listitem"> + Jonathan Turkanis and John Torjo for help with documentation + </li> +<li class="listitem"> + Hartmut Kaiser for being review manager + </li> +<li class="listitem"> + Jonathan Turkanis for porting the lib (as far sa possible) to vc6 and vc7. + </li> +</ul></div> +<p> + The concept checks and their documentation was provided by Daniel Walker. + </p> +<a name="range.history_ack.version_2___boost_1_43_and_beyond"></a><h4> +<a name="id786859"></a> + <a class="link" href="history_ack.html#range.history_ack.version_2___boost_1_43_and_beyond">Version + 2 - Boost 1.43 and beyond</a> + </h4> +<p> + This version introduced Range Adaptors and Range Algorithms. This version 2 + is the result of a merge of all of the RangeEx features into Boost.Range. + </p> +<p> + There were an enormous number of very significant contributors through all + stages of this library. + </p> +<p> + Prior to Boost.RangeEx there had been a number of Range library implementations, + these include library implementations by Eric Niebler, Adobe, Shunsuke Sogame + etc. Eric Niebler contributed the Range Adaptor idea which is arguably the + single biggest innovation in this library. Inevitably a great deal of commonality + evolved in each of these libraries, but a considerable amount of effort was + expended to learn from all of the divergent techniques. + </p> +<p> + The people in the following list all made contributions in the form of reviews, + user feedback, design suggestions, or defect detection: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Thorsten Ottosen: review management, design advice, documentation feedback + </li> +<li class="listitem"> + Eric Niebler: early implementation, and review feedback + </li> +<li class="listitem"> + Joel de Guzman: review + </li> +<li class="listitem"> + Mathias Gaunard: review + </li> +<li class="listitem"> + David Abrahams: implementation advice + </li> +<li class="listitem"> + Robert Jones: defect reports, usage feedback + </li> +<li class="listitem"> + Sean Parent: contributed experience from the Adobe range library + </li> +<li class="listitem"> + Arno Schoedl: implementations, and review + </li> +<li class="listitem"> + Rogier van Dalen: review + </li> +<li class="listitem"> + Vincente Botet: review, documentation feedback + </li> +</ul></div> +<p> + Regardless of how I write this section it will never truly fairly capture the + gratitude that I feel to all who have contributed. Thank you everyone. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="faq.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/introduction.html b/libs/range/doc/html/range/introduction.html new file mode 100644 index 0000000000..a68d315ed9 --- /dev/null +++ b/libs/range/doc/html/range/introduction.html @@ -0,0 +1,129 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Introduction</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="next" href="concepts.html" title="Range Concepts"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concepts.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.introduction"></a><a class="link" href="introduction.html" title="Introduction">Introduction</a> +</h2></div></div></div> +<p> + Generic algorithms have so far been specified in terms of two or more iterators. + Two iterators would together form a range of values that the algorithm could + work on. This leads to a very general interface, but also to a somewhat clumsy + use of the algorithms with redundant specification of container names. Therefore + we would like to raise the abstraction level for algorithms so they specify + their interface in terms of <a class="link" href="concepts.html" title="Range Concepts">Ranges</a> as + much as possible. + </p> +<p> + The most common form of ranges used throughout the C++ community are standard + library containers. When writing algorithms however, one often finds it desirable + for the algorithm to accept other types that offer enough functionality to + satisfy the needs of the generic code <span class="bold"><strong><span class="emphasis"><em>if a + suitable layer of indirection is applied</em></span></strong></span> . For example, + raw arrays are often suitable for use with generic code that works with containers, + provided a suitable adapter is used. Likewise, null terminated strings can + be treated as containers of characters, if suitably adapted. + </p> +<p> + This library therefore provides the means to adapt standard-like containers, + null terminated strings, <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pairs</span></code> of + iterators, and raw arrays (and more), such that the same generic code can work + with them all. The basic idea is to add another layer of indirection using + <a href="../../../../../libs/mpl/doc/refmanual/metafunction.html" target="_top">metafunctions</a> + and free-standing functions so syntactic and/or semantic differences can be + removed. + </p> +<p> + The main advantages are + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + simpler implementation and specification of generic range algorithms + </li> +<li class="listitem"> + more flexible, compact and maintainable client code + </li> +<li class="listitem"> + safe use of built-in arrays (for legacy code; why else would you use built-in + arrays?) + </li> +</ul></div> +<a name="range.introduction.example___iterate_over_the_values_in_a_map"></a><h4> +<a name="id607240"></a> + <a class="link" href="introduction.html#range.introduction.example___iterate_over_the_values_in_a_map">Example + - Iterate over the values in a map</a> + </h4> +<p> + +</p> +<pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">;</span> +<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> +<span class="identifier">for_each</span><span class="special">(</span> <span class="identifier">my_map</span> <span class="special">|</span> <span class="identifier">map_values</span><span class="special">,</span> <span class="identifier">fn</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.introduction.example___iterate_over_the_keys_in_a_map"></a><h4> +<a name="id607360"></a> + <a class="link" href="introduction.html#range.introduction.example___iterate_over_the_keys_in_a_map">Example + - Iterate over the keys in a map</a> + </h4> +<p> + +</p> +<pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">;</span> +<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> +<span class="identifier">for_each</span><span class="special">(</span> <span class="identifier">my_map</span> <span class="special">|</span> <span class="identifier">map_keys</span><span class="special">,</span> <span class="identifier">fn</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.introduction.example___push_the_even_values_from_a_map_in_reverse_order_into_the_container__code__phrase_role__identifier__target__phrase___code_"></a><h4> +<a name="id648314"></a> + <a class="link" href="introduction.html#range.introduction.example___push_the_even_values_from_a_map_in_reverse_order_into_the_container__code__phrase_role__identifier__target__phrase___code_">Example + - Push the even values from a map in reverse order into the container <code class="computeroutput"><span class="identifier">target</span></code></a> + </h4> +<p> + +</p> +<pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">;</span> +<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> +<span class="comment">// Assume that is_even is a predicate that has been implemented elsewhere... +</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">target</span><span class="special">,</span> <span class="identifier">my_map</span> <span class="special">|</span> <span class="identifier">map_values</span> <span class="special">|</span> <span class="identifier">filtered</span><span class="special">(</span><span class="identifier">is_even</span><span class="special">())</span> <span class="special">|</span> <span class="identifier">reversed</span><span class="special">);</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concepts.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/library_headers.html b/libs/range/doc/html/range/library_headers.html new file mode 100644 index 0000000000..93a048f5d6 --- /dev/null +++ b/libs/range/doc/html/range/library_headers.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Library Headers</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="style_guide.html" title="Terminology and style guidelines"> +<link rel="next" href="library_headers/general.html" title="General"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="style_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="library_headers/general.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.library_headers"></a><a class="link" href="library_headers.html" title="Library Headers">Library Headers</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="library_headers/general.html">General</a></span></dt> +<dt><span class="section"><a href="library_headers/adaptors.html">Adaptors</a></span></dt> +<dt><span class="section"><a href="library_headers/algorithm.html">Algorithm</a></span></dt> +<dt><span class="section"><a href="library_headers/algorithm_extensions.html">Algorithm + Extensions</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="style_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="library_headers/general.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/library_headers/adaptors.html b/libs/range/doc/html/range/library_headers/adaptors.html new file mode 100644 index 0000000000..d6948ea0c4 --- /dev/null +++ b/libs/range/doc/html/range/library_headers/adaptors.html @@ -0,0 +1,232 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Adaptors</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../library_headers.html" title="Library Headers"> +<link rel="prev" href="general.html" title="General"> +<link rel="next" href="algorithm.html" title="Algorithm"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="general.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.library_headers.adaptors"></a><a class="link" href="adaptors.html" title="Adaptors">Adaptors</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">adjacent_filtered</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/adjacent_filtered.html" title="adjacent_filtered">adjacent_filtered</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">copied</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/copied.html" title="copied">copied</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">filtered</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/filtered.html" title="filtered">filtered</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">indexed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/indexed.html" title="indexed">indexed</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">indirected</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">.</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/indirected.html" title="indirected">indirected</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/map_keys.html" title="map_keys">map_keys</a> + <a class="link" href="../reference/adaptors/reference/map_values.html" title="map_values">map_values</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">replaced</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/replaced.html" title="replaced">replaced</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">replaced_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/replaced_if.html" title="replaced_if">replaced_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">reversed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/reversed.html" title="reversed">reversed</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">sliced</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/sliced.html" title="sliced">sliced</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">strided</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/strided.html" title="strided">strided</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">tokenized</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/tokenized.html" title="tokenized">tokenized</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">transformed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/transformed.html" title="transformed">transformed</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">uniqued</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/adaptors/reference/uniqued.html" title="uniqued">uniqued</a> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="general.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/library_headers/algorithm.html b/libs/range/doc/html/range/library_headers/algorithm.html new file mode 100644 index 0000000000..cab83e7a6a --- /dev/null +++ b/libs/range/doc/html/range/library_headers/algorithm.html @@ -0,0 +1,683 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Algorithm</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../library_headers.html" title="Library Headers"> +<link rel="prev" href="adaptors.html" title="Adaptors"> +<link rel="next" href="algorithm_extensions.html" title="Algorithm Extensions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adaptors.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm_extensions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.library_headers.algorithm"></a><a class="link" href="algorithm.html" title="Algorithm">Algorithm</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">adjacent_find</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/adjacent_find.html" title="adjacent_find">adjacent_find</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">binary_search</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/binary_search.html" title="binary_search">binary_search</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/copy.html" title="copy">copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy_backward</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/copy_backward.html" title="copy_backward">copy_backward</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">count</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/count.html" title="count">count</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">count_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/count_if.html" title="count_if">count_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">equal</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/equal.html" title="equal">equal</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">equal_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/equal_range.html" title="equal_range">equal_range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">fill</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/fill.html" title="fill">fill</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">fill_n</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/fill_n.html" title="fill_n">fill_n</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find.html" title="find">find</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_end</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find_end.html" title="find_end">find_end</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_first_of</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find_first_of.html" title="find_first_of">find_first_of</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/find_if.html" title="find_if">find_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/for_each.html" title="for_each">for_each</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">generate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/generate.html" title="generate">generate</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/heap/push_heap.html" title="push_heap">push_heap</a> + <a class="link" href="../reference/algorithms/heap/pop_heap.html" title="pop_heap">pop_heap</a> + <a class="link" href="../reference/algorithms/heap/make_heap.html" title="make_heap">make_heap</a> + <a class="link" href="../reference/algorithms/heap/sort_heap.html" title="sort_heap">sort_heap</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">inplace_merge</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/inplace_merge.html" title="inplace_merge">inplace_merge</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">lexicographical_compare</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/lexicographical_compare.html" title="lexicographical_compare">lexicographical_compare</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">lower_bound</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/lower_bound.html" title="lower_bound">lower_bound</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">max_element</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/max_element.html" title="max_element">max_element</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">merge</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/merge.html" title="merge">merge</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">min_element</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/min_element.html" title="min_element">min_element</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">mismatch</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/mismatch.html" title="mismatch">mismatch</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">nth_element</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/nth_element.html" title="nth_element">nth_element</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partial_sort</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/partial_sort.html" title="partial_sort">partial_sort</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partition</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/partition.html" title="partition">partition</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">permutation</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/permutation/next_permutation.html" title="next_permutation">next_permutation</a> + <a class="link" href="../reference/algorithms/permutation/prev_permutation.html" title="prev_permutation">prev_permutation</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">random_shuffle</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/random_shuffle.html" title="random_shuffle">random_shuffle</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove.html" title="remove">remove</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove_copy.html" title="remove_copy">remove_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_copy_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove_copy_if.html" title="remove_copy_if">remove_copy_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/remove_if.html" title="remove_if">remove_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace.html" title="replace">replace</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace_copy.html" title="replace_copy">replace_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_copy_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace_copy_if.html" title="replace_copy_if">replace_copy_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/replace_if.html" title="replace_if">replace_if</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">reverse</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/reverse.html" title="reverse">reverse</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">reverse_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/reverse_copy.html" title="reverse_copy">reverse_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">rotate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/rotate.html" title="rotate">rotate</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">rotate_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/rotate_copy.html" title="rotate_copy">rotate_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">search</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/search.html" title="search">search</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">search_n</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/search_n.html" title="search_n">search_n</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/set/includes.html" title="includes">includes</a> + <a class="link" href="../reference/algorithms/set/set_union.html" title="set_union">set_union</a> + <a class="link" href="../reference/algorithms/set/set_intersection.html" title="set_intersection">set_intersection</a> + <a class="link" href="../reference/algorithms/set/set_difference.html" title="set_difference">set_difference</a> + <a class="link" href="../reference/algorithms/set/set_symmetric_difference.html" title="set_symmetric_difference">set_symmetric_difference</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">sort</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/sort.html" title="sort">sort</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">stable_partition</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/stable_partition.html" title="stable_partition">stable_partition</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">swap_ranges</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/swap_ranges.html" title="swap_ranges">swap_ranges</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">transform</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/transform.html" title="transform">transform</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">unique</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/unique.html" title="unique">unique</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">unique_copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/mutating/unique_copy.html" title="unique_copy">unique_copy</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">upper_bound</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/non_mutating/upper_bound.html" title="upper_bound">upper_bound</a> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adaptors.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm_extensions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/library_headers/algorithm_extensions.html b/libs/range/doc/html/range/library_headers/algorithm_extensions.html new file mode 100644 index 0000000000..7a4db8f9ff --- /dev/null +++ b/libs/range/doc/html/range/library_headers/algorithm_extensions.html @@ -0,0 +1,172 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Algorithm Extensions</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../library_headers.html" title="Library Headers"> +<link rel="prev" href="algorithm.html" title="Algorithm"> +<link rel="next" href="../examples.html" title="Examples"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.library_headers.algorithm_extensions"></a><a class="link" href="algorithm_extensions.html" title="Algorithm Extensions">Algorithm + Extensions</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">copy_n</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/copy_n.html" title="copy_n">copy_n</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/erase.html" title="erase">erase</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/for_each.html" title="for_each">for_each</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">insert</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/insert.html" title="insert">insert</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">iota</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/iota.html" title="iota">iota</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">is_sorted</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/is_sorted.html" title="is_sorted">is_sorted</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">overwrite</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/overwrite.html" title="overwrite">overwrite</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">push_back</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/push_back.html" title="push_back">push_back</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">push_front</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/algorithms/new/push_front.html" title="push_front">push_front</a> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/library_headers/general.html b/libs/range/doc/html/range/library_headers/general.html new file mode 100644 index 0000000000..5996f99458 --- /dev/null +++ b/libs/range/doc/html/range/library_headers/general.html @@ -0,0 +1,551 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>General</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../library_headers.html" title="Library Headers"> +<link rel="prev" href="../library_headers.html" title="Library Headers"> +<link rel="next" href="adaptors.html" title="Adaptors"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../library_headers.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adaptors.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.library_headers.general"></a><a class="link" href="general.html" title="General">General</a> +</h3></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Header + </p> + </th> +<th> + <p> + Includes + </p> + </th> +<th> + <p> + Related Concept + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + everything from Boost.Range version 1 (Boost versions 1.42 and + below). Includes the core range functions and metafunctinos, but + excludes Range Adaptors and Range Algorithms. + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">metafunctions</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every metafunction + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">functions</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every function + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">value_type</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_value</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_iterator</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">difference_type</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_difference</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">pointer</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_pointer</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">category</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_category</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">reverse_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_reverse_iterator</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">begin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">begin</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_begin</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">end</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">end</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_end</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">empty</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">empty</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">distance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">distance</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">size</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">size</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">rbegin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">rbegin</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_rbegin</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">rend</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">rend</span></code></a> and <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_rend</span></code></a> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">as_array</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">as_array</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">as_literal</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">as_literal</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">iterator_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/utilities/iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">sub_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/utilities/sub_range.html" title="Class sub_range"><code class="computeroutput"><span class="identifier">sub_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">concepts</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts.html" title="Range Concepts">Range concepts</a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptors</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every range adaptor + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every range equivalent of an STL algorithm + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + every range algorithm that is an extension of the STL algorithms + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">counting_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/ranges/counting_range.html" title="counting_range"><code class="computeroutput"><span class="identifier">counting_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">istream_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/ranges/istream_range.html" title="istream_range"><code class="computeroutput"><span class="identifier">istream_range</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">irange</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/ranges/irange.html" title="irange"><code class="computeroutput"><span class="identifier">irange</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">join</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../reference/utilities/join.html" title="Function join"><code class="computeroutput"><span class="identifier">join</span></code></a> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../library_headers.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../library_headers.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adaptors.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/mfc_atl.html b/libs/range/doc/html/range/mfc_atl.html new file mode 100644 index 0000000000..2ca51fdf25 --- /dev/null +++ b/libs/range/doc/html/range/mfc_atl.html @@ -0,0 +1,141 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>MFC/ATL (courtesy of Shunsuke Sogame)</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="examples.html" title="Examples"> +<link rel="next" href="mfc_atl/requirements.html" title="Requirements"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="examples.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mfc_atl/requirements.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.mfc_atl"></a><a class="link" href="mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)">MFC/ATL (courtesy of Shunsuke Sogame)</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="mfc_atl/requirements.html">Requirements</a></span></dt> +<dt><span class="section"><a href="mfc_atl/mfc_ranges.html">MFC Ranges</a></span></dt> +<dt><span class="section"><a href="mfc_atl/atl_ranges.html">ATL Ranges</a></span></dt> +<dt><span class="section"><a href="mfc_atl/const_ranges.html">const Ranges</a></span></dt> +<dt><span class="section"><a href="mfc_atl/references.html">References</a></span></dt> +</dl></div> +<a name="range.mfc_atl.introduction"></a><h5> +<a name="id780286"></a> + <a class="link" href="mfc_atl.html#range.mfc_atl.introduction">Introduction</a> + </h5> +<p> + This implementation was kindly donated by Shunsuke Sogame. This header adapts + MFC and ATL containers to the appropriate Range concepts. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr></tr></thead> +<tbody> +<tr> +<td> + <p> + <span class="bold"><strong>Author:</strong></span> + </p> + </td> +<td> + <p> + Shunsuke Sogame + </p> + </td> +</tr> +<tr> +<td> + <p> + <span class="bold"><strong>Contact:</strong></span> + </p> + </td> +<td> + <p> + mb2act@yahoo.co.jp + </p> + </td> +</tr> +<tr> +<td> + <p> + <span class="bold"><strong>Date:</strong></span> + </p> + </td> +<td> + <p> + 26th of May 2006 + </p> + </td> +</tr> +<tr> +<td> + <p> + <span class="bold"><strong>Copyright:</strong></span> + </p> + </td> +<td> + <p> + Shunsuke Sogame 2005-2006. Use, modification and distribution is + subject to the Boost Software License, Version 1.0 + </p> + </td> +</tr> +</tbody> +</table></div> +<a name="range.mfc_atl.overview"></a><h5> +<a name="id780420"></a> + <a class="link" href="mfc_atl.html#range.mfc_atl.overview">Overview</a> + </h5> +<p> + Boost.Range MFC/ATL Extension provides Boost.Range support for MFC/ATL collection + and string types. + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">CTypedPtrArray</span><span class="special"><</span><span class="identifier">CPtrArray</span><span class="special">,</span> <span class="identifier">CList</span><span class="special"><</span><span class="identifier">CString</span><span class="special">></span> <span class="special">*></span> <span class="identifier">myArray</span><span class="special">;</span> +<span class="special">...</span> +<span class="identifier">BOOST_FOREACH</span> <span class="special">(</span><span class="identifier">CList</span><span class="special"><</span><span class="identifier">CString</span><span class="special">></span> <span class="special">*</span><span class="identifier">theList</span><span class="special">,</span> <span class="identifier">myArray</span><span class="special">)</span> +<span class="special">{</span> + <span class="identifier">BOOST_FOREACH</span> <span class="special">(</span><span class="identifier">CString</span><span class="special">&</span> <span class="identifier">str</span><span class="special">,</span> <span class="special">*</span><span class="identifier">theList</span><span class="special">)</span> + <span class="special">{</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">to_upper</span><span class="special">(</span><span class="identifier">str</span><span class="special">);</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">str</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">str</span><span class="special">));</span> + <span class="special">...</span> + <span class="special">}</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="examples.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mfc_atl/requirements.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/mfc_atl/atl_ranges.html b/libs/range/doc/html/range/mfc_atl/atl_ranges.html new file mode 100644 index 0000000000..aec5af5d1a --- /dev/null +++ b/libs/range/doc/html/range/mfc_atl/atl_ranges.html @@ -0,0 +1,374 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>ATL Ranges</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +<link rel="prev" href="mfc_ranges.html" title="MFC Ranges"> +<link rel="next" href="const_ranges.html" title="const Ranges"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mfc_ranges.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="const_ranges.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.mfc_atl.atl_ranges"></a><a class="link" href="atl_ranges.html" title="ATL Ranges">ATL Ranges</a> +</h3></div></div></div> +<p> + If the <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">atl</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + is included before or after Boost.Range headers, the ATL collections and + strings become models of Range. The table below lists the Traversal Category + and <code class="computeroutput"><span class="identifier">range_reference</span></code> of ATL + ranges. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Range + </p> + </th> +<th> + <p> + Traversal Category + </p> + </th> +<th> + <p> + <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CAtlArray</span><span class="special"><</span><span class="identifier">E</span><span class="special">,</span><span class="identifier">ET</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">E</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CAutoPtrArray</span><span class="special"><</span><span class="identifier">E</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">E</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CInterfaceArray</span><span class="special"><</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">pi</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">CComQIPtr</span><span class="special"><</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">pi</span><span class="special">>&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CAtlList</span><span class="special"><</span><span class="identifier">E</span><span class="special">,</span><span class="identifier">ET</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">E</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CAutoPtrList</span><span class="special"><</span><span class="identifier">E</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">E</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CHeapPtrList</span><span class="special"><</span><span class="identifier">E</span><span class="special">,</span><span class="identifier">A</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">E</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CInterfaceList</span><span class="special"><</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">pi</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">CComQIPtr</span><span class="special"><</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">pi</span><span class="special">>&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CAtlMap</span><span class="special"><</span><span class="identifier">K</span><span class="special">,</span><span class="identifier">V</span><span class="special">,</span><span class="identifier">KT</span><span class="special">,</span><span class="identifier">VT</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">Range</span><span class="special">::</span><span class="identifier">CPair</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CRBTree</span><span class="special"><</span><span class="identifier">K</span><span class="special">,</span><span class="identifier">V</span><span class="special">,</span><span class="identifier">KT</span><span class="special">,</span><span class="identifier">VT</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">Range</span><span class="special">::</span><span class="identifier">CPair</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CRBMap</span><span class="special"><</span><span class="identifier">K</span><span class="special">,</span><span class="identifier">V</span><span class="special">,</span><span class="identifier">KT</span><span class="special">,</span><span class="identifier">VT</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">Range</span><span class="special">::</span><span class="identifier">CPair</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CRBMultiMap</span><span class="special"><</span><span class="identifier">K</span><span class="special">,</span><span class="identifier">V</span><span class="special">,</span><span class="identifier">KT</span><span class="special">,</span><span class="identifier">VT</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">Range</span><span class="special">::</span><span class="identifier">CPair</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CSimpleStringT</span><span class="special"><</span><span class="identifier">B</span><span class="special">,</span><span class="identifier">b</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">B</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CStringT</span><span class="special"><</span><span class="identifier">B</span><span class="special">,</span><span class="identifier">ST</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">B</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CFixedStringT</span><span class="special"><</span><span class="identifier">S</span><span class="special">,</span><span class="identifier">n</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">S</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CComBSTR</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">OLECHAR</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CSimpleArray</span><span class="special"><</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">TE</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">T</span><span class="special">&</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + Other <a class="link" href="../../index.html" title="Chapter 1. Range 2.0">Boost.Range</a> metafunctions are defined + by the following. Let <code class="computeroutput"><span class="identifier">Range</span></code> + be any type listed above and <code class="computeroutput"><span class="identifier">Ref</span></code> + be the same as <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code>. + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">remove_reference</span><span class="special"><</span><span class="identifier">Ref</span><span class="special">>::</span><span class="identifier">type</span></code>, + <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span></code>, + and <code class="computeroutput"><span class="identifier">range_pointer</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">add_pointer</span><span class="special"><</span><span class="identifier">remove_reference</span><span class="special"><</span><span class="identifier">Ref</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code>. + As for <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">Range</span></code>, + see below. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mfc_ranges.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="const_ranges.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/mfc_atl/const_ranges.html b/libs/range/doc/html/range/mfc_atl/const_ranges.html new file mode 100644 index 0000000000..d833d8372e --- /dev/null +++ b/libs/range/doc/html/range/mfc_atl/const_ranges.html @@ -0,0 +1,125 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>const Ranges</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +<link rel="prev" href="atl_ranges.html" title="ATL Ranges"> +<link rel="next" href="references.html" title="References"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="atl_ranges.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="references.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.mfc_atl.const_ranges"></a><a class="link" href="const_ranges.html" title="const Ranges">const Ranges</a> +</h3></div></div></div> +<p> + <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + is defined by the following algorithm. Let <code class="computeroutput"><span class="identifier">Range</span></code> + be any type listed above and <code class="computeroutput"><span class="identifier">Ref</span></code> + be the same as <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code>. + </p> +<p> + +</p> +<pre class="programlisting"><span class="keyword">if</span> <span class="special">(</span><span class="identifier">Range</span> <span class="identifier">is</span> <span class="identifier">CObArray</span> <span class="special">||</span> <span class="identifier">Range</span> <span class="identifier">is</span> <span class="identifier">CObList</span><span class="special">)</span> + <span class="keyword">return</span> <span class="identifier">CObject</span> <span class="keyword">const</span> <span class="special">*</span> <span class="special">&</span> +<span class="keyword">else</span> <span class="keyword">if</span> <span class="special">(</span><span class="identifier">Range</span> <span class="identifier">is</span> <span class="identifier">CPtrArray</span> <span class="special">||</span> <span class="identifier">Range</span> <span class="identifier">is</span> <span class="identifier">CPtrList</span><span class="special">)</span> + <span class="keyword">return</span> <span class="keyword">void</span> <span class="keyword">const</span> <span class="special">*</span> <span class="special">&</span> +<span class="keyword">else</span> <span class="keyword">if</span> <span class="special">(</span><span class="identifier">there</span> <span class="identifier">is</span> <span class="identifier">a</span> <span class="identifier">type</span> <span class="identifier">X</span> <span class="identifier">such</span> <span class="identifier">that</span> <span class="identifier">X</span><span class="special">&</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">same</span> <span class="identifier">as</span> <span class="identifier">Ref</span><span class="special">)</span> + <span class="keyword">return</span> <span class="identifier">X</span> <span class="keyword">const</span> <span class="special">&</span> +<span class="keyword">else</span> <span class="keyword">if</span> <span class="special">(</span><span class="identifier">there</span> <span class="identifier">is</span> <span class="identifier">a</span> <span class="identifier">type</span> <span class="identifier">X</span> <span class="identifier">such</span> <span class="identifier">that</span> <span class="identifier">X</span><span class="special">*</span> <span class="keyword">const</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">same</span> <span class="identifier">as</span> <span class="identifier">Ref</span><span class="special">)</span> + <span class="keyword">return</span> <span class="identifier">X</span> <span class="keyword">const</span> <span class="special">*</span> <span class="keyword">const</span> +<span class="keyword">else</span> + <span class="keyword">return</span> <span class="identifier">Ref</span> +</pre> +<p> + </p> +<p> + Other Boost.Range metafunctions are defined by the following. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Range metafunction + </p> + </th> +<th> + <p> + Result + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_pointer</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">add_pointer</span><span class="special"><</span><span class="identifier">remove_reference</span><span class="special"><</span><span class="identifier">range_reference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="atl_ranges.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="references.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/mfc_atl/mfc_ranges.html b/libs/range/doc/html/range/mfc_atl/mfc_ranges.html new file mode 100644 index 0000000000..a757cf5e60 --- /dev/null +++ b/libs/range/doc/html/range/mfc_atl/mfc_ranges.html @@ -0,0 +1,480 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>MFC Ranges</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +<link rel="prev" href="requirements.html" title="Requirements"> +<link rel="next" href="atl_ranges.html" title="ATL Ranges"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requirements.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="atl_ranges.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.mfc_atl.mfc_ranges"></a><a class="link" href="mfc_ranges.html" title="MFC Ranges">MFC Ranges</a> +</h3></div></div></div> +<p> + If the <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">mfc</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + is included before or after Boost.Range headers, the MFC collections and + strings become models of Range. The table below lists the Traversal Category + and <code class="computeroutput"><span class="identifier">range_reference</span></code> of MFC + ranges. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Range + </p> + </th> +<th> + <p> + Traversal Category + </p> + </th> +<th> + <p> + <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CArray</span><span class="special"><</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">A</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">T</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CList</span><span class="special"><</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">A</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">T</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMap</span><span class="special"><</span><span class="identifier">K</span><span class="special">,</span><span class="identifier">AK</span><span class="special">,</span><span class="identifier">M</span><span class="special">,</span><span class="identifier">AM</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">Range</span><span class="special">::</span><span class="identifier">CPair</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CTypedPtrArray</span><span class="special"><</span><span class="identifier">B</span><span class="special">,</span><span class="identifier">T</span><span class="special">*></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">T</span><span class="special">*</span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CTypedPtrList</span><span class="special"><</span><span class="identifier">B</span><span class="special">,</span><span class="identifier">T</span><span class="special">*></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">T</span><span class="special">*</span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CTypedPtrMap</span><span class="special"><</span><span class="identifier">B</span><span class="special">,</span><span class="identifier">T</span><span class="special">*,</span><span class="identifier">V</span><span class="special">*></span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">*,</span><span class="identifier">V</span><span class="special">*></span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CByteArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">BYTE</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CDWordArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">DWORD</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CObArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">CObject</span><span class="special">*&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CPtrArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="keyword">void</span><span class="special">*&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CStringArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">CString</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CUIntArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">UINT</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CWordArray</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">WORD</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CObList</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">CObject</span><span class="special">*&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CPtrList</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="keyword">void</span><span class="special">*&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CStringList</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">CString</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMapPtrToWord</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="keyword">void</span><span class="special">*,</span><span class="identifier">WORD</span><span class="special">></span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMapPtrToPtr</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="keyword">void</span><span class="special">*,</span><span class="keyword">void</span><span class="special">*></span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMapStringToOb</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">String</span><span class="special">,</span><span class="identifier">CObject</span><span class="special">*></span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMapStringToString</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">Range</span><span class="special">::</span><span class="identifier">CPair</span><span class="special">&</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMapWordToOb</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">WORD</span><span class="special">,</span><span class="identifier">CObject</span><span class="special">*></span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">CMapWordToPtr</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">WORD</span><span class="special">,</span><span class="keyword">void</span><span class="special">*></span> + <span class="keyword">const</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + Other Boost.Range metafunctions are defined by the following. Let <code class="computeroutput"><span class="identifier">Range</span></code> be any type listed above and <code class="computeroutput"><span class="identifier">Ref</span></code> be the same as <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code>. + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">remove_reference</span><span class="special"><</span><span class="identifier">remove_const</span><span class="special"><</span><span class="identifier">Ref</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code>, + <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span></code>, + and <code class="computeroutput"><span class="identifier">range_pointer</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">add_pointer</span><span class="special"><</span><span class="identifier">remove_reference</span><span class="special"><</span><span class="identifier">Ref</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code>. + As for <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">Range</span></code>, + see below. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requirements.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="atl_ranges.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/mfc_atl/references.html b/libs/range/doc/html/range/mfc_atl/references.html new file mode 100644 index 0000000000..a09ba0a871 --- /dev/null +++ b/libs/range/doc/html/range/mfc_atl/references.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>References</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +<link rel="prev" href="const_ranges.html" title="const Ranges"> +<link rel="next" href="../upgrade.html" title="Upgrade version of Boost.Range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="const_ranges.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../upgrade.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.mfc_atl.references"></a><a class="link" href="references.html" title="References">References</a> +</h3></div></div></div> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <a class="link" href="../../index.html" title="Chapter 1. Range 2.0">Boost.Range</a> + </li> +<li class="listitem"> + <a href="http://msdn.microsoft.com/en-us/library/942860sh.aspx" target="_top">MFC + Collection Classes</a> + </li> +<li class="listitem"> + <a href="http://msdn.microsoft.com/en-us/library/15e672bd.aspx" target="_top">ATL + Collection Classes</a> + </li> +</ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="const_ranges.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../upgrade.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/mfc_atl/requirements.html b/libs/range/doc/html/range/mfc_atl/requirements.html new file mode 100644 index 0000000000..f171d85b9d --- /dev/null +++ b/libs/range/doc/html/range/mfc_atl/requirements.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Requirements</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +<link rel="prev" href="../mfc_atl.html" title="MFC/ATL (courtesy of Shunsuke Sogame)"> +<link rel="next" href="mfc_ranges.html" title="MFC Ranges"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mfc_ranges.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.mfc_atl.requirements"></a><a class="link" href="requirements.html" title="Requirements">Requirements</a> +</h3></div></div></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Boost C++ Libraries Version 1.34.0 or later (no compilation required) + </li> +<li class="listitem"> + Visual C++ 7.1 or later (for MFC and ATL) + </li> +</ul></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mfc_atl.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mfc_ranges.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/portability.html b/libs/range/doc/html/range/portability.html new file mode 100644 index 0000000000..8f242820a3 --- /dev/null +++ b/libs/range/doc/html/range/portability.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Portability</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="upgrade/upgrade_from_1_34.html" title="Upgrade from version 1.34"> +<link rel="next" href="faq.html" title="FAQ"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="upgrade/upgrade_from_1_34.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="faq.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.portability"></a><a class="link" href="portability.html" title="Portability">Portability</a> +</h2></div></div></div> +<p> + A huge effort has been made to port the library to as many compilers as possible. + </p> +<p> + Full support for built-in arrays require that the compiler supports class template + partial specialization. For non-conforming compilers there might be a chance + that it works anyway thanks to workarounds in the type traits library. Visual + C++ 6/7.0 has a limited support for arrays: as long as the arrays are of built-in + type it should work. + </p> +<p> + Notice also that some compilers cannot do function template ordering properly. + In that case one must rely of <a class="link" href="reference/concept_implementation/semantics/metafunctions.html" title="Metafunctions"><code class="computeroutput"><span class="identifier">range_iterator</span></code></a> and a single function + definition instead of overloaded versions for const and non-const arguments. + So if one cares about old compilers, one should not pass rvalues to the functions. + </p> +<p> + For maximum portability you should follow these guidelines: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + do not use built-in arrays, + </li> +<li class="listitem"> + do not pass rvalues to <a class="link" href="reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">begin</span></code></a><code class="computeroutput"><span class="special">()</span></code>, + <a class="link" href="reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">end</span></code></a><code class="computeroutput"><span class="special">()</span></code> + and <a class="link" href="reference/utilities/iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> Range constructors + and assignment operators, + </li> +<li class="listitem"> + use <a class="link" href="reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_begin</span></code></a><code class="computeroutput"><span class="special">()</span></code> + and <a class="link" href="reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">const_end</span></code></a><code class="computeroutput"><span class="special">()</span></code> + whenever your code by intention is read-only; this will also solve most + rvalue problems, + </li> +<li class="listitem"> +<p class="simpara"> + do not rely on ADL: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + if you overload functions, include that header before the headers in + this library, + </li> +<li class="listitem"> + put all overloads in namespace boost. + </li> +</ul></div> +</li> +</ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="upgrade/upgrade_from_1_34.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="faq.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference.html b/libs/range/doc/html/range/reference.html new file mode 100644 index 0000000000..50f6ed0e41 --- /dev/null +++ b/libs/range/doc/html/range/reference.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Reference</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="concepts/concept_checking.html" title="Concept Checking"> +<link rel="next" href="reference/overview.html" title="Overview"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="concepts/concept_checking.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/overview.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="reference/overview.html">Overview</a></span></dt> +<dt><span class="section"><a href="reference/concept_implementation.html">Range concept + implementation</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="reference/concept_implementation/synopsis.html">Synopsis</a></span></dt> +<dt><span class="section"><a href="reference/concept_implementation/semantics.html">Semantics</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="reference/adaptors.html">Range Adaptors</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="reference/adaptors/introduction.html">Introduction + and motivation</a></span></dt> +<dt><span class="section"><a href="reference/adaptors/general_requirements.html">General + Requirements</a></span></dt> +<dt><span class="section"><a href="reference/adaptors/reference.html">Reference</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="reference/algorithms.html">Range Algorithms</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="reference/algorithms/introduction.html">Introduction + and motivation</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/mutating.html">Mutating algorithms</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/non_mutating.html">Non-mutating + algorithms</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/set.html">Set algorithms</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/heap.html">Heap algorithms</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/permutation.html">Permutation + algorithms</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/new.html">New algorithms</a></span></dt> +<dt><span class="section"><a href="reference/algorithms/numeric.html">Numeric algorithms</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="reference/ranges.html">Provided Ranges</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="reference/ranges/any_range.html">any_range</a></span></dt> +<dt><span class="section"><a href="reference/ranges/counting_range.html">counting_range</a></span></dt> +<dt><span class="section"><a href="reference/ranges/istream_range.html">istream_range</a></span></dt> +<dt><span class="section"><a href="reference/ranges/irange.html">irange</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="reference/utilities.html">Utilities</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="reference/utilities/iterator_range.html">Class <code class="computeroutput"><span class="identifier">iterator_range</span></code></a></span></dt> +<dt><span class="section"><a href="reference/utilities/sub_range.html">Class <code class="computeroutput"><span class="identifier">sub_range</span></code></a></span></dt> +<dt><span class="section"><a href="reference/utilities/join.html">Function join</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="reference/extending.html">Extending the library</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="reference/extending/method_1.html">Method 1: provide + member functions and nested types</a></span></dt> +<dt><span class="section"><a href="reference/extending/method_2.html">Method 2: provide + free-standing functions and specialize metafunctions</a></span></dt> +<dt><span class="section"><a href="reference/extending/method_3.html">Method 3: provide + range adaptor implementations</a></span></dt> +</dl></dd> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="concepts/concept_checking.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/overview.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors.html b/libs/range/doc/html/range/reference/adaptors.html new file mode 100644 index 0000000000..004364e3b3 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Range Adaptors</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="concept_implementation/semantics/functions.html" title="Functions"> +<link rel="next" href="adaptors/introduction.html" title="Introduction and motivation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="concept_implementation/semantics/functions.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adaptors/introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.adaptors"></a><a class="link" href="adaptors.html" title="Range Adaptors">Range Adaptors</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="adaptors/introduction.html">Introduction + and motivation</a></span></dt> +<dt><span class="section"><a href="adaptors/general_requirements.html">General + Requirements</a></span></dt> +<dt><span class="section"><a href="adaptors/reference.html">Reference</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="concept_implementation/semantics/functions.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adaptors/introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/general_requirements.html b/libs/range/doc/html/range/reference/adaptors/general_requirements.html new file mode 100644 index 0000000000..8078038bb6 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/general_requirements.html @@ -0,0 +1,141 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>General Requirements</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../adaptors.html" title="Range Adaptors"> +<link rel="prev" href="introduction.html" title="Introduction and motivation"> +<link rel="next" href="reference.html" title="Reference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="introduction.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptors.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.adaptors.general_requirements"></a><a class="link" href="general_requirements.html" title="General Requirements">General + Requirements</a> +</h4></div></div></div> +<p> + In the description of generator expressions, the following notation is + used: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">fwdRng</span></code> is an expression + of a type <code class="computeroutput"><span class="identifier">R</span></code> that models + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">biRng</span></code> is an expression + of a type <code class="computeroutput"><span class="identifier">R</span></code> that models + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">rndRng</span></code> is an expression + of a type <code class="computeroutput"><span class="identifier">R</span></code> that models + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">pred</span></code> is an expression + of a type that models <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">bi_pred</span></code> is an expression + of a type that models <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">fun</span></code> is an expression + of a type that models <code class="computeroutput"><span class="identifier">UnaryFunction</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">value</span></code>, <code class="computeroutput"><span class="identifier">new_value</span></code> and <code class="computeroutput"><span class="identifier">old_value</span></code> + are objects convertible to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">n</span><span class="special">,</span><span class="identifier">m</span></code> are integer expressions convertible + to <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span></code> + </li> +</ul></div> +<p> + Also note that <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span></code> must be implicitly convertible to + the type arguments to <code class="computeroutput"><span class="identifier">pred</span></code>, + <code class="computeroutput"><span class="identifier">bi_pred</span></code> and <code class="computeroutput"><span class="identifier">fun</span></code>. + </p> +<p> + Range Category in the following adaptor descriptions refers to the minimum + range concept required by the range passed to the adaptor. The resultant + range is a model of the same range concept as the input range unless specified + otherwise. + </p> +<p> + Returned Range Category is the concept of the returned range. In some cases + the returned range is of a lesser category than the range passed to the + adaptor. For example, the <code class="computeroutput"><span class="identifier">filtered</span></code> + adaptor returns only a <code class="computeroutput"><span class="identifier">ForwardRange</span></code> + regardless of the input. + </p> +<p> + Furthermore, the following rules apply to any expression of the form +</p> +<pre class="programlisting"><span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">adaptor_generator</span> +</pre> +<p> + </p> +<p> + 1. Applying <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code> + to a range <code class="computeroutput"><span class="identifier">R</span></code> (always left + argument) and a range adapter <code class="computeroutput"><span class="identifier">RA</span></code> + (always right argument) yields a new range type which may not conform to + the same range concept as <code class="computeroutput"><span class="identifier">R</span></code>. + </p> +<p> + 2. The return-type of <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code> is otherwise unspecified. + </p> +<p> + 3. <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code> + is found by Argument Dependent Lookup (ADL) because a range adaptor is + implemented in namespace <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span></code>. + </p> +<p> + 4. <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code> + is used to add new behaviour <span class="emphasis"><em><span class="bold"><strong>lazily</strong></span></em></span> + and never modifies its left argument. + </p> +<p> + 5. All iterators extracted from the left argument are extracted using qualified + calls to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">()</span></code> + and <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">()</span></code>. + </p> +<p> + 6. In addition to the <code class="computeroutput"><span class="keyword">throw</span></code>-clauses + below, <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code> + may throw exceptions as a result of copying iterators. If such copying + cannot throw an exception, then neither can the whole expression. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="introduction.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptors.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/introduction.html b/libs/range/doc/html/range/reference/adaptors/introduction.html new file mode 100644 index 0000000000..49914997ac --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/introduction.html @@ -0,0 +1,284 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Introduction and motivation</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../adaptors.html" title="Range Adaptors"> +<link rel="prev" href="../adaptors.html" title="Range Adaptors"> +<link rel="next" href="general_requirements.html" title="General Requirements"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../adaptors.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptors.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="general_requirements.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.adaptors.introduction"></a><a class="link" href="introduction.html" title="Introduction and motivation">Introduction + and motivation</a> +</h4></div></div></div> +<p> + A <span class="bold"><strong>Range Adaptor</strong></span> is a class that wraps + an existing Range to provide a new Range with different behaviour. Since + the behaviour of Ranges is determined by their associated iterators, a + Range Adaptor simply wraps the underlying iterators with new special iterators. + In this example + </p> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptors</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> <span class="identifier">vec</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reversed</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">)</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + the iterators from <code class="computeroutput"><span class="identifier">vec</span></code> + are wrapped <code class="computeroutput"><span class="identifier">reverse_iterator</span></code>s. + The type of the underlying Range Adapter is not documented because you + do not need to know it. All that is relevant is that the expression + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">vec</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reversed</span> +</pre> +<p> + </p> +<p> + returns a Range Adaptor where the iterator type is now the iterator type + of the range <code class="computeroutput"><span class="identifier">vec</span></code> wrapped + in <code class="computeroutput"><span class="identifier">reverse_iterator</span></code>. The + expression <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reversed</span></code> is called an <span class="bold"><strong>Adaptor + Generator</strong></span>. + </p> +<p> + There are two ways of constructing a range adaptor. The first is by using + <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code>. + This is my preferred technique, however while discussing range adaptors + with others it became clear that some users of the library strongly prefer + a more familiar function syntax, so equivalent functions of the present + tense form have been added as an alternative syntax. The equivalent to + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">reversed</span></code> is <code class="computeroutput"><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reverse</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> for example. + </p> +<p> + Why do I prefer the <code class="computeroutput"><span class="keyword">operator</span><span class="special">|</span></code> syntax? The answer is readability: + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reverse</span><span class="special">(</span><span class="identifier">vec</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">)</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + This might not look so bad, but when we apply several adaptors, it becomes + much worse. Just compare + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reverse</span><span class="special">(</span> <span class="identifier">vec</span> <span class="special">)</span> <span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">)</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + to + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> <span class="identifier">vec</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reversed</span> + <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">uniqued</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">)</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + Furthermore, some of the adaptor generators take arguments themselves and + these arguments are expressed with function call notation too. In those + situations, you will really appreciate the succinctness of <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code>. + </p> +<a name="range.reference.adaptors.introduction.composition_of_adaptors"></a><h6> +<a name="id659630"></a> + <a class="link" href="introduction.html#range.reference.adaptors.introduction.composition_of_adaptors">Composition + of Adaptors</a> + </h6> +<p> + Range Adaptors are a powerful complement to Range algorithms. The reason + is that adaptors are <span class="emphasis"><em><span class="bold"><strong>orthogonal</strong></span></em></span> + to algorithms. For example, consider these Range algorithms: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">count</span><span class="special">(</span> + <span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">pred</span> <span class="special">)</span></code> + </li> +</ul></div> +<p> + What should we do if we only want to copy an element <code class="computeroutput"><span class="identifier">a</span></code> + if it satisfies some predicate, say <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>? + And what if we only want to count the elements that satisfy the same predicate? + The naive answer would be to use these algorithms: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy_if</span><span class="special">(</span> + <span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">pred</span><span class="special">,</span> + <span class="identifier">out</span> <span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">count_if</span><span class="special">(</span> + <span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">pred</span> <span class="special">)</span></code> + </li> +</ul></div> +<p> + These algorithms are only defined to maintain a one to one relationship + with the standard library algorithms. This approach of adding algorithm + suffers a combinatorial explosion. Inevitably many algorithms are missing + <code class="computeroutput"><span class="identifier">_if</span></code> variants and there + is redundant development overhead for each new algorithm. The Adaptor Generator + is the design solution to this problem. + </p> +<a name="range.reference.adaptors.introduction.range_adaptor_alternative_to_copy_if_algorithm"></a><h6> +<a name="id659939"></a> + <a class="link" href="introduction.html#range.reference.adaptors.introduction.range_adaptor_alternative_to_copy_if_algorithm">Range + Adaptor alternative to copy_if algorithm</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy_if</span><span class="special">(</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">pred</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">);</span> +</pre> +<p> + can be expressed as +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> <span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">filtered</span><span class="special">(</span><span class="identifier">pred</span><span class="special">),</span> <span class="identifier">out</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.adaptors.introduction.range_adaptor_alternative_to_count_if_algorithm"></a><h6> +<a name="id660104"></a> + <a class="link" href="introduction.html#range.reference.adaptors.introduction.range_adaptor_alternative_to_count_if_algorithm">Range + Adaptor alternative to count_if algorithm</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">count_if</span><span class="special">(</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">pred</span> <span class="special">);</span> +</pre> +<p> + can be expressed as +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">count</span><span class="special">(</span> <span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">filtered</span><span class="special">(</span><span class="identifier">pred</span><span class="special">),</span> <span class="identifier">out</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + What this means is that <span class="emphasis"><em><span class="bold"><strong>no</strong></span></em></span> + algorithm with the <code class="computeroutput"><span class="identifier">_if</span></code> + suffix is needed. Furthermore, it turns out that algorithms with the <code class="computeroutput"><span class="identifier">_copy</span></code> suffix are not needed either. Consider + the somewhat misdesigned <code class="computeroutput"><span class="identifier">replace_copy_if</span><span class="special">()</span></code> which may be used as + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">replace_copy_if</span><span class="special">(</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">vec</span><span class="special">),</span> <span class="identifier">pred</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + With adaptors and algorithms we can express this as + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">replaced_if</span><span class="special">(</span><span class="identifier">pred</span><span class="special">,</span> <span class="identifier">new_value</span><span class="special">));</span> +</pre> +<p> + </p> +<p> + The latter code has several benefits: + </p> +<p> + 1. it is more <span class="emphasis"><em><span class="bold"><strong>efficient</strong></span></em></span> + because we avoid extra allocations as might happen with <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span></code> + </p> +<p> + 2. it is <span class="emphasis"><em><span class="bold"><strong>flexible</strong></span></em></span> + as we can subsequently apply even more adaptors, for example: +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">replaced_if</span><span class="special">(</span><span class="identifier">pred</span><span class="special">,</span> <span class="identifier">new_value</span><span class="special">)</span> + <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reversed</span><span class="special">);</span> +</pre> +<p> + </p> +<p> + 3. it is <span class="emphasis"><em><span class="bold"><strong>safer</strong></span></em></span> because + there is no use of an unbounded output iterator. + </p> +<p> + In this manner, the <span class="emphasis"><em><span class="bold"><strong>composition</strong></span></em></span> + of Range Adaptors has the following consequences: + </p> +<p> + 1. we no longer need <code class="computeroutput"><span class="identifier">_if</span></code>, + <code class="computeroutput"><span class="identifier">_copy</span></code>, <code class="computeroutput"><span class="identifier">_copy_if</span></code> + and <code class="computeroutput"><span class="identifier">_n</span></code> variants of algorithms. + </p> +<p> + 2. we can generate a multitude of new algorithms on the fly, for example, + above we generated <code class="computeroutput"><span class="identifier">reverse_replace_copy_if</span><span class="special">()</span></code> + </p> +<p> + In other words: + </p> +<p> + <span class="bold"><strong>Range Adaptors are to algorithms what algorithms + are to containers</strong></span> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../adaptors.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptors.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="general_requirements.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference.html b/libs/range/doc/html/range/reference/adaptors/reference.html new file mode 100644 index 0000000000..4e5b99addd --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference.html @@ -0,0 +1,61 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Reference</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../adaptors.html" title="Range Adaptors"> +<link rel="prev" href="general_requirements.html" title="General Requirements"> +<link rel="next" href="reference/adjacent_filtered.html" title="adjacent_filtered"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="general_requirements.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptors.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/adjacent_filtered.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.adaptors.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="reference/adjacent_filtered.html">adjacent_filtered</a></span></dt> +<dt><span class="section"><a href="reference/copied.html">copied</a></span></dt> +<dt><span class="section"><a href="reference/filtered.html">filtered</a></span></dt> +<dt><span class="section"><a href="reference/indexed.html">indexed</a></span></dt> +<dt><span class="section"><a href="reference/indirected.html">indirected</a></span></dt> +<dt><span class="section"><a href="reference/map_keys.html">map_keys</a></span></dt> +<dt><span class="section"><a href="reference/map_values.html">map_values</a></span></dt> +<dt><span class="section"><a href="reference/replaced.html">replaced</a></span></dt> +<dt><span class="section"><a href="reference/replaced_if.html">replaced_if</a></span></dt> +<dt><span class="section"><a href="reference/reversed.html">reversed</a></span></dt> +<dt><span class="section"><a href="reference/sliced.html">sliced</a></span></dt> +<dt><span class="section"><a href="reference/strided.html">strided</a></span></dt> +<dt><span class="section"><a href="reference/type_erased.html">type_erased</a></span></dt> +<dt><span class="section"><a href="reference/tokenized.html">tokenized</a></span></dt> +<dt><span class="section"><a href="reference/transformed.html">transformed</a></span></dt> +<dt><span class="section"><a href="reference/uniqued.html">uniqued</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="general_requirements.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptors.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/adjacent_filtered.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/adjacent_filtered.html b/libs/range/doc/html/range/reference/adaptors/reference/adjacent_filtered.html new file mode 100644 index 0000000000..cce24714b8 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/adjacent_filtered.html @@ -0,0 +1,160 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>adjacent_filtered</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="../reference.html" title="Reference"> +<link rel="next" href="copied.html" title="copied"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../reference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="copied.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.adjacent_filtered"></a><a class="link" href="adjacent_filtered.html" title="adjacent_filtered">adjacent_filtered</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="adjacent_filtered.html#range.reference.adaptors.reference.adjacent_filtered.adjacent_filtered_example">adjacent_filtered + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">adjacent_filtered</span><span class="special">(</span><span class="identifier">bi_pred</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">adjacent_filter</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">bi_pred</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range is convertible + to both argument types of <code class="computeroutput"><span class="identifier">bi_pred</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all adjacent + elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> in the returned range, <code class="computeroutput"><span class="identifier">bi_pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Throws:</strong></span> Whatever the copy constructor + of <code class="computeroutput"><span class="identifier">bi_pred</span></code> might + throw. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adjacent_filtered_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The minimum + of the range category of <code class="computeroutput"><span class="identifier">rng</span></code> + and <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward Range</a> + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.adjacent_filtered.adjacent_filtered_example"></a><a class="link" href="adjacent_filtered.html#range.reference.adaptors.reference.adjacent_filtered.adjacent_filtered_example" title="adjacent_filtered example">adjacent_filtered + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">adjacent_filtered</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">functional</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">adjacent_filtered</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">not_equal_to</span><span class="special"><</span><span class="keyword">int</span><span class="special">>()),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../reference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="copied.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/copied.html b/libs/range/doc/html/range/reference/adaptors/reference/copied.html new file mode 100644 index 0000000000..500799934e --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/copied.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>copied</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="adjacent_filtered.html" title="adjacent_filtered"> +<link rel="next" href="filtered.html" title="filtered"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adjacent_filtered.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="filtered.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.copied"></a><a class="link" href="copied.html" title="copied">copied</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="copied.html#range.reference.adaptors.reference.copied.copied_example">copied + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">copied</span><span class="special">(</span><span class="identifier">n</span><span class="special">,</span> + <span class="identifier">m</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">n</span><span class="special">,</span> + <span class="identifier">m</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> <code class="computeroutput"><span class="number">0</span> + <span class="special"><=</span> <span class="identifier">n</span> + <span class="special">&&</span> <span class="identifier">n</span> + <span class="special"><=</span> <span class="identifier">m</span> + <span class="special">&&</span> <span class="identifier">m</span> + <span class="special"><</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> A new <code class="computeroutput"><span class="identifier">iterator_range</span></code> + that holds the sliced range <code class="computeroutput"><span class="special">[</span><span class="identifier">n</span><span class="special">,</span><span class="identifier">m</span><span class="special">)</span></code> + of the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.copied.copied_example"></a><a class="link" href="copied.html#range.reference.adaptors.reference.copied.copied_example" title="copied example">copied + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">copied</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">,</span><span class="number">10</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">copied</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">5</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adjacent_filtered.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="filtered.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/filtered.html b/libs/range/doc/html/range/reference/adaptors/reference/filtered.html new file mode 100644 index 0000000000..6fe2ce13aa --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/filtered.html @@ -0,0 +1,162 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>filtered</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="copied.html" title="copied"> +<link rel="next" href="indexed.html" title="indexed"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copied.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="indexed.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.filtered"></a><a class="link" href="filtered.html" title="filtered">filtered</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="filtered.html#range.reference.adaptors.reference.filtered.filtered_example">filtered + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">filtered</span><span class="special">(</span><span class="identifier">pred</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">filter</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">pred</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range is convertible + to the argument type of <code class="computeroutput"><span class="identifier">pred</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all adjacent + elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">]</span></code> in the returned range, <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Throws:</strong></span> Whatever the copy constructor + of <code class="computeroutput"><span class="identifier">pred</span></code> might throw. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">filtered_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The minimum + of the range category of <code class="computeroutput"><span class="identifier">rng</span></code> + and <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.filtered.filtered_example"></a><a class="link" href="filtered.html#range.reference.adaptors.reference.filtered.filtered_example" title="filtered example">filtered + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">filtered</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">struct</span> <span class="identifier">is_even</span> +<span class="special">{</span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">()(</span> <span class="keyword">int</span> <span class="identifier">x</span> <span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">x</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span> +<span class="special">};</span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">filtered</span><span class="special">(</span><span class="identifier">is_even</span><span class="special">()),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">2</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">8</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copied.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="indexed.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/indexed.html b/libs/range/doc/html/range/reference/adaptors/reference/indexed.html new file mode 100644 index 0000000000..1d2988704e --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/indexed.html @@ -0,0 +1,193 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>indexed</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="filtered.html" title="filtered"> +<link rel="next" href="indirected.html" title="indirected"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="filtered.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="indirected.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.indexed"></a><a class="link" href="indexed.html" title="indexed">indexed</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="indexed.html#range.reference.adaptors.reference.indexed.indexed_example">indexed + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">indexed</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">index</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> A range adapted to return + both the element and the associated index. The returned range consists + of iterators that have in addition to the usual iterator member functions + an <code class="computeroutput"><span class="identifier">index</span><span class="special">()</span></code> + member function that returns the appropriate index for the element + in the sequence corresponding with the iterator. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">indexed_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code> + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.indexed.indexed_example"></a><a class="link" href="indexed.html#range.reference.adaptors.reference.indexed.indexed_example" title="indexed example">indexed + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">indexed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">display_element_and_index</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">for</span> <span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">it</span> <span class="special">=</span> <span class="identifier">first</span><span class="special">;</span> <span class="identifier">it</span> <span class="special">!=</span> <span class="identifier">last</span><span class="special">;</span> <span class="special">++</span><span class="identifier">it</span><span class="special">)</span> + <span class="special">{</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Element = "</span> <span class="special"><<</span> <span class="special">*</span><span class="identifier">it</span> <span class="special"><<</span> <span class="string">" Index = "</span> <span class="special"><<</span> <span class="identifier">it</span><span class="special">.</span><span class="identifier">index</span><span class="special">()</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> + <span class="special">}</span> +<span class="special">}</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">display_element_and_index</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">)</span> +<span class="special">{</span> + <span class="identifier">display_element_and_index</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">));</span> +<span class="special">}</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Iterator2</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">check_element_and_index</span><span class="special">(</span> + <span class="identifier">Iterator1</span> <span class="identifier">test_first</span><span class="special">,</span> + <span class="identifier">Iterator1</span> <span class="identifier">test_last</span><span class="special">,</span> + <span class="identifier">Iterator2</span> <span class="identifier">reference_first</span><span class="special">,</span> + <span class="identifier">Iterator2</span> <span class="identifier">reference_last</span><span class="special">)</span> +<span class="special">{</span> + <span class="identifier">BOOST_CHECK_EQUAL</span><span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">test_first</span><span class="special">,</span> <span class="identifier">test_last</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">reference_first</span><span class="special">,</span> <span class="identifier">reference_last</span><span class="special">)</span> <span class="special">);</span> + + <span class="keyword">int</span> <span class="identifier">reference_index</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + + <span class="identifier">Iterator1</span> <span class="identifier">test_it</span> <span class="special">=</span> <span class="identifier">test_first</span><span class="special">;</span> + <span class="identifier">Iterator2</span> <span class="identifier">reference_it</span> <span class="special">=</span> <span class="identifier">reference_first</span><span class="special">;</span> + <span class="keyword">for</span> <span class="special">(;</span> <span class="identifier">test_it</span> <span class="special">!=</span> <span class="identifier">test_last</span><span class="special">;</span> <span class="special">++</span><span class="identifier">test_it</span><span class="special">,</span> <span class="special">++</span><span class="identifier">reference_it</span><span class="special">,</span> <span class="special">++</span><span class="identifier">reference_index</span><span class="special">)</span> + <span class="special">{</span> + <span class="identifier">BOOST_CHECK_EQUAL</span><span class="special">(</span> <span class="special">*</span><span class="identifier">test_it</span><span class="special">,</span> <span class="special">*</span><span class="identifier">reference_it</span> <span class="special">);</span> + <span class="identifier">BOOST_CHECK_EQUAL</span><span class="special">(</span> <span class="identifier">test_it</span><span class="special">.</span><span class="identifier">index</span><span class="special">(),</span> <span class="identifier">reference_index</span> <span class="special">);</span> + <span class="special">}</span> +<span class="special">}</span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">10</span><span class="special">,</span><span class="number">20</span><span class="special">,</span><span class="number">30</span><span class="special">,</span><span class="number">40</span><span class="special">,</span><span class="number">50</span><span class="special">,</span><span class="number">60</span><span class="special">,</span><span class="number">70</span><span class="special">,</span><span class="number">80</span><span class="special">,</span><span class="number">90</span><span class="special">;</span> + + <span class="identifier">display_element_and_index</span><span class="special">(</span> <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">indexed</span><span class="special">(</span><span class="number">0</span><span class="special">)</span> <span class="special">);</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="identifier">Element</span> <span class="special">=</span> <span class="number">10</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">0</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">20</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">1</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">30</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">2</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">40</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">3</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">50</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">4</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">60</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">5</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">70</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">6</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">80</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">7</span> +<span class="identifier">Element</span> <span class="special">=</span> <span class="number">90</span> <span class="identifier">Index</span> <span class="special">=</span> <span class="number">8</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="filtered.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="indirected.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/indirected.html b/libs/range/doc/html/range/reference/adaptors/reference/indirected.html new file mode 100644 index 0000000000..e990d1e26a --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/indirected.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>indirected</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="indexed.html" title="indexed"> +<link rel="next" href="map_keys.html" title="map_keys"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="indexed.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="map_keys.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.indirected"></a><a class="link" href="indirected.html" title="indirected">indirected</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="indirected.html#range.reference.adaptors.reference.indirected.indirected_example">indirected + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">indirected</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">indirect</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range defines + unary <code class="computeroutput"><span class="keyword">operator</span><span class="special">*()</span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all elements + <code class="computeroutput"><span class="identifier">x</span></code> in the returned + range, <code class="computeroutput"><span class="identifier">x</span></code> is the result + of <code class="computeroutput"><span class="special">*</span><span class="identifier">y</span></code> + where <code class="computeroutput"><span class="identifier">y</span></code> is the corresponding + element in the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">indirected_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code> + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.indirected.indirected_example"></a><a class="link" href="indirected.html#range.reference.adaptors.reference.indirected.indirected_example" title="indirected example">indirected + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">indirected</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">shared_ptr</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">++</span><span class="identifier">i</span><span class="special">)</span> + <span class="identifier">input</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="keyword">new</span> <span class="keyword">int</span><span class="special">(</span><span class="identifier">i</span><span class="special">)));</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">indirected</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="indexed.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="map_keys.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/map_keys.html b/libs/range/doc/html/range/reference/adaptors/reference/map_keys.html new file mode 100644 index 0000000000..3120f2f504 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/map_keys.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>map_keys</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="indirected.html" title="indirected"> +<link rel="next" href="map_values.html" title="map_values"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="indirected.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="map_values.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.map_keys"></a><a class="link" href="map_keys.html" title="map_keys">map_keys</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="map_keys.html#range.reference.adaptors.reference.map_keys.map_keys_example">map_keys + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">map_keys</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">keys</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range is an instantiation + of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all elements + <code class="computeroutput"><span class="identifier">x</span></code> in the returned + range, <code class="computeroutput"><span class="identifier">x</span></code> is the result + of <code class="computeroutput"><span class="identifier">y</span><span class="special">.</span><span class="identifier">first</span></code> where <code class="computeroutput"><span class="identifier">y</span></code> + is the corresponding element in the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">select_first_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.map_keys.map_keys_example"></a><a class="link" href="map_keys.html#range.reference.adaptors.reference.map_keys.map_keys_example" title="map_keys example">map_keys + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">map</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">++</span><span class="identifier">i</span><span class="special">)</span> + <span class="identifier">input</span><span class="special">.</span><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">make_pair</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">i</span> <span class="special">*</span> <span class="number">10</span><span class="special">));</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">map_keys</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="indirected.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="map_values.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/map_values.html b/libs/range/doc/html/range/reference/adaptors/reference/map_values.html new file mode 100644 index 0000000000..30ff247226 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/map_values.html @@ -0,0 +1,158 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>map_values</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="map_keys.html" title="map_keys"> +<link rel="next" href="replaced.html" title="replaced"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="map_keys.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replaced.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.map_values"></a><a class="link" href="map_values.html" title="map_values">map_values</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="map_values.html#range.reference.adaptors.reference.map_values.map_values_example">map_values + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">map_values</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">values</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range is an instantiation + of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all elements + <code class="computeroutput"><span class="identifier">x</span></code> in the returned + range, <code class="computeroutput"><span class="identifier">x</span></code> is the result + of <code class="computeroutput"><span class="identifier">y</span><span class="special">.</span><span class="identifier">second</span></code> where <code class="computeroutput"><span class="identifier">y</span></code> + is the corresponding element in the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> for constant + ranges, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">select_second_const</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + otherwise <code class="computeroutput"><span class="identifier">boost</span><span class="special">:</span><span class="identifier">select_second_mutable</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.map_values.map_values_example"></a><a class="link" href="map_values.html#range.reference.adaptors.reference.map_values.map_values_example" title="map_values example">map_values + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">map</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="keyword">for</span> <span class="special">(</span><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">++</span><span class="identifier">i</span><span class="special">)</span> + <span class="identifier">input</span><span class="special">.</span><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">make_pair</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">i</span> <span class="special">*</span> <span class="number">10</span><span class="special">));</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">map_values</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">0</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">20</span><span class="special">,</span><span class="number">30</span><span class="special">,</span><span class="number">40</span><span class="special">,</span><span class="number">50</span><span class="special">,</span><span class="number">60</span><span class="special">,</span><span class="number">70</span><span class="special">,</span><span class="number">80</span><span class="special">,</span><span class="number">90</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="map_keys.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replaced.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/replaced.html b/libs/range/doc/html/range/reference/adaptors/reference/replaced.html new file mode 100644 index 0000000000..398258c039 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/replaced.html @@ -0,0 +1,174 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>replaced</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="map_values.html" title="map_values"> +<link rel="next" href="replaced_if.html" title="replaced_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="map_values.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replaced_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.replaced"></a><a class="link" href="replaced.html" title="replaced">replaced</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="replaced.html#range.reference.adaptors.reference.replaced.replaced_example">replaced + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">replaced</span><span class="special">(</span><span class="identifier">new_value</span><span class="special">,</span> + <span class="identifier">old_value</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">replace</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">new_value</span><span class="special">,</span> + <span class="identifier">old_value</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<p class="simpara"> + <span class="bold"><strong>Precondition:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">new_value</span></code> is + convertible to the <code class="computeroutput"><span class="identifier">value_type</span></code> + of the range. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">old_value</span></code> is + convertible to the <code class="computeroutput"><span class="identifier">value_type</span></code> + of the range. + </li> +</ul></div> +</li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all elements + <code class="computeroutput"><span class="identifier">x</span></code> in the returned + range, the value <code class="computeroutput"><span class="identifier">x</span></code> + is equal to the value of <code class="computeroutput"><span class="special">(</span><span class="identifier">y</span> <span class="special">==</span> + <span class="identifier">old_value</span><span class="special">)</span> + <span class="special">?</span> <span class="identifier">new_value</span> + <span class="special">:</span> <span class="identifier">y</span></code> + where <code class="computeroutput"><span class="identifier">y</span></code> is the corresponding + element in the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">replaced_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.replaced.replaced_example"></a><a class="link" href="replaced.html#range.reference.adaptors.reference.replaced.replaced_example" title="replaced example">replaced + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">replaced</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">9</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">replaced</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">10</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">9</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="map_values.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replaced_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/replaced_if.html b/libs/range/doc/html/range/reference/adaptors/reference/replaced_if.html new file mode 100644 index 0000000000..e259a8434a --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/replaced_if.html @@ -0,0 +1,175 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>replaced_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="replaced.html" title="replaced"> +<link rel="next" href="reversed.html" title="reversed"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replaced.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reversed.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.replaced_if"></a><a class="link" href="replaced_if.html" title="replaced_if">replaced_if</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="replaced_if.html#range.reference.adaptors.reference.replaced_if.replaced_if_example">replaced_if + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">replaced_if</span><span class="special">(</span><span class="identifier">pred</span><span class="special">,</span> + <span class="identifier">new_value</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">replace_if</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">pred</span><span class="special">,</span> + <span class="identifier">new_value</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<p class="simpara"> + <span class="bold"><strong>Precondition:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + The range <code class="computeroutput"><span class="identifier">value_type</span></code> + is convertible to the argument type of <code class="computeroutput"><span class="identifier">pred</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">new_value</span></code> is + convertible to the <code class="computeroutput"><span class="identifier">value_type</span></code> + of the range. + </li> +</ul></div> +</li> +<li class="listitem"> + <span class="bold"><strong>Postconditions:</strong></span> For all elements + <code class="computeroutput"><span class="identifier">x</span></code> in the returned + range, the value <code class="computeroutput"><span class="identifier">x</span></code> + is equal to the value of <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">)</span> <span class="special">?</span> <span class="identifier">new_value</span> <span class="special">:</span> + <span class="identifier">y</span></code> where <code class="computeroutput"><span class="identifier">y</span></code> + is the corresponding element in the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">replaced_if_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.replaced_if.replaced_if_example"></a><a class="link" href="replaced_if.html#range.reference.adaptors.reference.replaced_if.replaced_if_example" title="replaced_if example">replaced_if + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">replaced_if</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">struct</span> <span class="identifier">is_even</span> +<span class="special">{</span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">()(</span><span class="keyword">int</span> <span class="identifier">x</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">x</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span> +<span class="special">};</span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">replaced_if</span><span class="special">(</span><span class="identifier">is_even</span><span class="special">(),</span> <span class="number">10</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">9</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replaced.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reversed.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/reversed.html b/libs/range/doc/html/range/reference/adaptors/reference/reversed.html new file mode 100644 index 0000000000..efdf11ffbc --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/reversed.html @@ -0,0 +1,147 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>reversed</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="replaced_if.html" title="replaced_if"> +<link rel="next" href="sliced.html" title="sliced"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replaced_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sliced.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.reversed"></a><a class="link" href="reversed.html" title="reversed">reversed</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="reversed.html#range.reference.adaptors.reference.reversed.reversed_example">reversed + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reversed</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">reverse</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> A range whose iterators + behave as if they were the original iterators wrapped in <code class="computeroutput"><span class="identifier">reverse_iterator</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">reversed_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.reversed.reversed_example"></a><a class="link" href="reversed.html#range.reference.adaptors.reference.reversed.reversed_example" title="reversed example">reversed + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">reversed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">void</span> <span class="identifier">reversed_example_test</span><span class="special">()</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">reversed</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">9</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">1</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replaced_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sliced.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/sliced.html b/libs/range/doc/html/range/reference/adaptors/reference/sliced.html new file mode 100644 index 0000000000..ea0b736cef --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/sliced.html @@ -0,0 +1,157 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>sliced</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="reversed.html" title="reversed"> +<link rel="next" href="strided.html" title="strided"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reversed.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strided.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.sliced"></a><a class="link" href="sliced.html" title="sliced">sliced</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="sliced.html#range.reference.adaptors.reference.sliced.sliced_example">sliced + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">sliced</span><span class="special">(</span><span class="identifier">n</span><span class="special">,</span> + <span class="identifier">m</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">slice</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">n</span><span class="special">,</span> + <span class="identifier">m</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> <code class="computeroutput"><span class="number">0</span> + <span class="special"><=</span> <span class="identifier">n</span> + <span class="special">&&</span> <span class="identifier">n</span> + <span class="special"><=</span> <span class="identifier">m</span> + <span class="special">&&</span> <span class="identifier">m</span> + <span class="special"><</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="identifier">make_range</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">n</span><span class="special">,</span> <span class="identifier">m</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sliced_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.sliced.sliced_example"></a><a class="link" href="sliced.html#range.reference.adaptors.reference.sliced.sliced_example" title="sliced example">sliced + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">sliced</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">sliced</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">5</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reversed.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strided.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/strided.html b/libs/range/doc/html/range/reference/adaptors/reference/strided.html new file mode 100644 index 0000000000..592b83ef42 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/strided.html @@ -0,0 +1,149 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>strided</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="sliced.html" title="sliced"> +<link rel="next" href="type_erased.html" title="type_erased"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="sliced.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="type_erased.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.strided"></a><a class="link" href="strided.html" title="strided">strided</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="strided.html#range.reference.adaptors.reference.strided.strided_example">strided + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">strided</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">stride</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">n</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> <code class="computeroutput"><span class="number">0</span> + <span class="special"><=</span> <span class="identifier">n</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> A new range based on <code class="computeroutput"><span class="identifier">rng</span></code> where traversal is performed + in steps of <code class="computeroutput"><span class="identifier">n</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.strided.strided_example"></a><a class="link" href="strided.html#range.reference.adaptors.reference.strided.strided_example" title="strided example">strided + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">strided</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">,</span><span class="number">10</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">strided</span><span class="special">(</span><span class="number">2</span><span class="special">),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">9</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="sliced.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="type_erased.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/tokenized.html b/libs/range/doc/html/range/reference/adaptors/reference/tokenized.html new file mode 100644 index 0000000000..2dfa5063a9 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/tokenized.html @@ -0,0 +1,155 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>tokenized</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="type_erased.html" title="type_erased"> +<link rel="next" href="transformed.html" title="transformed"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="type_erased.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="transformed.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.tokenized"></a><a class="link" href="tokenized.html" title="tokenized">tokenized</a> +</h5></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenized</span><span class="special">(</span><span class="identifier">regex</span><span class="special">)</span> +<span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenized</span><span class="special">(</span><span class="identifier">regex</span><span class="special">,</span> <span class="identifier">i</span><span class="special">)</span> +<span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenized</span><span class="special">(</span><span class="identifier">regex</span><span class="special">,</span> <span class="identifier">rndRng</span><span class="special">)</span> +<span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenized</span><span class="special">(</span><span class="identifier">regex</span><span class="special">,</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">flags</span><span class="special">)</span> +<span class="identifier">rng</span> <span class="special">|</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenized</span><span class="special">(</span><span class="identifier">regex</span><span class="special">,</span> <span class="identifier">rndRng</span><span class="special">,</span> <span class="identifier">flags</span><span class="special">)</span> +</pre> +<p> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenize</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">regex</span><span class="special">)</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenize</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">regex</span><span class="special">,</span> <span class="identifier">i</span><span class="special">)</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenize</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">regex</span><span class="special">,</span> <span class="identifier">rndRng</span><span class="special">)</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenize</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">regex</span><span class="special">,</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">flags</span><span class="special">)</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">tokenize</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">regex</span><span class="special">,</span> <span class="identifier">rndRng</span><span class="special">,</span> <span class="identifier">flags</span><span class="special">)</span> +</pre> +<p> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<p class="simpara"> + <span class="bold"><strong>Precondition:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + Let <code class="computeroutput"><span class="identifier">T</span></code> denote + <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">range_value</span><span class="special"><</span><span class="identifier">decltype</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)>::</span><span class="identifier">type</span></code>, + then <code class="computeroutput"><span class="identifier">regex</span></code> has + the type <code class="computeroutput"><span class="identifier">basic_regex</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code> or is implicitly convertible + to one of these types. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">i</span></code> has the type + <code class="computeroutput"><span class="keyword">int</span></code>. + </li> +<li class="listitem"> + the <code class="computeroutput"><span class="identifier">value_type</span></code> + of <code class="computeroutput"><span class="identifier">rndRng</span></code> is + <code class="computeroutput"><span class="keyword">int</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">flags</span></code> has the + type <code class="computeroutput"><span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">syntax_option_type</span></code>. + </li> +</ul></div> +</li> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> A range whose iterators + behave as if they were the original iterators wrapped in <code class="computeroutput"><span class="identifier">regex_token_iterator</span></code>. The first + iterator in the range would be constructed by forwarding all the + arguments of <code class="computeroutput"><span class="identifier">tokenized</span><span class="special">()</span></code> to the <code class="computeroutput"><span class="identifier">regex_token_iterator</span></code> + constructor. + </li> +<li class="listitem"> + <span class="bold"><strong>Throws:</strong></span> Whatever constructing and + copying equivalent <code class="computeroutput"><span class="identifier">regex_token_iterator</span></code>s + might throw. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tokenized_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> + </li> +</ul></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="type_erased.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="transformed.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/transformed.html b/libs/range/doc/html/range/reference/adaptors/reference/transformed.html new file mode 100644 index 0000000000..97200e9044 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/transformed.html @@ -0,0 +1,166 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>transformed</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="tokenized.html" title="tokenized"> +<link rel="next" href="uniqued.html" title="uniqued"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="tokenized.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="uniqued.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.transformed"></a><a class="link" href="transformed.html" title="transformed">transformed</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="transformed.html#range.reference.adaptors.reference.transformed.transformed_example">transformed + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">transformed</span><span class="special">(</span><span class="identifier">fun</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">transform</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">fun</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range is convertible + to the argument type of <code class="computeroutput"><span class="identifier">fun</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all elements + <code class="computeroutput"><span class="identifier">x</span></code> in the returned + range, <code class="computeroutput"><span class="identifier">x</span></code> is the result + of <code class="computeroutput"><span class="identifier">fun</span><span class="special">(</span><span class="identifier">y</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">y</span></code> is the corresponding + element in the original range. + </li> +<li class="listitem"> + <span class="bold"><strong>Throws:</strong></span> Whatever the copy-constructor + of <code class="computeroutput"><span class="identifier">fun</span></code> might throw. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">transformed_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The range + category of <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.transformed.transformed_example"></a><a class="link" href="transformed.html#range.reference.adaptors.reference.transformed.transformed_example" title="transformed example">transformed + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">transformed</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">struct</span> <span class="identifier">double_int</span> +<span class="special">{</span> + <span class="keyword">typedef</span> <span class="keyword">int</span> <span class="identifier">result_type</span><span class="special">;</span> + <span class="keyword">int</span> <span class="keyword">operator</span><span class="special">()(</span><span class="keyword">int</span> <span class="identifier">x</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">x</span> <span class="special">*</span> <span class="number">2</span><span class="special">;</span> <span class="special">}</span> +<span class="special">};</span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">,</span><span class="number">10</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">transformed</span><span class="special">(</span><span class="identifier">double_int</span><span class="special">()),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">2</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">10</span><span class="special">,</span><span class="number">12</span><span class="special">,</span><span class="number">14</span><span class="special">,</span><span class="number">16</span><span class="special">,</span><span class="number">18</span><span class="special">,</span><span class="number">20</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="tokenized.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="uniqued.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/type_erased.html b/libs/range/doc/html/range/reference/adaptors/reference/type_erased.html new file mode 100644 index 0000000000..87649ee336 --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/type_erased.html @@ -0,0 +1,305 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>type_erased</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="strided.html" title="strided"> +<link rel="next" href="tokenized.html" title="tokenized"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="strided.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tokenized.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.type_erased"></a><a class="link" href="type_erased.html" title="type_erased">type_erased</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="type_erased.html#range.reference.adaptors.reference.type_erased.type_erased_example">type-erased + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">type_erased</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> + <span class="identifier">Traversal</span><span class="special">,</span> + <span class="identifier">Reference</span><span class="special">,</span> + <span class="identifier">Difference</span><span class="special">,</span> + <span class="identifier">Buffer</span><span class="special">>()</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">type_erase</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">type_erased</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> + <span class="identifier">Traversal</span><span class="special">,</span> + <span class="identifier">Reference</span><span class="special">,</span> + <span class="identifier">Difference</span><span class="special">,</span> + <span class="identifier">Buffer</span><span class="special">>)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + Please note that it is frequently unnecessary to use the <code class="computeroutput"><span class="identifier">type_erased</span></code> adaptor. It is often better + to use the implicit conversion to <code class="computeroutput"><span class="identifier">any_range</span></code>. + </p> +<p> + Let <code class="computeroutput"><span class="identifier">Rng</span></code> be the type of + <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<p class="simpara"> + <span class="bold"><strong>Template parameters:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is the + <code class="computeroutput"><span class="identifier">value_type</span></code> for + the <code class="computeroutput"><span class="identifier">any_range</span></code>. + If this is set to boost::use_default, <code class="computeroutput"><span class="identifier">Value</span></code> + will be calculated from the range type when the adaptor is applied. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Traversal</span></code> is + the tag used to identify the traversal of the resultant range. + Frequently it is desireable to set a traversal category lower + than the source container or range to maximize the number of + ranges that can convert to the <code class="computeroutput"><span class="identifier">any_range</span></code>. + If this is left as boost::use_default then <code class="computeroutput"><span class="identifier">Traversal</span></code> + will be <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_traversal</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">Rng</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Reference</span></code> is + the <code class="computeroutput"><span class="identifier">reference</span></code> + for the <code class="computeroutput"><span class="identifier">any_range</span></code>. + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">use_default</span></code> will equate to + <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">Rng</span><span class="special">>::</span><span class="identifier">type</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Difference</span></code> is + the <code class="computeroutput"><span class="identifier">difference_type</span></code> + for the any_range. <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">use_default</span></code> + will equate to <code class="computeroutput"><span class="keyword">typename</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Rng</span><span class="special">>::</span><span class="identifier">type</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Buffer</span></code> is the + storage used to allocate the underlying iterator wrappers. This + can typically be ignored, but is available as a template parameter + for customization. Buffer must be a model of the <code class="computeroutput"><span class="identifier">AnyIteratorBufferConcept</span></code>. + </li> +</ul></div> +</li> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> <code class="computeroutput"><span class="identifier">Traversal</span></code> + is one of <code class="computeroutput"><span class="special">{</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">use_default</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">single_pass_traversal_tag</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">forward_traversal_tag</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bidirectional_traversal_tag</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">random_access_traversal_tag</span> + <span class="special">}</span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returns:</strong></span> The returned value is the + same as <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">any_range_type_generator</span><span class="special"><</span> <span class="identifier">Rng</span><span class="special">,</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Traversal</span><span class="special">,</span> <span class="identifier">Reference</span><span class="special">,</span> <span class="identifier">Difference</span><span class="special">,</span> <span class="identifier">Buffer</span> + <span class="special">></span></code> that represents <code class="computeroutput"><span class="identifier">rng</span></code> in a type-erased manner. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> if <code class="computeroutput"><span class="identifier">Traversal</span></code> was specified as <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">use_default</span></code> then <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_traversal</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">Rng</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code>, + otherwise <code class="computeroutput"><span class="identifier">Traversal</span></code>. + </li> +</ul></div> +<a name="range.reference.adaptors.reference.type_erased.anyiteratorbufferconcept"></a><h6> +<a name="id677095"></a> + <a class="link" href="type_erased.html#range.reference.adaptors.reference.type_erased.anyiteratorbufferconcept">AnyIteratorBufferConcept</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">AnyIteratorBufferConcept</span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="identifier">AnyIteratorBufferConcept</span><span class="special">();</span> + <span class="special">~</span><span class="identifier">AnyIteratorBufferConcept</span><span class="special">();</span> + + <span class="comment">// bytes is the requested size to allocate. This function +</span> <span class="comment">// must return a pointer to an adequate area of memory. +</span> <span class="comment">// throws: bad_alloc +</span> <span class="comment">// +</span> <span class="comment">// The buffer will only ever have zero or one +</span> <span class="comment">// outstanding memory allocations. +</span> <span class="keyword">void</span><span class="special">*</span> <span class="identifier">allocate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes</span><span class="special">);</span> + + <span class="comment">// deallocate this buffer +</span> <span class="keyword">void</span> <span class="identifier">deallocate</span><span class="special">();</span> +<span class="special">};</span> +</pre> +<p> + </p> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.type_erased.type_erased_example"></a><a class="link" href="type_erased.html#range.reference.adaptors.reference.type_erased.type_erased_example" title="type-erased example">type-erased + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">type_erased</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">foreach</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">list</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="comment">// The client interface from an OO perspective merely requires a sequence +</span><span class="comment">// of integers that can be forward traversed +</span><span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any_range</span><span class="special"><</span> + <span class="keyword">int</span> + <span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">forward_traversal_tag</span> + <span class="special">,</span> <span class="keyword">int</span> + <span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> +<span class="special">></span> <span class="identifier">integer_range</span><span class="special">;</span> + +<span class="keyword">namespace</span> <span class="identifier">server</span> +<span class="special">{</span> + <span class="keyword">void</span> <span class="identifier">display_integers</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">integer_range</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">)</span> + <span class="special">{</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> + <span class="special">}</span> +<span class="special">}</span> + +<span class="keyword">namespace</span> <span class="identifier">client</span> +<span class="special">{</span> + <span class="keyword">void</span> <span class="identifier">run</span><span class="special">()</span> + <span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="comment">// Under most conditions one would simply use an appropriate +</span> <span class="comment">// any_range as a function parameter. The type_erased adaptor +</span> <span class="comment">// is often superfluous. However because the type_erased +</span> <span class="comment">// adaptor is applied to a range, we can use default template +</span> <span class="comment">// arguments that are generated in conjunction with the +</span> <span class="comment">// range type to which we are applying the adaptor. +</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">;</span> + + <span class="comment">// Note that this call is to a non-template function +</span> <span class="identifier">server</span><span class="special">::</span><span class="identifier">display_integers</span><span class="special">(</span><span class="identifier">input</span><span class="special">);</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">list</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input2</span><span class="special">;</span> + <span class="identifier">input2</span> <span class="special">+=</span> <span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">,</span><span class="number">10</span><span class="special">;</span> + + <span class="comment">// Note that this call is to the same non-tempate function +</span> <span class="identifier">server</span><span class="special">::</span><span class="identifier">display_integers</span><span class="special">(</span><span class="identifier">input2</span><span class="special">);</span> + + <span class="identifier">input2</span><span class="special">.</span><span class="identifier">clear</span><span class="special">();</span> + <span class="identifier">input2</span> <span class="special">+=</span> <span class="number">11</span><span class="special">,</span><span class="number">12</span><span class="special">,</span><span class="number">13</span><span class="special">,</span><span class="number">14</span><span class="special">,</span><span class="number">15</span><span class="special">;</span> + + <span class="comment">// Calling using the adaptor looks like this: +</span> <span class="comment">// Notice that here I have a type_erased that would be a +</span> <span class="comment">// bidirectional_traversal_tag, but this is convertible +</span> <span class="comment">// to the forward_traversal_tag equivalent hence this +</span> <span class="comment">// works. +</span> <span class="identifier">server</span><span class="special">::</span><span class="identifier">display_integers</span><span class="special">(</span><span class="identifier">input2</span> <span class="special">|</span> <span class="identifier">type_erased</span><span class="special"><>());</span> + + <span class="comment">// However we may simply wish to define an adaptor that +</span> <span class="comment">// takes a range and makes it into an appropriate +</span> <span class="comment">// forward_traversal any_range... +</span> <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">type_erased</span><span class="special"><</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">use_default</span> + <span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">forward_traversal_tag</span> + <span class="special">></span> <span class="identifier">type_erased_forward</span><span class="special">;</span> + + <span class="comment">// This adaptor can turn other containers with different +</span> <span class="comment">// value_types and reference_types into the appropriate +</span> <span class="comment">// any_range. +</span> + <span class="identifier">server</span><span class="special">::</span><span class="identifier">display_integers</span><span class="special">(</span><span class="identifier">input2</span> <span class="special">|</span> <span class="identifier">type_erased_forward</span><span class="special">());</span> + <span class="special">}</span> +<span class="special">}</span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="identifier">client</span><span class="special">::</span><span class="identifier">run</span><span class="special">();</span> + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span> +<span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">,</span><span class="number">10</span> +<span class="number">11</span><span class="special">,</span><span class="number">12</span><span class="special">,</span><span class="number">13</span><span class="special">,</span><span class="number">14</span><span class="special">,</span><span class="number">15</span> +<span class="number">11</span><span class="special">,</span><span class="number">12</span><span class="special">,</span><span class="number">13</span><span class="special">,</span><span class="number">14</span><span class="special">,</span><span class="number">15</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="strided.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tokenized.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/adaptors/reference/uniqued.html b/libs/range/doc/html/range/reference/adaptors/reference/uniqued.html new file mode 100644 index 0000000000..4174cf876e --- /dev/null +++ b/libs/range/doc/html/range/reference/adaptors/reference/uniqued.html @@ -0,0 +1,150 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>uniqued</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="transformed.html" title="transformed"> +<link rel="next" href="../../algorithms.html" title="Range Algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="transformed.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../algorithms.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.adaptors.reference.uniqued"></a><a class="link" href="uniqued.html" title="uniqued">uniqued</a> +</h5></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="uniqued.html#range.reference.adaptors.reference.uniqued.uniqued_example">uniqued + example</a></span></dt></dl></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Syntax + </p> + </th> +<th> + <p> + Code + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Pipe + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">uniqued</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + Function + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">value_type</span></code> of the range is comparable + with <code class="computeroutput"><span class="keyword">operator</span><span class="special">==()</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Postcondition:</strong></span> For all adjacent + elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> in the returned range, <code class="computeroutput"><span class="identifier">x</span><span class="special">==</span><span class="identifier">y</span></code> is false. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uniqued_range</span><span class="special"><</span><span class="identifier">typeof</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)></span></code> + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The minimum + of the range concept of <code class="computeroutput"><span class="identifier">rng</span></code> + and <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward Range</a>. + </li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h6 class="title"> +<a name="range.reference.adaptors.reference.uniqued.uniqued_example"></a><a class="link" href="uniqued.html#range.reference.adaptors.reference.uniqued.uniqued_example" title="uniqued example">uniqued + example</a> +</h6></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">uniqued</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">algorithm</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">void</span> <span class="identifier">uniqued_example_test</span><span class="special">()</span> +<span class="special">{</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> + <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">input</span><span class="special">;</span> + <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">;</span> + + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> + <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">uniqued</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<p> + This would produce the output: +</p> +<pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="transformed.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../algorithms.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms.html b/libs/range/doc/html/range/reference/algorithms.html new file mode 100644 index 0000000000..bd65e72edb --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Range Algorithms</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="adaptors/reference/uniqued.html" title="uniqued"> +<link rel="next" href="algorithms/introduction.html" title="Introduction and motivation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adaptors/reference/uniqued.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithms/introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.algorithms"></a><a class="link" href="algorithms.html" title="Range Algorithms">Range Algorithms</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="algorithms/introduction.html">Introduction + and motivation</a></span></dt> +<dt><span class="section"><a href="algorithms/mutating.html">Mutating algorithms</a></span></dt> +<dt><span class="section"><a href="algorithms/non_mutating.html">Non-mutating + algorithms</a></span></dt> +<dt><span class="section"><a href="algorithms/set.html">Set algorithms</a></span></dt> +<dt><span class="section"><a href="algorithms/heap.html">Heap algorithms</a></span></dt> +<dt><span class="section"><a href="algorithms/permutation.html">Permutation + algorithms</a></span></dt> +<dt><span class="section"><a href="algorithms/new.html">New algorithms</a></span></dt> +<dt><span class="section"><a href="algorithms/numeric.html">Numeric algorithms</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adaptors/reference/uniqued.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithms/introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/heap.html b/libs/range/doc/html/range/reference/algorithms/heap.html new file mode 100644 index 0000000000..66d79ce161 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/heap.html @@ -0,0 +1,49 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Heap algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="set/set_symmetric_difference.html" title="set_symmetric_difference"> +<link rel="next" href="heap/push_heap.html" title="push_heap"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set/set_symmetric_difference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="heap/push_heap.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.heap"></a><a class="link" href="heap.html" title="Heap algorithms">Heap algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="heap/push_heap.html">push_heap</a></span></dt> +<dt><span class="section"><a href="heap/pop_heap.html">pop_heap</a></span></dt> +<dt><span class="section"><a href="heap/make_heap.html">make_heap</a></span></dt> +<dt><span class="section"><a href="heap/sort_heap.html">sort_heap</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set/set_symmetric_difference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="heap/push_heap.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/heap/make_heap.html b/libs/range/doc/html/range/reference/algorithms/heap/make_heap.html new file mode 100644 index 0000000000..3d4b6ecbbc --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/heap/make_heap.html @@ -0,0 +1,143 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>make_heap</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../heap.html" title="Heap algorithms"> +<link rel="prev" href="pop_heap.html" title="pop_heap"> +<link rel="next" href="sort_heap.html" title="sort_heap"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.heap.make_heap"></a><a class="link" href="make_heap.html" title="make_heap">make_heap</a> +</h5></div></div></div> +<a name="range.reference.algorithms.heap.make_heap.prototype"></a><h6> +<a name="id741272"></a> + <a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.heap.make_heap.description"></a><h6> +<a name="id741648"></a> + <a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">make_heap</span></code> turns <code class="computeroutput"><span class="identifier">rng</span></code> into a heap. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.heap.make_heap.definition"></a><h6> +<a name="id741722"></a> + <a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.heap.make_heap.requirements"></a><h6> +<a name="id741791"></a> + <a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Compare</span></code> is a model + of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.heap.make_heap.complexity"></a><h6> +<a name="id742039"></a> + <a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="number">3</span> <span class="special">*</span> + <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html b/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html new file mode 100644 index 0000000000..d8f0283ce1 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html @@ -0,0 +1,157 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>pop_heap</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../heap.html" title="Heap algorithms"> +<link rel="prev" href="push_heap.html" title="push_heap"> +<link rel="next" href="make_heap.html" title="make_heap"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="push_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.heap.pop_heap"></a><a class="link" href="pop_heap.html" title="pop_heap">pop_heap</a> +</h5></div></div></div> +<a name="range.reference.algorithms.heap.pop_heap.prototype"></a><h6> +<a name="id740266"></a> + <a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">pop_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">pop_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">pop_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">pop_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.heap.pop_heap.description"></a><h6> +<a name="id740642"></a> + <a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">pop_heap</span></code> removes the + largest element from the heap. It is assumed that <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is already a heap and that the element + to be added is <code class="computeroutput"><span class="special">*</span><span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.heap.pop_heap.definition"></a><h6> +<a name="id740796"></a> + <a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.heap.pop_heap.requirements"></a><h6> +<a name="id740866"></a> + <a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Compare</span></code> is a model + of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.heap.pop_heap.precondition_"></a><h6> +<a name="id741114"></a> + <a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="special">!</span><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">rng</span></code> is a heap. + </li> +</ul></div> +<a name="range.reference.algorithms.heap.pop_heap.complexity"></a><h6> +<a name="id741189"></a> + <a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.complexity">Complexity</a> + </h6> +<p> + Logarithmic. At most <code class="computeroutput"><span class="number">2</span> <span class="special">*</span> + <span class="identifier">log</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="push_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/heap/push_heap.html b/libs/range/doc/html/range/reference/algorithms/heap/push_heap.html new file mode 100644 index 0000000000..422302464a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/heap/push_heap.html @@ -0,0 +1,155 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>push_heap</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../heap.html" title="Heap algorithms"> +<link rel="prev" href="../heap.html" title="Heap algorithms"> +<link rel="next" href="pop_heap.html" title="pop_heap"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.heap.push_heap"></a><a class="link" href="push_heap.html" title="push_heap">push_heap</a> +</h5></div></div></div> +<a name="range.reference.algorithms.heap.push_heap.prototype"></a><h6> +<a name="id739222"></a> + <a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">push_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">push_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">push_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">push_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.heap.push_heap.description"></a><h6> +<a name="id739596"></a> + <a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">push_heap</span></code> adds an element + to a heap. It is assumed that <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>, <code class="computeroutput"><span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is already a heap and that the element + to be added is <code class="computeroutput"><span class="special">*</span><span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.heap.push_heap.definition"></a><h6> +<a name="id739755"></a> + <a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.heap.push_heap.requirements"></a><h6> +<a name="id739825"></a> + <a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Compare</span></code> is a model + of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.heap.push_heap.precondition_"></a><h6> +<a name="id740073"></a> + <a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="special">!</span><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)))</span></code> is a heap. + </li> +</ul></div> +<a name="range.reference.algorithms.heap.push_heap.complexity"></a><h6> +<a name="id740193"></a> + <a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.complexity">Complexity</a> + </h6> +<p> + Logarithmic. At most <code class="computeroutput"><span class="identifier">log</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/heap/sort_heap.html b/libs/range/doc/html/range/reference/algorithms/heap/sort_heap.html new file mode 100644 index 0000000000..7667438d15 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/heap/sort_heap.html @@ -0,0 +1,152 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>sort_heap</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../heap.html" title="Heap algorithms"> +<link rel="prev" href="make_heap.html" title="make_heap"> +<link rel="next" href="../permutation.html" title="Permutation algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="make_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../permutation.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.heap.sort_heap"></a><a class="link" href="sort_heap.html" title="sort_heap">sort_heap</a> +</h5></div></div></div> +<a name="range.reference.algorithms.heap.sort_heap.prototype"></a><h6> +<a name="id742115"></a> + <a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.heap.sort_heap.description"></a><h6> +<a name="id742491"></a> + <a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">sort_heap</span></code> turns a heap + into a sorted range. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.heap.sort_heap.definition"></a><h6> +<a name="id742555"></a> + <a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.heap.sort_heap.requirements"></a><h6> +<a name="id742626"></a> + <a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Compare</span></code> is a model + of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.heap.sort_heap.precondition_"></a><h6> +<a name="id742873"></a> + <a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.precondition_">Precondition:</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is a heap. + </p> +<a name="range.reference.algorithms.heap.sort_heap.complexity"></a><h6> +<a name="id742906"></a> + <a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.complexity">Complexity</a> + </h6> +<p> + At most <code class="computeroutput"><span class="identifier">N</span> <span class="special">*</span> + <span class="identifier">log</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> + comparisons, where <code class="computeroutput"><span class="identifier">N</span></code> + is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="make_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../permutation.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/introduction.html b/libs/range/doc/html/range/reference/algorithms/introduction.html new file mode 100644 index 0000000000..708e794656 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/introduction.html @@ -0,0 +1,257 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Introduction and motivation</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="../algorithms.html" title="Range Algorithms"> +<link rel="next" href="mutating.html" title="Mutating algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../algorithms.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mutating.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.introduction"></a><a class="link" href="introduction.html" title="Introduction and motivation">Introduction + and motivation</a> +</h4></div></div></div> +<p> + In its most simple form a <span class="bold"><strong>Range Algorithm</strong></span> + (or range-based algorithm) is simply an iterator-based algorithm where + the <span class="emphasis"><em>two</em></span> iterator arguments have been replaced by + <span class="emphasis"><em>one</em></span> range argument. For example, we may write + </p> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span> <span class="special">=</span> <span class="special">...;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">);</span> +</pre> +<p> + </p> +<p> + instead of + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span> +</pre> +<p> + </p> +<p> + However, the return type of range algorithms is almost always different + from that of existing iterator-based algorithms. + </p> +<p> + One group of algorithms, like <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">()</span></code>, will simply return the same range so + that we can continue to pass the range around and/or further modify it. + Because of this we may write +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">:</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">));</span> +</pre> +<p> + to first sort the range and then run <code class="computeroutput"><span class="identifier">unique</span><span class="special">()</span></code> on the sorted range. + </p> +<p> + Algorithms like <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special">()</span></code> + fall into another group of algorithms that return (potentially) narrowed + views of the original range. By default <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">found</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">found</span></code> denotes the + iterator returned by <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + </p> +<p> + Therefore exactly the unique values can be copied by writing +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">)),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">));</span> +</pre> +<p> + </p> +<p> + Algorithms like <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span></code> usually return the same range: + <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">found</span><span class="special">)</span></code>. However, this behaviour may be changed + by supplying the algorithms with a template argument: + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns a single iterator like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_begin_found</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> + <span class="identifier">found</span><span class="special">)</span></code> + (this is the default) + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_begin_next</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">next</span><span class="special">(</span><span class="identifier">found</span><span class="special">))</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found_end</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">found</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_next_end</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">next</span><span class="special">(</span><span class="identifier">found</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_begin_end</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the entire original range. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + This functionality has the following advantages: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + it allows for <span class="emphasis"><em><span class="bold"><strong>seamless functional-style + programming</strong></span></em></span> where you do not need to use named + local variables to store intermediate results + </li> +<li class="listitem"> + it is very <span class="emphasis"><em><span class="bold"><strong>safe</strong></span></em></span> + because the algorithm can verify out-of-bounds conditions and handle + tricky conditions that lead to empty ranges + </li> +</ol></div> +<p> + For example, consider how easy we may erase the duplicates in a sorted + container: + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span> <span class="special">=</span> <span class="special">...;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found_end</span><span class="special">>(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">)));</span> +</pre> +<p> + </p> +<p> + Notice the use of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found_end</span></code>. + What if we wanted to erase all the duplicates except one of them? In old-fashined + STL-programming we might write + </p> +<p> + +</p> +<pre class="programlisting"><span class="comment">// assume 'vec' is already sorted +</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">>::</span><span class="identifier">iterator</span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span> + +<span class="comment">// remember this check or you get into problems +</span><span class="keyword">if</span> <span class="special">(</span><span class="identifier">i</span> <span class="special">!=</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span> + <span class="special">++</span><span class="identifier">i</span><span class="special">;</span> + +<span class="identifier">vec</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span> +</pre> +<p> + </p> +<p> + The same task may be accomplished simply with +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_next_end</span><span class="special">>(</span><span class="identifier">vec</span><span class="special">));</span> +</pre> +<p> + and there is no need to worry about generating an invalid range. Furthermore, + if the container is complex, calling <code class="computeroutput"><span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code> several times will be more expensive + than using a range algorithm. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../algorithms.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mutating.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating.html b/libs/range/doc/html/range/reference/algorithms/mutating.html new file mode 100644 index 0000000000..ad51a61de7 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Mutating algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="introduction.html" title="Introduction and motivation"> +<link rel="next" href="mutating/copy.html" title="copy"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="introduction.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mutating/copy.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.mutating"></a><a class="link" href="mutating.html" title="Mutating algorithms">Mutating algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="mutating/copy.html">copy</a></span></dt> +<dt><span class="section"><a href="mutating/copy_backward.html">copy_backward</a></span></dt> +<dt><span class="section"><a href="mutating/fill.html">fill</a></span></dt> +<dt><span class="section"><a href="mutating/fill_n.html">fill_n</a></span></dt> +<dt><span class="section"><a href="mutating/generate.html">generate</a></span></dt> +<dt><span class="section"><a href="mutating/inplace_merge.html">inplace_merge</a></span></dt> +<dt><span class="section"><a href="mutating/merge.html">merge</a></span></dt> +<dt><span class="section"><a href="mutating/nth_element.html">nth_element</a></span></dt> +<dt><span class="section"><a href="mutating/partial_sort.html">partial_sort</a></span></dt> +<dt><span class="section"><a href="mutating/partition.html">partition</a></span></dt> +<dt><span class="section"><a href="mutating/random_shuffle.html">random_shuffle</a></span></dt> +<dt><span class="section"><a href="mutating/remove.html">remove</a></span></dt> +<dt><span class="section"><a href="mutating/remove_copy.html">remove_copy</a></span></dt> +<dt><span class="section"><a href="mutating/remove_copy_if.html">remove_copy_if</a></span></dt> +<dt><span class="section"><a href="mutating/remove_if.html">remove_if</a></span></dt> +<dt><span class="section"><a href="mutating/replace.html">replace</a></span></dt> +<dt><span class="section"><a href="mutating/replace_copy.html">replace_copy</a></span></dt> +<dt><span class="section"><a href="mutating/replace_copy_if.html">replace_copy_if</a></span></dt> +<dt><span class="section"><a href="mutating/replace_if.html">replace_if</a></span></dt> +<dt><span class="section"><a href="mutating/reverse.html">reverse</a></span></dt> +<dt><span class="section"><a href="mutating/reverse_copy.html">reverse_copy</a></span></dt> +<dt><span class="section"><a href="mutating/rotate.html">rotate</a></span></dt> +<dt><span class="section"><a href="mutating/rotate_copy.html">rotate_copy</a></span></dt> +<dt><span class="section"><a href="mutating/sort.html">sort</a></span></dt> +<dt><span class="section"><a href="mutating/stable_partition.html">stable_partition</a></span></dt> +<dt><span class="section"><a href="mutating/stable_sort.html">stable_sort</a></span></dt> +<dt><span class="section"><a href="mutating/swap_ranges.html">swap_ranges</a></span></dt> +<dt><span class="section"><a href="mutating/transform.html">transform</a></span></dt> +<dt><span class="section"><a href="mutating/unique.html">unique</a></span></dt> +<dt><span class="section"><a href="mutating/unique_copy.html">unique_copy</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="introduction.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mutating/copy.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/copy.html b/libs/range/doc/html/range/reference/algorithms/mutating/copy.html new file mode 100644 index 0000000000..fd096ff880 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/copy.html @@ -0,0 +1,115 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>copy</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="../mutating.html" title="Mutating algorithms"> +<link rel="next" href="copy_backward.html" title="copy_backward"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../mutating.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="copy_backward.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.copy"></a><a class="link" href="copy.html" title="copy">copy</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.copy.prototype"></a><h6> +<a name="id684203"></a> + <a class="link" href="copy.html#range.reference.algorithms.mutating.copy.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.copy.description"></a><h6> +<a name="id684330"></a> + <a class="link" href="copy.html#range.reference.algorithms.mutating.copy.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">copy</span></code> copies all elements + from <code class="computeroutput"><span class="identifier">source_rng</span></code> to the + range <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span><span class="special">,</span> <span class="identifier">out_it</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">))</span></code>. The return value is <code class="computeroutput"><span class="identifier">out_it</span> <span class="special">+</span> + <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code> + </p> +<a name="range.reference.algorithms.mutating.copy.definition"></a><h6> +<a name="id684459"></a> + <a class="link" href="copy.html#range.reference.algorithms.mutating.copy.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.copy.requirements"></a><h6> +<a name="id684528"></a> + <a class="link" href="copy.html#range.reference.algorithms.mutating.copy.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + The <code class="computeroutput"><span class="identifier">value_type</span></code> of + <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + Concept is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.copy.precondition_"></a><h6> +<a name="id684638"></a> + <a class="link" href="copy.html#range.reference.algorithms.mutating.copy.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">out_it</span></code> is not an + iterator within the <code class="computeroutput"><span class="identifier">source_rng</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span><span class="special">,</span> <span class="identifier">out_it</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">))</span></code> is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.copy.complexity"></a><h6> +<a name="id684744"></a> + <a class="link" href="copy.html#range.reference.algorithms.mutating.copy.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code> assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../mutating.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="copy_backward.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/copy_backward.html b/libs/range/doc/html/range/reference/algorithms/mutating/copy_backward.html new file mode 100644 index 0000000000..29139c18c8 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/copy_backward.html @@ -0,0 +1,124 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>copy_backward</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="copy.html" title="copy"> +<link rel="next" href="fill.html" title="fill"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="fill.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.copy_backward"></a><a class="link" href="copy_backward.html" title="copy_backward">copy_backward</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.copy_backward.prototype"></a><h6> +<a name="id684808"></a> + <a class="link" href="copy_backward.html#range.reference.algorithms.mutating.copy_backward.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BidirectionalOutputIterator</span><span class="special">></span> + <span class="identifier">BidirectionalOutputIterator</span> + <span class="identifier">copy_backward</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> + <span class="identifier">BidirectionalOutputIterator</span> <span class="identifier">out_it</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.copy_backward.description"></a><h6> +<a name="id684936"></a> + <a class="link" href="copy_backward.html#range.reference.algorithms.mutating.copy_backward.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">copy_backward</span></code> copies + all elements from <code class="computeroutput"><span class="identifier">source_rng</span></code> + to the range <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span> + <span class="special">-</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">),</span> <span class="identifier">out_it</span><span class="special">)</span></code>. + </p> +<p> + The values are copied in reverse order. The return value is <code class="computeroutput"><span class="identifier">out_it</span> <span class="special">-</span> + <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code>. + </p> +<p> + Note well that unlike all other standard algorithms <code class="computeroutput"><span class="identifier">out_it</span></code> + denotes the <span class="bold"><strong>end</strong></span> of the output sequence. + </p> +<a name="range.reference.algorithms.mutating.copy_backward.definition"></a><h6> +<a name="id685090"></a> + <a class="link" href="copy_backward.html#range.reference.algorithms.mutating.copy_backward.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy_backward</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.copy_backward.requirements"></a><h6> +<a name="id685160"></a> + <a class="link" href="copy_backward.html#range.reference.algorithms.mutating.copy_backward.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + The <code class="computeroutput"><span class="identifier">value_type</span></code> of + <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.copy_backward.precondition_"></a><h6> +<a name="id685270"></a> + <a class="link" href="copy_backward.html#range.reference.algorithms.mutating.copy_backward.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">out_it</span></code> is not an + iterator within the <code class="computeroutput"><span class="identifier">source_rng</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span><span class="special">,</span> <span class="identifier">out_it</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">))</span></code> is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.copy_backward.complexity"></a><h6> +<a name="id685378"></a> + <a class="link" href="copy_backward.html#range.reference.algorithms.mutating.copy_backward.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code> assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="fill.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/fill.html b/libs/range/doc/html/range/reference/algorithms/mutating/fill.html new file mode 100644 index 0000000000..ea3fec479f --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/fill.html @@ -0,0 +1,101 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>fill</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="copy_backward.html" title="copy_backward"> +<link rel="next" href="fill_n.html" title="fill_n"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy_backward.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="fill_n.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.fill"></a><a class="link" href="fill.html" title="fill">fill</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.fill.prototype"></a><h6> +<a name="id685443"></a> + <a class="link" href="fill.html#range.reference.algorithms.mutating.fill.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">fill</span><span class="special">(</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.fill.description"></a><h6> +<a name="id685579"></a> + <a class="link" href="fill.html#range.reference.algorithms.mutating.fill.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">fill</span></code> assigns the value + <code class="computeroutput"><span class="identifier">val</span></code> to every element + in the range <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<a name="range.reference.algorithms.mutating.fill.definition"></a><h6> +<a name="id685634"></a> + <a class="link" href="fill.html#range.reference.algorithms.mutating.fill.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">fill</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.fill.requirements"></a><h6> +<a name="id685703"></a> + <a class="link" href="fill.html#range.reference.algorithms.mutating.fill.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.fill.complexity"></a><h6> +<a name="id685823"></a> + <a class="link" href="fill.html#range.reference.algorithms.mutating.fill.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy_backward.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="fill_n.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/fill_n.html b/libs/range/doc/html/range/reference/algorithms/mutating/fill_n.html new file mode 100644 index 0000000000..56594c9c8d --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/fill_n.html @@ -0,0 +1,101 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>fill_n</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="fill.html" title="fill"> +<link rel="next" href="generate.html" title="generate"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="fill.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="generate.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.fill_n"></a><a class="link" href="fill_n.html" title="fill_n">fill_n</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.fill_n.prototype"></a><h6> +<a name="id685887"></a> + <a class="link" href="fill_n.html#range.reference.algorithms.mutating.fill_n.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Size</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">fill</span><span class="special">(</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Size</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.fill_n.description"></a><h6> +<a name="id686056"></a> + <a class="link" href="fill_n.html#range.reference.algorithms.mutating.fill_n.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">fill_n</span></code> assigns the value + <code class="computeroutput"><span class="identifier">val</span></code> to <code class="computeroutput"><span class="identifier">n</span></code> elements in the range <code class="computeroutput"><span class="identifier">rng</span></code> begining with <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +<a name="range.reference.algorithms.mutating.fill_n.definition"></a><h6> +<a name="id686152"></a> + <a class="link" href="fill_n.html#range.reference.algorithms.mutating.fill_n.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">fill_n</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.fill_n.requirements"></a><h6> +<a name="id686222"></a> + <a class="link" href="fill_n.html#range.reference.algorithms.mutating.fill_n.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.fill_n.complexity"></a><h6> +<a name="id686341"></a> + <a class="link" href="fill_n.html#range.reference.algorithms.mutating.fill_n.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">n</span></code> assignments + are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="fill.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="generate.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/generate.html b/libs/range/doc/html/range/reference/algorithms/mutating/generate.html new file mode 100644 index 0000000000..c4f568daeb --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/generate.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>generate</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="fill_n.html" title="fill_n"> +<link rel="next" href="inplace_merge.html" title="inplace_merge"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="fill_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="inplace_merge.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.generate"></a><a class="link" href="generate.html" title="generate">generate</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.generate.prototype"></a><h6> +<a name="id686391"></a> + <a class="link" href="generate.html#range.reference.algorithms.mutating.generate.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Generator</span><span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">generate</span><span class="special">(</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Generator</span> <span class="identifier">gen</span> <span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Generator</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">generate</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Generator</span> <span class="identifier">gen</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.generate.description"></a><h6> +<a name="id686629"></a> + <a class="link" href="generate.html#range.reference.algorithms.mutating.generate.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">generate</span></code> assigns the + result of <code class="computeroutput"><span class="identifier">gen</span><span class="special">()</span></code> + to each element in range <code class="computeroutput"><span class="identifier">rng</span></code>. + Returns the resultant range. + </p> +<a name="range.reference.algorithms.mutating.generate.definition"></a><h6> +<a name="id686689"></a> + <a class="link" href="generate.html#range.reference.algorithms.mutating.generate.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">generate</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.generate.requirements"></a><h6> +<a name="id686758"></a> + <a class="link" href="generate.html#range.reference.algorithms.mutating.generate.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Generator</span></code> is a model + of the <code class="computeroutput"><span class="identifier">GeneratorConcept</span></code>. + </li> +<li class="listitem"> + The <code class="computeroutput"><span class="identifier">value_type</span></code> of + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.generate.precondition_"></a><h6> +<a name="id686889"></a> + <a class="link" href="generate.html#range.reference.algorithms.mutating.generate.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">out_it</span></code> is not an + iterator within <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out_it</span><span class="special">,</span> <span class="identifier">out_it</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.generate.complexity"></a><h6> +<a name="id686995"></a> + <a class="link" href="generate.html#range.reference.algorithms.mutating.generate.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="fill_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="inplace_merge.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/inplace_merge.html b/libs/range/doc/html/range/reference/algorithms/mutating/inplace_merge.html new file mode 100644 index 0000000000..ced665541c --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/inplace_merge.html @@ -0,0 +1,186 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>inplace_merge</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="generate.html" title="generate"> +<link rel="next" href="merge.html" title="merge"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="generate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="merge.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.inplace_merge"></a><a class="link" href="inplace_merge.html" title="inplace_merge">inplace_merge</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.inplace_merge.prototype"></a><h6> +<a name="id687058"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="identifier">BidirectionalRange</span><span class="special">&</span> +<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">BidirectionalRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span> <span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> +<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span> <span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="identifier">BidirectionalRange</span><span class="special">&</span> +<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">BidirectionalRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span> <span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> +<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.inplace_merge.description"></a><h6> +<a name="id687615"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">inplace_merge</span></code> combines + two consecutive sorted ranges <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> + and <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> into a single sorted range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>. That is, it starts with a range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> that consists of two pieces each of + which is in ascending order, and rearranges it so that the entire range + is in ascending order. <code class="computeroutput"><span class="identifier">inplace_merge</span></code> + is stable, meaning both that the relative order of elements within each + input range is preserved. + </p> +<a name="range.reference.algorithms.mutating.inplace_merge.definition"></a><h6> +<a name="id687833"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">inplace_merge</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.inplace_merge.requirements"></a><h6> +<a name="id687903"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">BidirectionalRange</span><span class="special">>::</span><span class="identifier">type</span></code> is a model of <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + </li> +<li class="listitem"> + The ordering on objects of <code class="computeroutput"><span class="identifier">range_type</span><span class="special"><</span><span class="identifier">BidirectionalRange</span><span class="special">>::</span><span class="identifier">type</span></code> + is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate version:</strong></span> * <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> is a model of the + <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional Range</a> + Concept. * <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. * <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> + is a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + * <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is convertible to both <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </p> +<a name="range.reference.algorithms.mutating.inplace_merge.precondition_"></a><h6> +<a name="id688158"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.precondition_">Precondition:</a> + </h6> +<a name="range.reference.algorithms.mutating.inplace_merge.for_the_non_predicate_version_"></a><h6> +<a name="id688178"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.for_the_non_predicate_version_">For + the non-predicate version:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">middle</span></code> is in the + range <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is in ascending order. That is for + each pair of adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, + <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is in ascending order. That is + for each pair of adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, + <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.inplace_merge.for_the_predicate_version_"></a><h6> +<a name="id688439"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.for_the_predicate_version_">For + the predicate version:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">middle</span></code> is in the + range <code class="computeroutput"><span class="identifier">rng</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is in ascending order. That is for + each pair of adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, + <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span><span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is in ascending order. That is + for each pair of adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, + <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span><span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.inplace_merge.complexity"></a><h6> +<a name="id688724"></a> + <a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.complexity">Complexity</a> + </h6> +<p> + Worst case: <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span> <span class="identifier">log</span><span class="special">(</span><span class="identifier">N</span><span class="special">))</span></code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="generate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="merge.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/merge.html b/libs/range/doc/html/range/reference/algorithms/mutating/merge.html new file mode 100644 index 0000000000..9d0ce89e8e --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/merge.html @@ -0,0 +1,256 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>merge</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="inplace_merge.html" title="inplace_merge"> +<link rel="next" href="nth_element.html" title="nth_element"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inplace_merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="nth_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.merge"></a><a class="link" href="merge.html" title="merge">merge</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.merge.prototype"></a><h6> +<a name="id688803"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">merge</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">merge</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.merge.description"></a><h6> +<a name="id689149"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">merge</span></code> combines two sorted + ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> into a single sorted range by + copying elements. <code class="computeroutput"><span class="identifier">merge</span></code> + is stable. The return value is <code class="computeroutput"><span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +<p> + The two versions of <code class="computeroutput"><span class="identifier">merge</span></code> + differ by how they compare the elements. + </p> +<p> + The non-predicate version uses the <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code> for the range value type. The predicate + version uses the predicate instead of <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code>. + </p> +<a name="range.reference.algorithms.mutating.merge.definition"></a><h6> +<a name="id689324"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">merge</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.merge.requirements"></a><h6> +<a name="id689393"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering on objects of <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> + is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is convertible to a type in + <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to both <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is convertible to a type in + <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.merge.precondition_"></a><h6> +<a name="id689915"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.precondition_">Precondition:</a> + </h6> +<a name="range.reference.algorithms.mutating.merge.for_the_non_predicate_version_"></a><h6> +<a name="id689935"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.for_the_non_predicate_version_">For + the non-predicate version:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The elements of <code class="computeroutput"><span class="identifier">rng1</span></code> + are in ascending order. That is, for each adjacent element pair + <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> of <code class="computeroutput"><span class="identifier">rng1</span></code>, + <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span> <span class="special">==</span> + <span class="keyword">false</span></code>. + </li> +<li class="listitem"> + The elements of <code class="computeroutput"><span class="identifier">rng2</span></code> + are in ascending order. That is, for each adjacent element pair + <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> of <code class="computeroutput"><span class="identifier">rng2</span></code>, + <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span> <span class="special">==</span> + <span class="keyword">false</span></code>. + </li> +<li class="listitem"> + The ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + do not overlap. + </li> +<li class="listitem"> + The ranges <code class="computeroutput"><span class="identifier">rng2</span></code> and + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + do not overlap. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.merge.for_the_predicate_version_"></a><h6> +<a name="id690400"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.for_the_predicate_version_">For + the predicate version:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The elements of <code class="computeroutput"><span class="identifier">rng1</span></code> + are in ascending order. That is, for each adjacent element pair + <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, of <code class="computeroutput"><span class="identifier">rng1</span></code>, + <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. + </li> +<li class="listitem"> + The elements of <code class="computeroutput"><span class="identifier">rng2</span></code> + are in ascending order. That is, for each adjacent element pair + <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, of <code class="computeroutput"><span class="identifier">rng2</span></code>, + <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. + </li> +<li class="listitem"> + The ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + do not overlap. + </li> +<li class="listitem"> + The ranges <code class="computeroutput"><span class="identifier">rng2</span></code> and + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + do not overlap. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.merge.complexity"></a><h6> +<a name="id690889"></a> + <a class="link" href="merge.html#range.reference.algorithms.mutating.merge.complexity">Complexity</a> + </h6> +<p> + Linear. There are no comparisons if both <code class="computeroutput"><span class="identifier">rng1</span></code> + and <code class="computeroutput"><span class="identifier">rng2</span></code> are empty, otherwise + at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inplace_merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="nth_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/nth_element.html b/libs/range/doc/html/range/reference/algorithms/mutating/nth_element.html new file mode 100644 index 0000000000..16846cde7d --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/nth_element.html @@ -0,0 +1,150 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>nth_element</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="merge.html" title="merge"> +<link rel="next" href="partial_sort.html" title="partial_sort"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="partial_sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.nth_element"></a><a class="link" href="nth_element.html" title="nth_element">nth_element</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.nth_element.prototype"></a><h6> +<a name="id691010"></a> + <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">nth_element</span><span class="special">(</span> + <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">nth_element</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">nth_element</span><span class="special">(</span> + <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">sort_pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">nth_element</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">sort_pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.nth_element.description"></a><h6> +<a name="id691529"></a> + <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">nth_element</span></code> partially + orders a range of elements. <code class="computeroutput"><span class="identifier">nth_element</span></code> + arranges the range <code class="computeroutput"><span class="identifier">rng</span></code> + such that the element corresponding with the iterator <code class="computeroutput"><span class="identifier">nth</span></code> + is the same as the element that would be in that position if <code class="computeroutput"><span class="identifier">rng</span></code> has been sorted. + </p> +<a name="range.reference.algorithms.mutating.nth_element.definition"></a><h6> +<a name="id691606"></a> + <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">nth_element</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.nth_element.requirements"></a><h6> +<a name="id691676"></a> + <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering relation on <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.nth_element.complexity"></a><h6> +<a name="id691923"></a> + <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.complexity">Complexity</a> + </h6> +<p> + On average, linear in <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="partial_sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/partial_sort.html b/libs/range/doc/html/range/reference/algorithms/mutating/partial_sort.html new file mode 100644 index 0000000000..33fb1dfd8e --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/partial_sort.html @@ -0,0 +1,155 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>partial_sort</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="nth_element.html" title="nth_element"> +<link rel="next" href="partition.html" title="partition"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="nth_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="partition.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.partial_sort"></a><a class="link" href="partial_sort.html" title="partial_sort">partial_sort</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.partial_sort.prototype"></a><h6> +<a name="id691988"></a> + <a class="link" href="partial_sort.html#range.reference.algorithms.mutating.partial_sort.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">partial_sort</span><span class="special">(</span> + <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">partial_sort</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">partial_sort</span><span class="special">(</span> + <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">sort_pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">partial_sort</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">sort_pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.partial_sort.description"></a><h6> +<a name="id692508"></a> + <a class="link" href="partial_sort.html#range.reference.algorithms.mutating.partial_sort.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">partial_sort</span></code> rearranges + the elements in <code class="computeroutput"><span class="identifier">rng</span></code>. + It places the smallest <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> elements, sorted in ascending order, + into the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code>. The remaining elements are placed in + an unspecified order into <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">last</span><span class="special">)</span></code>. + </p> +<p> + The non-predicative versions of this function specify that one element + is less than another by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code>. The predicate versions use the + predicate instead. + </p> +<a name="range.reference.algorithms.mutating.partial_sort.definition"></a><h6> +<a name="id692685"></a> + <a class="link" href="partial_sort.html#range.reference.algorithms.mutating.partial_sort.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partial_sort</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.partial_sort.requirements"></a><h6> +<a name="id692756"></a> + <a class="link" href="partial_sort.html#range.reference.algorithms.mutating.partial_sort.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering relation on <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate version:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.partial_sort.complexity"></a><h6> +<a name="id693003"></a> + <a class="link" href="partial_sort.html#range.reference.algorithms.mutating.partial_sort.complexity">Complexity</a> + </h6> +<p> + Approximately <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">*</span> <span class="identifier">log</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">))</span></code> comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="nth_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="partition.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/partition.html b/libs/range/doc/html/range/reference/algorithms/mutating/partition.html new file mode 100644 index 0000000000..d659dd4de3 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/partition.html @@ -0,0 +1,132 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>partition</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="partial_sort.html" title="partial_sort"> +<link rel="next" href="random_shuffle.html" title="random_shuffle"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="partial_sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="random_shuffle.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.partition"></a><a class="link" href="partition.html" title="partition">partition</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.partition.prototype"></a><h6> +<a name="id693119"></a> + <a class="link" href="partition.html#range.reference.algorithms.mutating.partition.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">partition</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">partition</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">partition</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">partition</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.partition.description"></a><h6> +<a name="id693695"></a> + <a class="link" href="partition.html#range.reference.algorithms.mutating.partition.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">partition</span></code> orders the + elements in <code class="computeroutput"><span class="identifier">rng</span></code> based + on <code class="computeroutput"><span class="identifier">pred</span></code>, such that the + elements that satisfy <code class="computeroutput"><span class="identifier">pred</span></code> + precede the elements that do not. In the versions that return a single + iterator, the return value is the middle iterator. In the versions that + have a configurable range_return, <code class="computeroutput"><span class="identifier">found</span></code> + corresponds to the middle iterator. + </p> +<a name="range.reference.algorithms.mutating.partition.definition"></a><h6> +<a name="id693774"></a> + <a class="link" href="partition.html#range.reference.algorithms.mutating.partition.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partition</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.partition.requirements"></a><h6> +<a name="id693845"></a> + <a class="link" href="partition.html#range.reference.algorithms.mutating.partition.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">PredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>'s + argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.partition.complexity"></a><h6> +<a name="id693947"></a> + <a class="link" href="partition.html#range.reference.algorithms.mutating.partition.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> applications of <code class="computeroutput"><span class="identifier">pred</span></code>, + and at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">/</span> <span class="number">2</span></code> + swaps. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="partial_sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="random_shuffle.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/random_shuffle.html b/libs/range/doc/html/range/reference/algorithms/mutating/random_shuffle.html new file mode 100644 index 0000000000..8b8629d738 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/random_shuffle.html @@ -0,0 +1,131 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>random_shuffle</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="partition.html" title="partition"> +<link rel="next" href="remove.html" title="remove"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="partition.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.random_shuffle"></a><a class="link" href="random_shuffle.html" title="random_shuffle">random_shuffle</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.random_shuffle.prototype"></a><h6> +<a name="id694058"></a> + <a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Generator</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Generator</span><span class="special">&</span> <span class="identifier">gen</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Generator</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Generator</span><span class="special">&</span> <span class="identifier">gen</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.random_shuffle.description"></a><h6> +<a name="id694442"></a> + <a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">random_shuffle</span></code> randomly + rearranges the elements in <code class="computeroutput"><span class="identifier">rng</span></code>. + The versions of <code class="computeroutput"><span class="identifier">random_shuffle</span></code> + that do not specify a <code class="computeroutput"><span class="identifier">Generator</span></code> + use an internal random number generator. The versions of <code class="computeroutput"><span class="identifier">random_shuffle</span></code> that do specify a <code class="computeroutput"><span class="identifier">Generator</span></code> use this instead. Returns + the shuffles range. + </p> +<a name="range.reference.algorithms.mutating.random_shuffle.definition"></a><h6> +<a name="id694530"></a> + <a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">random_shuffle</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.random_shuffle.requirements"></a><h6> +<a name="id694601"></a> + <a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the version without a Generator:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li></ul></div> +<p> + <span class="bold"><strong>For the version with a Generator:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Generator</span></code> is a model + of the <code class="computeroutput"><span class="identifier">RandomNumberGeneratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + distance type is convertible to <code class="computeroutput"><span class="identifier">Generator</span></code>'s + argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.random_shuffle.precondition_"></a><h6> +<a name="id694751"></a> + <a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> + <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + is less than <code class="computeroutput"><span class="identifier">gen</span></code>'s + maximum value. + </li></ul></div> +<a name="range.reference.algorithms.mutating.random_shuffle.complexity"></a><h6> +<a name="id694815"></a> + <a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.complexity">Complexity</a> + </h6> +<p> + Linear. If <code class="computeroutput"><span class="special">!</span><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>, exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + swaps are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="partition.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/remove.html b/libs/range/doc/html/range/reference/algorithms/mutating/remove.html new file mode 100644 index 0000000000..172fd87e6a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/remove.html @@ -0,0 +1,138 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>remove</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="random_shuffle.html" title="random_shuffle"> +<link rel="next" href="remove_copy.html" title="remove_copy"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="random_shuffle.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.remove"></a><a class="link" href="remove.html" title="remove">remove</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.remove.prototype"></a><h6> +<a name="id694919"></a> + <a class="link" href="remove.html#range.reference.algorithms.mutating.remove.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.remove.description"></a><h6> +<a name="id695536"></a> + <a class="link" href="remove.html#range.reference.algorithms.mutating.remove.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">remove</span></code> removes from + <code class="computeroutput"><span class="identifier">rng</span></code> all of the elements + <code class="computeroutput"><span class="identifier">x</span></code> for which <code class="computeroutput"><span class="identifier">x</span> <span class="special">==</span> <span class="identifier">val</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. + The versions of <code class="computeroutput"><span class="identifier">remove</span></code> + that return an iterator, return an iterator <code class="computeroutput"><span class="identifier">new_last</span></code> + such that the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">new_last</span><span class="special">)</span></code> contains no elements equal to <code class="computeroutput"><span class="identifier">val</span></code>. The <code class="computeroutput"><span class="identifier">range_return</span></code> + versions of <code class="computeroutput"><span class="identifier">remove</span></code> defines + <code class="computeroutput"><span class="identifier">found</span></code> as the new last + element. The iterators in the range <code class="computeroutput"><span class="special">[</span><span class="identifier">new_last</span><span class="special">,</span> + <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + are dereferenceable, but the elements are unspecified. + </p> +<a name="range.reference.algorithms.mutating.remove.definition"></a><h6> +<a name="id695762"></a> + <a class="link" href="remove.html#range.reference.algorithms.mutating.remove.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.remove.requirements"></a><h6> +<a name="id695833"></a> + <a class="link" href="remove.html#range.reference.algorithms.mutating.remove.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + Objects of type <code class="computeroutput"><span class="identifier">Value</span></code> + can be compared for equality with objects of <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.remove.complexity"></a><h6> +<a name="id695954"></a> + <a class="link" href="remove.html#range.reference.algorithms.mutating.remove.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">remove</span></code> performs + exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + comparisons for equality. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="random_shuffle.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/remove_copy.html b/libs/range/doc/html/range/reference/algorithms/mutating/remove_copy.html new file mode 100644 index 0000000000..a5aff6bd1a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/remove_copy.html @@ -0,0 +1,108 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>remove_copy</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="remove.html" title="remove"> +<link rel="next" href="remove_copy_if.html" title="remove_copy_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_copy_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.remove_copy"></a><a class="link" href="remove_copy.html" title="remove_copy">remove_copy</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.remove_copy.prototype"></a><h6> +<a name="id696029"></a> + <a class="link" href="remove_copy.html#range.reference.algorithms.mutating.remove_copy.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Outputiterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">OutputIterator</span> +<span class="identifier">remove_copy</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">OutputIterator</span> +<span class="identifier">remove_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.remove_copy.description"></a><h6> +<a name="id696332"></a> + <a class="link" href="remove_copy.html#range.reference.algorithms.mutating.remove_copy.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">remove_copy</span></code> copied all + of the elements <code class="computeroutput"><span class="identifier">x</span></code> from + <code class="computeroutput"><span class="identifier">rng</span></code> for which <code class="computeroutput"><span class="identifier">x</span> <span class="special">==</span> <span class="identifier">val</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>. + </p> +<a name="range.reference.algorithms.mutating.remove_copy.definition"></a><h6> +<a name="id696418"></a> + <a class="link" href="remove_copy.html#range.reference.algorithms.mutating.remove_copy.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_copy</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.remove_copy.requirements"></a><h6> +<a name="id696488"></a> + <a class="link" href="remove_copy.html#range.reference.algorithms.mutating.remove_copy.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + Objects of type <code class="computeroutput"><span class="identifier">Value</span></code> + can be compared for equality with objects of <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.remove_copy.complexity"></a><h6> +<a name="id696609"></a> + <a class="link" href="remove_copy.html#range.reference.algorithms.mutating.remove_copy.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">remove_copy</span></code> performs + exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + comparisons for equality. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_copy_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/remove_copy_if.html b/libs/range/doc/html/range/reference/algorithms/mutating/remove_copy_if.html new file mode 100644 index 0000000000..4763181dcd --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/remove_copy_if.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>remove_copy_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="remove_copy.html" title="remove_copy"> +<link rel="next" href="remove_if.html" title="remove_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.remove_copy_if"></a><a class="link" href="remove_copy_if.html" title="remove_copy_if">remove_copy_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.remove_copy_if.prototype"></a><h6> +<a name="id696683"></a> + <a class="link" href="remove_copy_if.html#range.reference.algorithms.mutating.remove_copy_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Outputiterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPred</span><span class="special">></span> +<span class="identifier">OutputIterator</span> +<span class="identifier">remove_copy_if</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> <span class="identifier">UnaryPred</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPred</span><span class="special">></span> +<span class="identifier">OutputIterator</span> +<span class="identifier">remove_copy_if</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> <span class="identifier">UnaryPred</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.remove_copy_if.description"></a><h6> +<a name="id696964"></a> + <a class="link" href="remove_copy_if.html#range.reference.algorithms.mutating.remove_copy_if.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">remove_copy_if</span></code> copied + all of the elements <code class="computeroutput"><span class="identifier">x</span></code> + from <code class="computeroutput"><span class="identifier">rng</span></code> for which <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">false</span></code>. + </p> +<a name="range.reference.algorithms.mutating.remove_copy_if.definition"></a><h6> +<a name="id697054"></a> + <a class="link" href="remove_copy_if.html#range.reference.algorithms.mutating.remove_copy_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_copy_if</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.remove_copy_if.requirements"></a><h6> +<a name="id697124"></a> + <a class="link" href="remove_copy_if.html#range.reference.algorithms.mutating.remove_copy_if.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPred</span></code> is a model + of the <code class="computeroutput"><span class="identifier">UnaryPredicateConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.remove_copy_if.complexity"></a><h6> +<a name="id697217"></a> + <a class="link" href="remove_copy_if.html#range.reference.algorithms.mutating.remove_copy_if.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">remove_copy_if</span></code> + performs exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> comparisons with UnaryPred. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/remove_if.html b/libs/range/doc/html/range/reference/algorithms/mutating/remove_if.html new file mode 100644 index 0000000000..59aebc25d2 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/remove_if.html @@ -0,0 +1,137 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>remove_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="remove_copy_if.html" title="remove_copy_if"> +<link rel="next" href="replace.html" title="replace"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_copy_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.remove_if"></a><a class="link" href="remove_if.html" title="remove_if">remove_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.remove_if.prototype"></a><h6> +<a name="id697291"></a> + <a class="link" href="remove_if.html#range.reference.algorithms.mutating.remove_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.remove_if.description"></a><h6> +<a name="id697867"></a> + <a class="link" href="remove_if.html#range.reference.algorithms.mutating.remove_if.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">remove_if</span></code> removes from + <code class="computeroutput"><span class="identifier">rng</span></code> all of the elements + <code class="computeroutput"><span class="identifier">x</span></code> for which <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. The versions of + <code class="computeroutput"><span class="identifier">remove_if</span></code> that return + an iterator, return an iterator <code class="computeroutput"><span class="identifier">new_last</span></code> + such that the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">new_last</span><span class="special">)</span></code> contains no elements where <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. The iterators in + the range <code class="computeroutput"><span class="special">[</span><span class="identifier">new_last</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> are dereferenceable, but the elements + are unspecified. + </p> +<a name="range.reference.algorithms.mutating.remove_if.definition"></a><h6> +<a name="id698089"></a> + <a class="link" href="remove_if.html#range.reference.algorithms.mutating.remove_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">remove_if</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.remove_if.requirements"></a><h6> +<a name="id698160"></a> + <a class="link" href="remove_if.html#range.reference.algorithms.mutating.remove_if.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">PredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>'s + argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.remove_if.complexity"></a><h6> +<a name="id698282"></a> + <a class="link" href="remove_if.html#range.reference.algorithms.mutating.remove_if.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">remove_if</span></code> performs + exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + applications of <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_copy_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/replace.html b/libs/range/doc/html/range/reference/algorithms/mutating/replace.html new file mode 100644 index 0000000000..b392c50b6a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/replace.html @@ -0,0 +1,118 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>replace</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="remove_if.html" title="remove_if"> +<link rel="next" href="replace_copy.html" title="replace_copy"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.replace"></a><a class="link" href="replace.html" title="replace">replace</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.replace.prototype"></a><h6> +<a name="id698368"></a> + <a class="link" href="replace.html#range.reference.algorithms.mutating.replace.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">replace</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">what</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">with_what</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">replace</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">what</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">with_what</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.replace.description"></a><h6> +<a name="id698680"></a> + <a class="link" href="replace.html#range.reference.algorithms.mutating.replace.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">replace</span></code> every element + in <code class="computeroutput"><span class="identifier">rng</span></code> equal to <code class="computeroutput"><span class="identifier">what</span></code> with <code class="computeroutput"><span class="identifier">with_what</span></code>. + Return a reference to <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<a name="range.reference.algorithms.mutating.replace.definition"></a><h6> +<a name="id698755"></a> + <a class="link" href="replace.html#range.reference.algorithms.mutating.replace.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.replace.requirements"></a><h6> +<a name="id698825"></a> + <a class="link" href="replace.html#range.reference.algorithms.mutating.replace.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>, + and may be compared for equality with objects of <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.replace.complexity"></a><h6> +<a name="id698985"></a> + <a class="link" href="replace.html#range.reference.algorithms.mutating.replace.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">replace</span></code> performs + exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + comparisons for equality and at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> assignments. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/replace_copy.html b/libs/range/doc/html/range/reference/algorithms/mutating/replace_copy.html new file mode 100644 index 0000000000..1784235611 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/replace_copy.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>replace_copy</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="replace.html" title="replace"> +<link rel="next" href="replace_copy_if.html" title="replace_copy_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace_copy_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.replace_copy"></a><a class="link" href="replace_copy.html" title="replace_copy">replace_copy</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.replace_copy.prototype"></a><h6> +<a name="id699084"></a> + <a class="link" href="replace_copy.html#range.reference.algorithms.mutating.replace_copy.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">replace_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">what</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">with_what</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.replace_copy.description"></a><h6> +<a name="id699279"></a> + <a class="link" href="replace_copy.html#range.reference.algorithms.mutating.replace_copy.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">replace_copy</span></code> copy every + element <code class="computeroutput"><span class="identifier">x</span></code> in <code class="computeroutput"><span class="identifier">rng</span></code> such that the corresponding element + in the output range <code class="computeroutput"><span class="identifier">y</span></code> + is <code class="computeroutput"><span class="identifier">x</span> <span class="special">==</span> + <span class="identifier">what</span> <span class="special">?</span> + <span class="identifier">with_what</span> <span class="special">:</span> + <span class="identifier">x</span></code>. + </p> +<a name="range.reference.algorithms.mutating.replace_copy.definition"></a><h6> +<a name="id699388"></a> + <a class="link" href="replace_copy.html#range.reference.algorithms.mutating.replace_copy.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_copy</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.replace_copy.requirements"></a><h6> +<a name="id699458"></a> + <a class="link" href="replace_copy.html#range.reference.algorithms.mutating.replace_copy.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.replace_copy.complexity"></a><h6> +<a name="id699606"></a> + <a class="link" href="replace_copy.html#range.reference.algorithms.mutating.replace_copy.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">replace_copy</span></code> + performs exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace_copy_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/replace_copy_if.html b/libs/range/doc/html/range/reference/algorithms/mutating/replace_copy_if.html new file mode 100644 index 0000000000..d4d3be242a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/replace_copy_if.html @@ -0,0 +1,113 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>replace_copy_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="replace_copy.html" title="replace_copy"> +<link rel="next" href="replace_if.html" title="replace_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.replace_copy_if"></a><a class="link" href="replace_copy_if.html" title="replace_copy_if">replace_copy_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.replace_copy_if.prototype"></a><h6> +<a name="id699680"></a> + <a class="link" href="replace_copy_if.html#range.reference.algorithms.mutating.replace_copy_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">replace_copy_if</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">with_what</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.replace_copy_if.description"></a><h6> +<a name="id699881"></a> + <a class="link" href="replace_copy_if.html#range.reference.algorithms.mutating.replace_copy_if.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">replace_copy_if</span></code> copy + every element <code class="computeroutput"><span class="identifier">x</span></code> in <code class="computeroutput"><span class="identifier">rng</span></code> such that the corresponding element + in the output range <code class="computeroutput"><span class="identifier">y</span></code> + is <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> <span class="special">?</span> <span class="identifier">with_what</span> + <span class="special">:</span> <span class="identifier">x</span></code>. + </p> +<a name="range.reference.algorithms.mutating.replace_copy_if.definition"></a><h6> +<a name="id699992"></a> + <a class="link" href="replace_copy_if.html#range.reference.algorithms.mutating.replace_copy_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_copy_if</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.replace_copy_if.requirements"></a><h6> +<a name="id700063"></a> + <a class="link" href="replace_copy_if.html#range.reference.algorithms.mutating.replace_copy_if.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">UnaryPredicateConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.replace_copy_if.complexity"></a><h6> +<a name="id700239"></a> + <a class="link" href="replace_copy_if.html#range.reference.algorithms.mutating.replace_copy_if.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">replace_copy_if</span></code> + performs exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> evaluations of <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="replace_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/replace_if.html b/libs/range/doc/html/range/reference/algorithms/mutating/replace_if.html new file mode 100644 index 0000000000..1e6609b06a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/replace_if.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>replace_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="replace_copy_if.html" title="replace_copy_if"> +<link rel="next" href="reverse.html" title="reverse"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace_copy_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reverse.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.replace_if"></a><a class="link" href="replace_if.html" title="replace_if">replace_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.replace_if.prototype"></a><h6> +<a name="id700324"></a> + <a class="link" href="replace_if.html#range.reference.algorithms.mutating.replace_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">replace_if</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">with_what</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">replace_if</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">with_what</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.replace_if.description"></a><h6> +<a name="id700643"></a> + <a class="link" href="replace_if.html#range.reference.algorithms.mutating.replace_if.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">replace_if</span></code> replaces every + element <code class="computeroutput"><span class="identifier">x</span></code> in <code class="computeroutput"><span class="identifier">rng</span></code> for which <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">true</span></code> with <code class="computeroutput"><span class="identifier">with_what</span></code>. + Returns a reference to <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<a name="range.reference.algorithms.mutating.replace_if.definition"></a><h6> +<a name="id700754"></a> + <a class="link" href="replace_if.html#range.reference.algorithms.mutating.replace_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">replace_if</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.replace_if.requirements"></a><h6> +<a name="id700825"></a> + <a class="link" href="replace_if.html#range.reference.algorithms.mutating.replace_if.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">PredicateConcept</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>'s + argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s + value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.replace_if.complexity"></a><h6> +<a name="id701001"></a> + <a class="link" href="replace_if.html#range.reference.algorithms.mutating.replace_if.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">replace_if</span></code> performs + exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + applications of <code class="computeroutput"><span class="identifier">pred</span></code>, + and at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> assignments. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace_copy_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reverse.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/reverse.html b/libs/range/doc/html/range/reference/algorithms/mutating/reverse.html new file mode 100644 index 0000000000..6907fe5e32 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/reverse.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>reverse</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="replace_if.html" title="replace_if"> +<link rel="next" href="reverse_copy.html" title="reverse_copy"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reverse_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.reverse"></a><a class="link" href="reverse.html" title="reverse">reverse</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.reverse.prototype"></a><h6> +<a name="id701111"></a> + <a class="link" href="reverse.html#range.reference.algorithms.mutating.reverse.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">reverse</span><span class="special">(</span><span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">reverse</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.reverse.description"></a><h6> +<a name="id701281"></a> + <a class="link" href="reverse.html#range.reference.algorithms.mutating.reverse.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">reverse</span></code> reverses a range. + Returns a reference to the reversed range. + </p> +<a name="range.reference.algorithms.mutating.reverse.definition"></a><h6> +<a name="id701314"></a> + <a class="link" href="reverse.html#range.reference.algorithms.mutating.reverse.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">reverse</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.reverse.requirements"></a><h6> +<a name="id701385"></a> + <a class="link" href="reverse.html#range.reference.algorithms.mutating.reverse.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.reverse.complexity"></a><h6> +<a name="id701451"></a> + <a class="link" href="reverse.html#range.reference.algorithms.mutating.reverse.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">reverse</span></code> makes + <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)/</span><span class="number">2</span></code> calls to <code class="computeroutput"><span class="identifier">iter_swap</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="replace_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reverse_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/reverse_copy.html b/libs/range/doc/html/range/reference/algorithms/mutating/reverse_copy.html new file mode 100644 index 0000000000..b0c962417a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/reverse_copy.html @@ -0,0 +1,100 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>reverse_copy</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="reverse.html" title="reverse"> +<link rel="next" href="rotate.html" title="rotate"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reverse.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rotate.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.reverse_copy"></a><a class="link" href="reverse_copy.html" title="reverse_copy">reverse_copy</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.reverse_copy.prototype"></a><h6> +<a name="id701540"></a> + <a class="link" href="reverse_copy.html#range.reference.algorithms.mutating.reverse_copy.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">reverse_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.reverse_copy.description"></a><h6> +<a name="id701667"></a> + <a class="link" href="reverse_copy.html#range.reference.algorithms.mutating.reverse_copy.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">reverse_copy</span></code> copies the + elements from <code class="computeroutput"><span class="identifier">rng</span></code> in + reverse order to <code class="computeroutput"><span class="identifier">out</span></code>. + Returns the output iterator one passed the last copied element. + </p> +<a name="range.reference.algorithms.mutating.reverse_copy.definition"></a><h6> +<a name="id701723"></a> + <a class="link" href="reverse_copy.html#range.reference.algorithms.mutating.reverse_copy.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">reverse_copy</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.reverse_copy.requirements"></a><h6> +<a name="id701792"></a> + <a class="link" href="reverse_copy.html#range.reference.algorithms.mutating.reverse_copy.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.reverse_copy.complexity"></a><h6> +<a name="id701885"></a> + <a class="link" href="reverse_copy.html#range.reference.algorithms.mutating.reverse_copy.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">reverse_copy</span></code> + makes <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + copies. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reverse.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rotate.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/rotate.html b/libs/range/doc/html/range/reference/algorithms/mutating/rotate.html new file mode 100644 index 0000000000..de9388a9ac --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/rotate.html @@ -0,0 +1,109 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>rotate</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="reverse_copy.html" title="reverse_copy"> +<link rel="next" href="rotate_copy.html" title="rotate_copy"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reverse_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rotate_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.rotate"></a><a class="link" href="rotate.html" title="rotate">rotate</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.rotate.prototype"></a><h6> +<a name="id701961"></a> + <a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rotate</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rotate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.rotate.description"></a><h6> +<a name="id702217"></a> + <a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">rotate</span></code> rotates the elements + in a range. It exchanges the two ranges <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> + and <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>. Returns a reference to <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<a name="range.reference.algorithms.mutating.rotate.definition"></a><h6> +<a name="id702338"></a> + <a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">rotate</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.rotate.requirements"></a><h6> +<a name="id702407"></a> + <a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.rotate.precondition_"></a><h6> +<a name="id702473"></a> + <a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is a valid range. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.rotate.complexity"></a><h6> +<a name="id702586"></a> + <a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> swaps are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reverse_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rotate_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/rotate_copy.html b/libs/range/doc/html/range/reference/algorithms/mutating/rotate_copy.html new file mode 100644 index 0000000000..fbecb940f3 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/rotate_copy.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>rotate_copy</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="rotate.html" title="rotate"> +<link rel="next" href="sort.html" title="sort"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="rotate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.rotate_copy"></a><a class="link" href="rotate_copy.html" title="rotate_copy">rotate_copy</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.rotate_copy.prototype"></a><h6> +<a name="id702649"></a> + <a class="link" href="rotate_copy.html#range.reference.algorithms.mutating.rotate_copy.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">rotate_copy</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.rotate_copy.description"></a><h6> +<a name="id702817"></a> + <a class="link" href="rotate_copy.html#range.reference.algorithms.mutating.rotate_copy.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">rotate_copy</span></code> rotates the + elements in a range. It copies the two ranges <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> + and <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> to <code class="computeroutput"><span class="identifier">out</span></code>. + </p> +<a name="range.reference.algorithms.mutating.rotate_copy.definition"></a><h6> +<a name="id702938"></a> + <a class="link" href="rotate_copy.html#range.reference.algorithms.mutating.rotate_copy.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">rotate_copy</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.rotate_copy.requirements"></a><h6> +<a name="id703007"></a> + <a class="link" href="rotate_copy.html#range.reference.algorithms.mutating.rotate_copy.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.rotate_copy.precondition_"></a><h6> +<a name="id703100"></a> + <a class="link" href="rotate_copy.html#range.reference.algorithms.mutating.rotate_copy.precondition_">Precondition:</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is a valid range. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.rotate_copy.complexity"></a><h6> +<a name="id703212"></a> + <a class="link" href="rotate_copy.html#range.reference.algorithms.mutating.rotate_copy.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> elements are copied. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="rotate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/sort.html b/libs/range/doc/html/range/reference/algorithms/mutating/sort.html new file mode 100644 index 0000000000..aa9512c606 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/sort.html @@ -0,0 +1,153 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>sort</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="rotate_copy.html" title="rotate_copy"> +<link rel="next" href="stable_partition.html" title="stable_partition"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="rotate_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stable_partition.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.sort"></a><a class="link" href="sort.html" title="sort">sort</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.sort.prototype"></a><h6> +<a name="id703276"></a> + <a class="link" href="sort.html#range.reference.algorithms.mutating.sort.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">sort</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.sort.description"></a><h6> +<a name="id703652"></a> + <a class="link" href="sort.html#range.reference.algorithms.mutating.sort.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">sort</span></code> sorts the elements + in <code class="computeroutput"><span class="identifier">rng</span></code> into ascending + order. <code class="computeroutput"><span class="identifier">sort</span></code> is not guaranteed + to be stable. Returns the sorted range. + </p> +<p> + For versions of the <code class="computeroutput"><span class="identifier">sort</span></code> + function without a predicate, ascending order is defined by <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code> + such that for all adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, + <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span> <span class="special">==</span> + <span class="keyword">false</span></code>. + </p> +<p> + For versions of the <code class="computeroutput"><span class="identifier">sort</span></code> + function with a predicate, ascending order is defined by <code class="computeroutput"><span class="identifier">pred</span></code> such that for all adjacent elements + <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. + </p> +<a name="range.reference.algorithms.mutating.sort.definition"></a><h6> +<a name="id703896"></a> + <a class="link" href="sort.html#range.reference.algorithms.mutating.sort.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">sort</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.sort.requirements"></a><h6> +<a name="id703965"></a> + <a class="link" href="sort.html#range.reference.algorithms.mutating.sort.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For versions of sort without a predicate:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering relation on <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong>strict weak ordering</strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For versions of sort with a predicate</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.sort.complexity"></a><h6> +<a name="id704212"></a> + <a class="link" href="sort.html#range.reference.algorithms.mutating.sort.complexity">Complexity</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span> <span class="identifier">log</span><span class="special">(</span><span class="identifier">N</span><span class="special">))</span></code> comparisons (both average and worst-case), + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="rotate_copy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stable_partition.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/stable_partition.html b/libs/range/doc/html/range/reference/algorithms/mutating/stable_partition.html new file mode 100644 index 0000000000..c8dcd45e88 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/stable_partition.html @@ -0,0 +1,134 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>stable_partition</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="sort.html" title="sort"> +<link rel="next" href="stable_sort.html" title="stable_sort"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stable_sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.stable_partition"></a><a class="link" href="stable_partition.html" title="stable_partition">stable_partition</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.stable_partition.prototype"></a><h6> +<a name="id704324"></a> + <a class="link" href="stable_partition.html#range.reference.algorithms.mutating.stable_partition.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">stable_partition</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">stable_partition</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> +<span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">stable_partition</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> +<span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">stable_partition</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.stable_partition.description"></a><h6> +<a name="id704898"></a> + <a class="link" href="stable_partition.html#range.reference.algorithms.mutating.stable_partition.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">stable_partition</span></code> reorders + the elements in the range <code class="computeroutput"><span class="identifier">rng</span></code> + base on the function object <code class="computeroutput"><span class="identifier">pred</span></code>. + Once this function has completed all of the elements that satisfy <code class="computeroutput"><span class="identifier">pred</span></code> appear before all of the elements + that fail to satisfy it. <code class="computeroutput"><span class="identifier">stable_partition</span></code> + differs from <code class="computeroutput"><span class="identifier">partition</span></code> + because it preserves relative order. It is stable. + </p> +<p> + For the versions that return an iterator, the return value is the iterator + to the first element that fails to satisfy <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<p> + For versions that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + the <code class="computeroutput"><span class="identifier">found</span></code> iterator is + the iterator to the first element that fails to satisfy <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.mutating.stable_partition.definition"></a><h6> +<a name="id705039"></a> + <a class="link" href="stable_partition.html#range.reference.algorithms.mutating.stable_partition.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">stable_partition</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.stable_partition.requirements"></a><h6> +<a name="id705110"></a> + <a class="link" href="stable_partition.html#range.reference.algorithms.mutating.stable_partition.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">PredicateConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.stable_partition.complexity"></a><h6> +<a name="id705203"></a> + <a class="link" href="stable_partition.html#range.reference.algorithms.mutating.stable_partition.complexity">Complexity</a> + </h6> +<p> + Best case: <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + Worst case: <code class="computeroutput"><span class="identifier">N</span> <span class="special">*</span> + <span class="identifier">log</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> + swaps, where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stable_sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/stable_sort.html b/libs/range/doc/html/range/reference/algorithms/mutating/stable_sort.html new file mode 100644 index 0000000000..e22f262007 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/stable_sort.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>stable_sort</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="stable_partition.html" title="stable_partition"> +<link rel="next" href="swap_ranges.html" title="swap_ranges"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stable_partition.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_ranges.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.stable_sort"></a><a class="link" href="stable_sort.html" title="stable_sort">stable_sort</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.stable_sort.prototype"></a><h6> +<a name="id705369"></a> + <a class="link" href="stable_sort.html#range.reference.algorithms.mutating.stable_sort.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">stable_sort</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">stable_sort</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">stable_sort</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">stable_sort</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.stable_sort.description"></a><h6> +<a name="id705745"></a> + <a class="link" href="stable_sort.html#range.reference.algorithms.mutating.stable_sort.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">stable_sort</span></code> sorts the + elements in <code class="computeroutput"><span class="identifier">rng</span></code> into + ascending order. <code class="computeroutput"><span class="identifier">stable_sort</span></code> + is guaranteed to be stable. The order is preserved for equivalent elements. + </p> +<p> + For versions of the <code class="computeroutput"><span class="identifier">stable_sort</span></code> + function without a predicate ascending order is defined by <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code> + such that for all adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, + <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span> <span class="special">==</span> + <span class="keyword">false</span></code>. + </p> +<p> + For versions of the <code class="computeroutput"><span class="identifier">stable_sort</span></code> + function with a predicate, ascending order is designed by <code class="computeroutput"><span class="identifier">pred</span></code> such that for all adjacent elements + <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span><span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. + </p> +<a name="range.reference.algorithms.mutating.stable_sort.definition"></a><h6> +<a name="id705989"></a> + <a class="link" href="stable_sort.html#range.reference.algorithms.mutating.stable_sort.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">stable_sort</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.stable_sort.requirements"></a><h6> +<a name="id706060"></a> + <a class="link" href="stable_sort.html#range.reference.algorithms.mutating.stable_sort.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For versions of stable_sort without a predicate</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering relation on <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is a <span class="bold"><strong>strict weak ordering</strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For versions of stable_sort with a predicate:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.stable_sort.complexity"></a><h6> +<a name="id706307"></a> + <a class="link" href="stable_sort.html#range.reference.algorithms.mutating.stable_sort.complexity">Complexity</a> + </h6> +<p> + Best case: <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + Worst case: <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span> <span class="identifier">log</span><span class="special">(</span><span class="identifier">N</span><span class="special">)^</span><span class="number">2</span><span class="special">)</span></code> + comparisons, where <code class="computeroutput"><span class="identifier">N</span></code> + is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stable_partition.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_ranges.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/swap_ranges.html b/libs/range/doc/html/range/reference/algorithms/mutating/swap_ranges.html new file mode 100644 index 0000000000..0e329dde67 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/swap_ranges.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>swap_ranges</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="stable_sort.html" title="stable_sort"> +<link rel="next" href="transform.html" title="transform"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stable_sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="transform.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.swap_ranges"></a><a class="link" href="swap_ranges.html" title="swap_ranges">swap_ranges</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.swap_ranges.prototype"></a><h6> +<a name="id706485"></a> + <a class="link" href="swap_ranges.html#range.reference.algorithms.mutating.swap_ranges.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">swap_ranges</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.swap_ranges.description"></a><h6> +<a name="id706616"></a> + <a class="link" href="swap_ranges.html#range.reference.algorithms.mutating.swap_ranges.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">swap_ranges</span></code> swaps each + element <code class="computeroutput"><span class="identifier">x</span></code> in <code class="computeroutput"><span class="identifier">rng1</span></code> with the corresponding element + <code class="computeroutput"><span class="identifier">y</span></code> in <code class="computeroutput"><span class="identifier">rng2</span></code>. + Returns a reference to <code class="computeroutput"><span class="identifier">rng2</span></code>. + </p> +<a name="range.reference.algorithms.mutating.swap_ranges.definition"></a><h6> +<a name="id706703"></a> + <a class="link" href="swap_ranges.html#range.reference.algorithms.mutating.swap_ranges.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">swap_ranges</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.swap_ranges.requirements"></a><h6> +<a name="id706773"></a> + <a class="link" href="swap_ranges.html#range.reference.algorithms.mutating.swap_ranges.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is mutable. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.swap_ranges.complexity"></a><h6> +<a name="id706880"></a> + <a class="link" href="swap_ranges.html#range.reference.algorithms.mutating.swap_ranges.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> elements are swapped. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stable_sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="transform.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/transform.html b/libs/range/doc/html/range/reference/algorithms/mutating/transform.html new file mode 100644 index 0000000000..77a319c4b2 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/transform.html @@ -0,0 +1,227 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>transform</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="swap_ranges.html" title="swap_ranges"> +<link rel="next" href="unique.html" title="unique"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="swap_ranges.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unique.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.transform"></a><a class="link" href="transform.html" title="transform">transform</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.transform.prototype"></a><h6> +<a name="id706944"></a> + <a class="link" href="transform.html#range.reference.algorithms.mutating.transform.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryOperation</span> +<span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">transform</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">UnaryOperation</span> <span class="identifier">fun</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryOperation</span> +<span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">transform</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">BinaryOperation</span> <span class="identifier">fun</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.transform.description"></a><h6> +<a name="id707279"></a> + <a class="link" href="transform.html#range.reference.algorithms.mutating.transform.description">Description</a> + </h6> +<p> + <span class="bold"><strong>UnaryOperation version:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">transform</span></code> assigns the + value <code class="computeroutput"><span class="identifier">y</span></code> to each element + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)),</span> <span class="identifier">y</span> <span class="special">=</span> <span class="identifier">fun</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> where <code class="computeroutput"><span class="identifier">x</span></code> + is the corresponding value to <code class="computeroutput"><span class="identifier">y</span></code> + in <code class="computeroutput"><span class="identifier">rng1</span></code>. The return value + is <code class="computeroutput"><span class="identifier">out</span> <span class="special">+</span> + <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +<p> + <span class="bold"><strong>BinaryOperation version:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">transform</span></code> assigns the + value <code class="computeroutput"><span class="identifier">z</span></code> to each element + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">+</span> <span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))),</span> <span class="identifier">z</span> <span class="special">=</span> <span class="identifier">fun</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code> where <code class="computeroutput"><span class="identifier">x</span></code> + is the corresponding value in <code class="computeroutput"><span class="identifier">rng1</span></code> + and <code class="computeroutput"><span class="identifier">y</span></code> is the corresponding + value in <code class="computeroutput"><span class="identifier">rng2</span></code>. This version + of <code class="computeroutput"><span class="identifier">transform</span></code> stops upon + reaching either the end of <code class="computeroutput"><span class="identifier">rng1</span></code>, + or the end of <code class="computeroutput"><span class="identifier">rng2</span></code>. Hence + there isn't a requirement for <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code> + since there is a safe guaranteed behaviour, unlike with the iterator + counterpart in the standard library. + </p> +<p> + The return value is <code class="computeroutput"><span class="identifier">out</span> <span class="special">+</span> <span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code>. + </p> +<a name="range.reference.algorithms.mutating.transform.definition"></a><h6> +<a name="id707818"></a> + <a class="link" href="transform.html#range.reference.algorithms.mutating.transform.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">transform</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.transform.requirements"></a><h6> +<a name="id707889"></a> + <a class="link" href="transform.html#range.reference.algorithms.mutating.transform.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the unary versions of transform:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryOperation</span></code> is + a model of the <code class="computeroutput"><span class="identifier">UnaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type must be convertible to <code class="computeroutput"><span class="identifier">UnaryFunction</span></code>'s + argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryFunction</span></code>'s result + type must be convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the binary versions of transform:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type must be convertible to <code class="computeroutput"><span class="identifier">BinaryFunction</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type must be convertible to <code class="computeroutput"><span class="identifier">BinaryFunction</span></code>'s + second argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation</span></code>'s + result type must be convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.transform.precondition_"></a><h6> +<a name="id708258"></a> + <a class="link" href="transform.html#range.reference.algorithms.mutating.transform.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the unary version of transform:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">out</span></code> is not an iterator + within the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">))</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">))</span></code> is a valid range. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the binary version of transform:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">out</span></code> is not an iterator + within the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">))</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">out</span></code> is not an iterator + within the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">+</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> + <span class="special">+</span> <span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)))</span></code> is a valid range. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.transform.complexity"></a><h6> +<a name="id708682"></a> + <a class="link" href="transform.html#range.reference.algorithms.mutating.transform.complexity">Complexity</a> + </h6> +<p> + Linear. The operation is applied exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> for the unary version and <code class="computeroutput"><span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + for the binary version. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="swap_ranges.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unique.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/unique.html b/libs/range/doc/html/range/reference/algorithms/mutating/unique.html new file mode 100644 index 0000000000..7aa3f2fc3a --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/unique.html @@ -0,0 +1,163 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>unique</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="transform.html" title="transform"> +<link rel="next" href="unique_copy.html" title="unique_copy"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="transform.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unique_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.unique"></a><a class="link" href="unique.html" title="unique">unique</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.unique.prototype"></a><h6> +<a name="id708800"></a> + <a class="link" href="unique.html#range.reference.algorithms.mutating.unique.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">return_begin_found</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">return_begin_found</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">return_begin_found</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">return_begin_found</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">unique</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.unique.description"></a><h6> +<a name="id709822"></a> + <a class="link" href="unique.html#range.reference.algorithms.mutating.unique.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">unique</span></code> removes all but + the first element of each sequence of duplicate encountered in <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<p> + Elements in the range <code class="computeroutput"><span class="special">[</span><span class="identifier">new_last</span><span class="special">,</span> + <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + are dereferenceable but undefined. + </p> +<p> + Equality is determined by the predicate if one is supplied, or by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==()</span></code> + for <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type. + </p> +<a name="range.reference.algorithms.mutating.unique.definition"></a><h6> +<a name="id709940"></a> + <a class="link" href="unique.html#range.reference.algorithms.mutating.unique.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">unique</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.unique.requirements"></a><h6> +<a name="id710010"></a> + <a class="link" href="unique.html#range.reference.algorithms.mutating.unique.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions of unique:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions of unique:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type and to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.unique.complexity"></a><h6> +<a name="id710232"></a> + <a class="link" href="unique.html#range.reference.algorithms.mutating.unique.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + comparisons are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="transform.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unique_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/mutating/unique_copy.html b/libs/range/doc/html/range/reference/algorithms/mutating/unique_copy.html new file mode 100644 index 0000000000..cd4a014e00 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/mutating/unique_copy.html @@ -0,0 +1,142 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>unique_copy</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../mutating.html" title="Mutating algorithms"> +<link rel="prev" href="unique.html" title="unique"> +<link rel="next" href="../non_mutating.html" title="Non-mutating algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="unique.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.mutating.unique_copy"></a><a class="link" href="unique_copy.html" title="unique_copy">unique_copy</a> +</h5></div></div></div> +<a name="range.reference.algorithms.mutating.unique_copy.prototype"></a><h6> +<a name="id710354"></a> + <a class="link" href="unique_copy.html#range.reference.algorithms.mutating.unique_copy.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">unique_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">unique_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.mutating.unique_copy.description"></a><h6> +<a name="id710611"></a> + <a class="link" href="unique_copy.html#range.reference.algorithms.mutating.unique_copy.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">unique_copy</span></code> copies the + first element of each sequence of duplicates encountered in <code class="computeroutput"><span class="identifier">rng</span></code> to <code class="computeroutput"><span class="identifier">out</span></code>. + </p> +<p> + Equality is determined by the predicate if one is supplied, or by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==()</span></code> + for <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type. + </p> +<a name="range.reference.algorithms.mutating.unique_copy.definition"></a><h6> +<a name="id710696"></a> + <a class="link" href="unique_copy.html#range.reference.algorithms.mutating.unique_copy.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">unique_copy</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.mutating.unique_copy.requirements"></a><h6> +<a name="id710767"></a> + <a class="link" href="unique_copy.html#range.reference.algorithms.mutating.unique_copy.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions of unique:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions of unique:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type and to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.mutating.unique_copy.complexity"></a><h6> +<a name="id711046"></a> + <a class="link" href="unique_copy.html#range.reference.algorithms.mutating.unique_copy.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + comparisons are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="unique.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new.html b/libs/range/doc/html/range/reference/algorithms/new.html new file mode 100644 index 0000000000..e0451a82b1 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>New algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="permutation/prev_permutation.html" title="prev_permutation"> +<link rel="next" href="new/copy_n.html" title="copy_n"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="permutation/prev_permutation.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="new/copy_n.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.new"></a><a class="link" href="new.html" title="New algorithms">New algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="new/copy_n.html">copy_n</a></span></dt> +<dt><span class="section"><a href="new/erase.html">erase</a></span></dt> +<dt><span class="section"><a href="new/for_each.html">for_each</a></span></dt> +<dt><span class="section"><a href="new/insert.html">insert</a></span></dt> +<dt><span class="section"><a href="new/iota.html">iota</a></span></dt> +<dt><span class="section"><a href="new/is_sorted.html">is_sorted</a></span></dt> +<dt><span class="section"><a href="new/overwrite.html">overwrite</a></span></dt> +<dt><span class="section"><a href="new/push_back.html">push_back</a></span></dt> +<dt><span class="section"><a href="new/push_front.html">push_front</a></span></dt> +<dt><span class="section"><a href="new/remove_erase.html">remove_erase</a></span></dt> +<dt><span class="section"><a href="new/remove_erase_if.html">remove_erase_if</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="permutation/prev_permutation.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="new/copy_n.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/copy_n.html b/libs/range/doc/html/range/reference/algorithms/new/copy_n.html new file mode 100644 index 0000000000..d7ce7467c4 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/copy_n.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>copy_n</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="../new.html" title="New algorithms"> +<link rel="next" href="erase.html" title="erase"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../new.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="erase.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.copy_n"></a><a class="link" href="copy_n.html" title="copy_n">copy_n</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.copy_n.prototype"></a><h6> +<a name="id744730"></a> + <a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Size</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">copy_n</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Size</span> <span class="identifier">n</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.copy_n.description"></a><h6> +<a name="id744888"></a> + <a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">copy_n</span></code> is provided to + completely replicate the standard algorithm header, it is preferable + to use Range Adaptors and the extension functions to achieve the same + result with greater safety. + </p> +<p> + <code class="computeroutput"><span class="identifier">copy_n</span></code> copies elements + from <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">n</span><span class="special">)</span></code> to the range <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">+</span> <span class="identifier">n</span><span class="special">)</span></code> + </p> +<a name="range.reference.algorithms.new.copy_n.definition"></a><h6> +<a name="id745058"></a> + <a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">copy_n</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.copy_n.requirements"></a><h6> +<a name="id745129"></a> + <a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Size</span></code> is a model of + the <code class="computeroutput"><span class="identifier">Integer</span></code> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +</ol></div> +<a name="range.reference.algorithms.new.copy_n.complexity"></a><h6> +<a name="id745236"></a> + <a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">n</span></code> elements + are copied. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../new.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="erase.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/erase.html b/libs/range/doc/html/range/reference/algorithms/new/erase.html new file mode 100644 index 0000000000..dffd697e7f --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/erase.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>erase</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="copy_n.html" title="copy_n"> +<link rel="next" href="for_each.html" title="for_each"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.erase"></a><a class="link" href="erase.html" title="erase">erase</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.erase.prototype"></a><h6> +<a name="id745287"></a> + <a class="link" href="erase.html#range.reference.algorithms.new.erase.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span> +<span class="identifier">Container</span><span class="special">&</span> <span class="identifier">erase</span><span class="special">(</span> + <span class="identifier">Container</span><span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="identifier">iterator_range</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">></span> <span class="identifier">to_erase</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.erase.description"></a><h6> +<a name="id745427"></a> + <a class="link" href="erase.html#range.reference.algorithms.new.erase.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">erase</span></code> the iterator range + <code class="computeroutput"><span class="identifier">to_erase</span></code> from the container + <code class="computeroutput"><span class="identifier">target</span></code>. + </p> +<p> + <code class="computeroutput"><span class="identifier">remove_erase</span></code> performs + the frequently used combination equivalent to <code class="computeroutput"><span class="identifier">target</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">remove</span><span class="special">(</span><span class="identifier">target</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">value</span><span class="special">),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span></code> + </p> +<p> + <code class="computeroutput"><span class="identifier">remove_erase_if</span></code> performs + the frequently used combination equivalent to <code class="computeroutput"><span class="identifier">target</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">remove_if</span><span class="special">(</span><span class="identifier">target</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">pred</span><span class="special">),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span></code> + </p> +<a name="range.reference.algorithms.new.erase.definition"></a><h6> +<a name="id745727"></a> + <a class="link" href="erase.html#range.reference.algorithms.new.erase.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.erase.requirements"></a><h6> +<a name="id745796"></a> + <a class="link" href="erase.html#range.reference.algorithms.new.erase.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + <code class="computeroutput"><span class="identifier">Container</span></code> supports + erase of an iterator range. + </li></ol></div> +<a name="range.reference.algorithms.new.erase.complexity"></a><h6> +<a name="id745840"></a> + <a class="link" href="erase.html#range.reference.algorithms.new.erase.complexity">Complexity</a> + </h6> +<p> + Linear. Proprotional to <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">to_erase</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/for_each.html b/libs/range/doc/html/range/reference/algorithms/new/for_each.html new file mode 100644 index 0000000000..58885de7bc --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/for_each.html @@ -0,0 +1,149 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>for_each</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="erase.html" title="erase"> +<link rel="next" href="insert.html" title="insert"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="erase.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="insert.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.for_each"></a><a class="link" href="for_each.html" title="for_each">for_each</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.for_each.prototype"></a><h6> +<a name="id745904"></a> + <a class="link" href="for_each.html#range.reference.algorithms.new.for_each.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryFunction</span> + <span class="special">></span> +<span class="identifier">BinaryFunction</span> <span class="identifier">for_each</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryFunction</span> <span class="identifier">fn</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryFunction</span> + <span class="special">></span> +<span class="identifier">BinaryFunction</span> <span class="identifier">for_each</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryFunction</span> <span class="identifier">fn</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryFunction</span> + <span class="special">></span> +<span class="identifier">BinaryFunction</span> <span class="identifier">for_each</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryFunction</span> <span class="identifier">fn</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryFunction</span> + <span class="special">></span> +<span class="identifier">BinaryFunction</span> <span class="identifier">for_each</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryFunction</span> <span class="identifier">fn</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.for_each.description"></a><h6> +<a name="id746478"></a> + <a class="link" href="for_each.html#range.reference.algorithms.new.for_each.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">for_each</span></code> traverses forward + through <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> simultaneously. For each iteration, + the element <code class="computeroutput"><span class="identifier">x</span></code> is used + from <code class="computeroutput"><span class="identifier">rng1</span></code> and the corresponding + element <code class="computeroutput"><span class="identifier">y</span></code> is used from + <code class="computeroutput"><span class="identifier">rng2</span></code> to invoke <code class="computeroutput"><span class="identifier">fn</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code>. + </p> +<p> + Iteration is stopped upon reaching the end of the shorter of <code class="computeroutput"><span class="identifier">rng1</span></code>, or <code class="computeroutput"><span class="identifier">rng2</span></code>. + It is safe to call this function with unequal length ranges. + </p> +<a name="range.reference.algorithms.new.for_each.definition"></a><h6> +<a name="id746634"></a> + <a class="link" href="for_each.html#range.reference.algorithms.new.for_each.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.for_each.requirements"></a><h6> +<a name="id746705"></a> + <a class="link" href="for_each.html#range.reference.algorithms.new.for_each.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryFunction</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryFunction</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglepassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryFunction</span></code>'s + second argument type. + </li> +</ol></div> +<a name="range.reference.algorithms.new.for_each.complexity"></a><h6> +<a name="id746866"></a> + <a class="link" href="for_each.html#range.reference.algorithms.new.for_each.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + applications of <code class="computeroutput"><span class="identifier">BinaryFunction</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="erase.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="insert.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/insert.html b/libs/range/doc/html/range/reference/algorithms/new/insert.html new file mode 100644 index 0000000000..e702ab788b --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/insert.html @@ -0,0 +1,105 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>insert</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="for_each.html" title="for_each"> +<link rel="next" href="iota.html" title="iota"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="for_each.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="iota.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.insert"></a><a class="link" href="insert.html" title="insert">insert</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.insert.prototype"></a><h6> +<a name="id746969"></a> + <a class="link" href="insert.html#range.reference.algorithms.new.insert.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">Container</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span> + <span class="special">></span> +<span class="identifier">Container</span><span class="special">&</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">Container</span><span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">before</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">from</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.insert.description"></a><h6> +<a name="id747139"></a> + <a class="link" href="insert.html#range.reference.algorithms.new.insert.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">insert</span></code> all of the elements + in the range <code class="computeroutput"><span class="identifier">from</span></code> before + the <code class="computeroutput"><span class="identifier">before</span></code> iterator into + <code class="computeroutput"><span class="identifier">target</span></code>. + </p> +<a name="range.reference.algorithms.new.insert.definition"></a><h6> +<a name="id747205"></a> + <a class="link" href="insert.html#range.reference.algorithms.new.insert.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">insert</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.insert.requirements"></a><h6> +<a name="id747275"></a> + <a class="link" href="insert.html#range.reference.algorithms.new.insert.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Container</span></code> supports + insert at a specified position. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">Container</span></code>'s + value type. + </li> +</ol></div> +<a name="range.reference.algorithms.new.insert.complexity"></a><h6> +<a name="id747373"></a> + <a class="link" href="insert.html#range.reference.algorithms.new.insert.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">from</span><span class="special">)</span></code> + assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="for_each.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="iota.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/iota.html b/libs/range/doc/html/range/reference/algorithms/new/iota.html new file mode 100644 index 0000000000..47054f44c6 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/iota.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>iota</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="insert.html" title="insert"> +<link rel="next" href="is_sorted.html" title="is_sorted"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="insert.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_sorted.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.iota"></a><a class="link" href="iota.html" title="iota">iota</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.iota.prototype"></a><h6> +<a name="id747438"></a> + <a class="link" href="iota.html#range.reference.algorithms.new.iota.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">iota</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">x</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.iota.description"></a><h6> +<a name="id747564"></a> + <a class="link" href="iota.html#range.reference.algorithms.new.iota.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">iota</span></code> traverses forward + through <code class="computeroutput"><span class="identifier">rng</span></code>, each element + <code class="computeroutput"><span class="identifier">y</span></code> in <code class="computeroutput"><span class="identifier">rng</span></code> + is assigned a value equivalent to <code class="computeroutput"><span class="identifier">x</span> + <span class="special">+</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">it</span><span class="special">)</span></code> + </p> +<a name="range.reference.algorithms.new.iota.definition"></a><h6> +<a name="id747700"></a> + <a class="link" href="iota.html#range.reference.algorithms.new.iota.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">iota</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.iota.requirements"></a><h6> +<a name="id747770"></a> + <a class="link" href="iota.html#range.reference.algorithms.new.iota.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">Incrementable</span></code> + Concept. + </li> +</ol></div> +<a name="range.reference.algorithms.new.iota.complexity"></a><h6> +<a name="id747850"></a> + <a class="link" href="iota.html#range.reference.algorithms.new.iota.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> assignments into <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="insert.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_sorted.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/is_sorted.html b/libs/range/doc/html/range/reference/algorithms/new/is_sorted.html new file mode 100644 index 0000000000..41d6bdca09 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/is_sorted.html @@ -0,0 +1,108 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>is_sorted</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="iota.html" title="iota"> +<link rel="next" href="overwrite.html" title="overwrite"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="iota.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overwrite.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.is_sorted"></a><a class="link" href="is_sorted.html" title="is_sorted">is_sorted</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.is_sorted.prototype"></a><h6> +<a name="id747924"></a> + <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">is_sorted</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">is_sorted</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.is_sorted.description"></a><h6> +<a name="id748118"></a> + <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">is_sorted</span></code> determines + if a range is sorted. For the non-predicate version the return value + is <code class="computeroutput"><span class="keyword">true</span></code> if and only if for + each adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> + the expression <code class="computeroutput"><span class="identifier">x</span> <span class="special"><</span> + <span class="identifier">y</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. + For the predicate version the return value is <code class="computeroutput"><span class="keyword">true</span></code> + is and only if for each adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> + the expression <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. + </p> +<a name="range.reference.algorithms.new.is_sorted.definition"></a><h6> +<a name="id748306"></a> + <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">is_sorted</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.is_sorted.requirements"></a><h6> +<a name="id748376"></a> + <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> + Concept. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to both argument types of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>. + </li> +</ol></div> +<a name="range.reference.algorithms.new.is_sorted.complexity"></a><h6> +<a name="id748485"></a> + <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.complexity">Complexity</a> + </h6> +<p> + Linear. A maximum of <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> comparisons are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="iota.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overwrite.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/overwrite.html b/libs/range/doc/html/range/reference/algorithms/new/overwrite.html new file mode 100644 index 0000000000..7fa22b4c37 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/overwrite.html @@ -0,0 +1,112 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>overwrite</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="is_sorted.html" title="is_sorted"> +<link rel="next" href="push_back.html" title="push_back"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="is_sorted.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="push_back.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.overwrite"></a><a class="link" href="overwrite.html" title="overwrite">overwrite</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.overwrite.prototype"></a><h6> +<a name="id748550"></a> + <a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span> + <span class="special">></span> +<span class="keyword">void</span> <span class="identifier">overwrite</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">from</span><span class="special">,</span> + <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">to</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.overwrite.description"></a><h6> +<a name="id748683"></a> + <a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">overwrite</span></code> assigns the + values from the range <code class="computeroutput"><span class="identifier">from</span></code> + into the range <code class="computeroutput"><span class="identifier">to</span></code>. + </p> +<a name="range.reference.algorithms.new.overwrite.definition"></a><h6> +<a name="id748739"></a> + <a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">overwrite</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.overwrite.requirements"></a><h6> +<a name="id748810"></a> + <a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">)</span> + <span class="special"><=</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">SinglePassRange2</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type. + </li> +</ol></div> +<a name="range.reference.algorithms.new.overwrite.complexity"></a><h6> +<a name="id748987"></a> + <a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> + assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="is_sorted.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="push_back.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/push_back.html b/libs/range/doc/html/range/reference/algorithms/new/push_back.html new file mode 100644 index 0000000000..a348b938ff --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/push_back.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>push_back</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="overwrite.html" title="overwrite"> +<link rel="next" href="push_front.html" title="push_front"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overwrite.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="push_front.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.push_back"></a><a class="link" href="push_back.html" title="push_back">push_back</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.push_back.prototype"></a><h6> +<a name="id749051"></a> + <a class="link" href="push_back.html#range.reference.algorithms.new.push_back.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">Container</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span> + <span class="special">></span> +<span class="identifier">Container</span><span class="special">&</span> <span class="identifier">push_back</span><span class="special">(</span><span class="identifier">Container</span><span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">from</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.push_back.description"></a><h6> +<a name="id749190"></a> + <a class="link" href="push_back.html#range.reference.algorithms.new.push_back.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">push_back</span></code> all of the + elements in the range <code class="computeroutput"><span class="identifier">from</span></code> + to the back of the container <code class="computeroutput"><span class="identifier">target</span></code>. + </p> +<a name="range.reference.algorithms.new.push_back.definition"></a><h6> +<a name="id749246"></a> + <a class="link" href="push_back.html#range.reference.algorithms.new.push_back.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">push_back</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.push_back.requirements"></a><h6> +<a name="id749316"></a> + <a class="link" href="push_back.html#range.reference.algorithms.new.push_back.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Container</span></code> supports + insert at <code class="computeroutput"><span class="identifier">end</span><span class="special">()</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">Container</span></code>'s + value type. + </li> +</ol></div> +<a name="range.reference.algorithms.new.push_back.complexity"></a><h6> +<a name="id749427"></a> + <a class="link" href="push_back.html#range.reference.algorithms.new.push_back.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">from</span><span class="special">)</span></code> + assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overwrite.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="push_front.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/push_front.html b/libs/range/doc/html/range/reference/algorithms/new/push_front.html new file mode 100644 index 0000000000..ab4b48befa --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/push_front.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>push_front</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="push_back.html" title="push_back"> +<link rel="next" href="remove_erase.html" title="remove_erase"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="push_back.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_erase.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.push_front"></a><a class="link" href="push_front.html" title="push_front">push_front</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.push_front.prototype"></a><h6> +<a name="id749493"></a> + <a class="link" href="push_front.html#range.reference.algorithms.new.push_front.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">Container</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span> + <span class="special">></span> +<span class="identifier">Container</span><span class="special">&</span> <span class="identifier">push_front</span><span class="special">(</span><span class="identifier">Container</span><span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">from</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.push_front.description"></a><h6> +<a name="id749631"></a> + <a class="link" href="push_front.html#range.reference.algorithms.new.push_front.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">push_front</span></code> all of the + elements in the range <code class="computeroutput"><span class="identifier">from</span></code> + to the front of the container <code class="computeroutput"><span class="identifier">target</span></code>. + </p> +<a name="range.reference.algorithms.new.push_front.definition"></a><h6> +<a name="id749686"></a> + <a class="link" href="push_front.html#range.reference.algorithms.new.push_front.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">push_front</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.push_front.requirements"></a><h6> +<a name="id749755"></a> + <a class="link" href="push_front.html#range.reference.algorithms.new.push_front.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Container</span></code> supports + insert at <code class="computeroutput"><span class="identifier">begin</span><span class="special">()</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">Container</span></code>'s + value type. + </li> +</ol></div> +<a name="range.reference.algorithms.new.push_front.complexity"></a><h6> +<a name="id749868"></a> + <a class="link" href="push_front.html#range.reference.algorithms.new.push_front.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">from</span><span class="special">)</span></code> + assignments are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="push_back.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_erase.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/remove_erase.html b/libs/range/doc/html/range/reference/algorithms/new/remove_erase.html new file mode 100644 index 0000000000..e09216b087 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/remove_erase.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>remove_erase</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="push_front.html" title="push_front"> +<link rel="next" href="remove_erase_if.html" title="remove_erase_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="push_front.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_erase_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.remove_erase"></a><a class="link" href="remove_erase.html" title="remove_erase">remove_erase</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.remove_erase.prototype"></a><h6> +<a name="id749933"></a> + <a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="identifier">Container</span><span class="special">&</span> <span class="identifier">remove_erase</span><span class="special">(</span><span class="identifier">Container</span><span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">value</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.remove_erase.description"></a><h6> +<a name="id750070"></a> + <a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">remove_erase</span></code> actually + eliminates the elements equal to <code class="computeroutput"><span class="identifier">value</span></code> + from the container. This is in contrast to the <code class="computeroutput"><span class="identifier">remove</span></code> + algorithm which merely rearranges elements. + </p> +<a name="range.reference.algorithms.new.remove_erase.definition"></a><h6> +<a name="id750126"></a> + <a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.remove_erase.requirements"></a><h6> +<a name="id750197"></a> + <a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + <code class="computeroutput"><span class="identifier">Container</span></code> supports + erase of an iterator range. + </li></ol></div> +<a name="range.reference.algorithms.new.remove_erase.complexity"></a><h6> +<a name="id750242"></a> + <a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.complexity">Complexity</a> + </h6> +<p> + Linear. Proportional to <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">target</span><span class="special">)</span></code>s. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="push_front.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_erase_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/new/remove_erase_if.html b/libs/range/doc/html/range/reference/algorithms/new/remove_erase_if.html new file mode 100644 index 0000000000..bf134415f1 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/new/remove_erase_if.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>remove_erase_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../new.html" title="New algorithms"> +<link rel="prev" href="remove_erase.html" title="remove_erase"> +<link rel="next" href="../numeric.html" title="Numeric algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_erase.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../numeric.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.new.remove_erase_if"></a><a class="link" href="remove_erase_if.html" title="remove_erase_if">remove_erase_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.new.remove_erase_if.prototype"></a><h6> +<a name="id750307"></a> + <a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Pred</span><span class="special">></span> +<span class="identifier">Container</span><span class="special">&</span> <span class="identifier">remove_erase_if</span><span class="special">(</span><span class="identifier">Container</span><span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="identifier">Pred</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.new.remove_erase_if.description"></a><h6> +<a name="id750434"></a> + <a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">remove_erase_if</span></code> removes + the elements <code class="computeroutput"><span class="identifier">x</span></code> that satisfy + <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + from the container. This is in contrast to the <code class="computeroutput"><span class="identifier">erase</span></code> + algorithm which merely rearranges elements. + </p> +<a name="range.reference.algorithms.new.remove_erase_if.definition"></a><h6> +<a name="id750514"></a> + <a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.new.remove_erase_if.requirements"></a><h6> +<a name="id750585"></a> + <a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Container</span></code> supports + erase of an iterator range. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Pred</span></code> is a model of + the <code class="computeroutput"><span class="identifier">Predicate</span></code> Concept. + </li> +</ol></div> +<a name="range.reference.algorithms.new.remove_erase_if.complexity"></a><h6> +<a name="id750659"></a> + <a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.complexity">Complexity</a> + </h6> +<p> + Linear. Proportional to <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">target</span><span class="special">)</span></code>s. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="remove_erase.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../numeric.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating.html b/libs/range/doc/html/range/reference/algorithms/non_mutating.html new file mode 100644 index 0000000000..aca1179c84 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating.html @@ -0,0 +1,65 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Non-mutating algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="mutating/unique_copy.html" title="unique_copy"> +<link rel="next" href="non_mutating/adjacent_find.html" title="adjacent_find"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mutating/unique_copy.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="non_mutating/adjacent_find.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.non_mutating"></a><a class="link" href="non_mutating.html" title="Non-mutating algorithms">Non-mutating + algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="non_mutating/adjacent_find.html">adjacent_find</a></span></dt> +<dt><span class="section"><a href="non_mutating/binary_search.html">binary_search</a></span></dt> +<dt><span class="section"><a href="non_mutating/count.html">count</a></span></dt> +<dt><span class="section"><a href="non_mutating/count_if.html">count_if</a></span></dt> +<dt><span class="section"><a href="non_mutating/equal.html">equal</a></span></dt> +<dt><span class="section"><a href="non_mutating/equal_range.html">equal_range</a></span></dt> +<dt><span class="section"><a href="non_mutating/for_each.html">for_each</a></span></dt> +<dt><span class="section"><a href="non_mutating/find.html">find</a></span></dt> +<dt><span class="section"><a href="non_mutating/find_end.html">find_end</a></span></dt> +<dt><span class="section"><a href="non_mutating/find_first_of.html">find_first_of</a></span></dt> +<dt><span class="section"><a href="non_mutating/find_if.html">find_if</a></span></dt> +<dt><span class="section"><a href="non_mutating/lexicographical_compare.html">lexicographical_compare</a></span></dt> +<dt><span class="section"><a href="non_mutating/lower_bound.html">lower_bound</a></span></dt> +<dt><span class="section"><a href="non_mutating/max_element.html">max_element</a></span></dt> +<dt><span class="section"><a href="non_mutating/min_element.html">min_element</a></span></dt> +<dt><span class="section"><a href="non_mutating/mismatch.html">mismatch</a></span></dt> +<dt><span class="section"><a href="non_mutating/search.html">search</a></span></dt> +<dt><span class="section"><a href="non_mutating/search_n.html">search_n</a></span></dt> +<dt><span class="section"><a href="non_mutating/upper_bound.html">upper_bound</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mutating/unique_copy.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="non_mutating/adjacent_find.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/adjacent_find.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/adjacent_find.html new file mode 100644 index 0000000000..d8489adc32 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/adjacent_find.html @@ -0,0 +1,167 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>adjacent_find</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="next" href="binary_search.html" title="binary_search"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="binary_search.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.adjacent_find"></a><a class="link" href="adjacent_find.html" title="adjacent_find">adjacent_find</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.adjacent_find.prototype"></a><h6> +<a name="id711185"></a> + <a class="link" href="adjacent_find.html#range.reference.algorithms.non_mutating.adjacent_find.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPred</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPred</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="identifier">range_return_value_re</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="identifier">range_return_value_re</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">adjacent_find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.adjacent_find.description"></a><h6> +<a name="id712162"></a> + <a class="link" href="adjacent_find.html#range.reference.algorithms.non_mutating.adjacent_find.description">Description</a> + </h6> +<p> + <span class="bold"><strong>Non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">adjacent_find</span></code> finds the + first adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> + in <code class="computeroutput"><span class="identifier">rng</span></code> where <code class="computeroutput"><span class="identifier">x</span> <span class="special">==</span> <span class="identifier">y</span></code> + </p> +<p> + <span class="bold"><strong>Predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">adjacent_find</span></code> finds the + first adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> + in <code class="computeroutput"><span class="identifier">rng</span></code> where <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.adjacent_find.definition"></a><h6> +<a name="id712369"></a> + <a class="link" href="adjacent_find.html#range.reference.algorithms.non_mutating.adjacent_find.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">adjacent_find</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.adjacent_find.requirements"></a><h6> +<a name="id712440"></a> + <a class="link" href="adjacent_find.html#range.reference.algorithms.non_mutating.adjacent_find.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions of adjacent_find:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions of adjacent_find:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type and to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.adjacent_find.complexity"></a><h6> +<a name="id712629"></a> + <a class="link" href="adjacent_find.html#range.reference.algorithms.non_mutating.adjacent_find.complexity">Complexity</a> + </h6> +<p> + Linear. If <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + then no comparisons are performed; otherwise, at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="binary_search.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/binary_search.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/binary_search.html new file mode 100644 index 0000000000..2429e96794 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/binary_search.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>binary_search</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="adjacent_find.html" title="adjacent_find"> +<link rel="next" href="count.html" title="count"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adjacent_find.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="count.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.binary_search"></a><a class="link" href="binary_search.html" title="binary_search">binary_search</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.binary_search.prototype"></a><h6> +<a name="id712729"></a> + <a class="link" href="binary_search.html#range.reference.algorithms.non_mutating.binary_search.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">binary_search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">binary_search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.binary_search.description"></a><h6> +<a name="id713006"></a> + <a class="link" href="binary_search.html#range.reference.algorithms.non_mutating.binary_search.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">binary_search</span></code> returns + <code class="computeroutput"><span class="keyword">true</span></code> if and only if the + value <code class="computeroutput"><span class="identifier">val</span></code> exists in the + range <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.binary_search.definition"></a><h6> +<a name="id713072"></a> + <a class="link" href="binary_search.html#range.reference.algorithms.non_mutating.binary_search.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">binary_search</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.binary_search.requirements"></a><h6> +<a name="id713142"></a> + <a class="link" href="binary_search.html#range.reference.algorithms.non_mutating.binary_search.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions of binary_search:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">Value</span></code> + is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions of binary_search:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.binary_search.precondition_"></a><h6> +<a name="id713411"></a> + <a class="link" href="binary_search.html#range.reference.algorithms.non_mutating.binary_search.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate version:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is ordered in ascending + order according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate version:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is ordered in ascending + order according to the function object <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.binary_search.complexity"></a><h6> +<a name="id713503"></a> + <a class="link" href="binary_search.html#range.reference.algorithms.non_mutating.binary_search.complexity">Complexity</a> + </h6> +<p> + For non-random-access ranges, the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code> where <code class="computeroutput"><span class="identifier">N</span></code> + is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +<p> + For random-access ranges, the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">log</span> <span class="identifier">N</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adjacent_find.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="count.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/count.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/count.html new file mode 100644 index 0000000000..9ce79d31df --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/count.html @@ -0,0 +1,107 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>count</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="binary_search.html" title="binary_search"> +<link rel="next" href="count_if.html" title="count_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="binary_search.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="count_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.count"></a><a class="link" href="count.html" title="count">count</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.count.prototype"></a><h6> +<a name="id713666"></a> + <a class="link" href="count.html#range.reference.algorithms.non_mutating.count.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">count</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.count.description"></a><h6> +<a name="id713960"></a> + <a class="link" href="count.html#range.reference.algorithms.non_mutating.count.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">count</span></code> returns the number + of elements <code class="computeroutput"><span class="identifier">x</span></code> in <code class="computeroutput"><span class="identifier">rng</span></code> where <code class="computeroutput"><span class="identifier">x</span> + <span class="special">==</span> <span class="identifier">val</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.count.definition"></a><h6> +<a name="id714048"></a> + <a class="link" href="count.html#range.reference.algorithms.non_mutating.count.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">count</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.count.requirements"></a><h6> +<a name="id714118"></a> + <a class="link" href="count.html#range.reference.algorithms.non_mutating.count.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + An object of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type can be compared for equality with an object of type <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.count.complexity"></a><h6> +<a name="id714250"></a> + <a class="link" href="count.html#range.reference.algorithms.non_mutating.count.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="binary_search.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="count_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/count_if.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/count_if.html new file mode 100644 index 0000000000..09b3f0548c --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/count_if.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>count_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="count.html" title="count"> +<link rel="next" href="equal.html" title="equal"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="count.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="equal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.count_if"></a><a class="link" href="count_if.html" title="count_if">count_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.count_if.prototype"></a><h6> +<a name="id714315"></a> + <a class="link" href="count_if.html#range.reference.algorithms.non_mutating.count_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">count_if</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.count_if.description"></a><h6> +<a name="id714472"></a> + <a class="link" href="count_if.html#range.reference.algorithms.non_mutating.count_if.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">count_if</span></code> returns the + number of elements <code class="computeroutput"><span class="identifier">x</span></code> + in <code class="computeroutput"><span class="identifier">rng</span></code> where <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.count_if.definition"></a><h6> +<a name="id714562"></a> + <a class="link" href="count_if.html#range.reference.algorithms.non_mutating.count_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">count_if</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.count_if.requirements"></a><h6> +<a name="id714631"></a> + <a class="link" href="count_if.html#range.reference.algorithms.non_mutating.count_if.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">UnaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to the argument type of <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.count_if.complexity"></a><h6> +<a name="id714763"></a> + <a class="link" href="count_if.html#range.reference.algorithms.non_mutating.count_if.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> invocations of <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="count.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="equal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/equal.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/equal.html new file mode 100644 index 0000000000..5b555bb148 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/equal.html @@ -0,0 +1,162 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>equal</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="count_if.html" title="count_if"> +<link rel="next" href="equal_range.html" title="equal_range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="count_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="equal_range.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.equal"></a><a class="link" href="equal.html" title="equal">equal</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.equal.prototype"></a><h6> +<a name="id714837"></a> + <a class="link" href="equal.html#range.reference.algorithms.non_mutating.equal.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span> +<span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> +<span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.equal.description"></a><h6> +<a name="id715120"></a> + <a class="link" href="equal.html#range.reference.algorithms.non_mutating.equal.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">equal</span></code> returns <code class="computeroutput"><span class="keyword">true</span></code> if <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> is equal to the <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code> and for each element <code class="computeroutput"><span class="identifier">x</span></code> + in <code class="computeroutput"><span class="identifier">rng1</span></code>, the corresponding + element <code class="computeroutput"><span class="identifier">y</span></code> in <code class="computeroutput"><span class="identifier">rng2</span></code> is equal. Otherwise <code class="computeroutput"><span class="keyword">false</span></code> is returned. + </p> +<p> + In this range version of <code class="computeroutput"><span class="identifier">equal</span></code> + it is perfectly acceptable to pass in two ranges of unequal lengths. + </p> +<p> + Elements are considered equal in the non-predicate version if <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> + returns <code class="computeroutput"><span class="keyword">true</span></code>. Elements are + considered equal in the predicate version if <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.equal.definition"></a><h6> +<a name="id715354"></a> + <a class="link" href="equal.html#range.reference.algorithms.non_mutating.equal.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">equal</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.equal.requirements"></a><h6> +<a name="id715424"></a> + <a class="link" href="equal.html#range.reference.algorithms.non_mutating.equal.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type can be compared for equality with <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.equal.complexity"></a><h6> +<a name="id715734"></a> + <a class="link" href="equal.html#range.reference.algorithms.non_mutating.equal.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="count_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="equal_range.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/equal_range.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/equal_range.html new file mode 100644 index 0000000000..bc8ceb3bfe --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/equal_range.html @@ -0,0 +1,178 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>equal_range</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="equal.html" title="equal"> +<link rel="next" href="for_each.html" title="for_each"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="equal.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.equal_range"></a><a class="link" href="equal_range.html" title="equal_range">equal_range</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.equal_range.prototype"></a><h6> +<a name="id715826"></a> + <a class="link" href="equal_range.html#range.reference.algorithms.non_mutating.equal_range.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> +<span class="identifier">equal_range</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> +<span class="identifier">equal_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SortPredicate</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> +<span class="identifier">equal_range</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">,</span> <span class="identifier">SortPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SortPredicate</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> +<span class="identifier">equal_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">,</span> <span class="identifier">SortPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + </pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.equal_range.description"></a><h6> +<a name="id716698"></a> + <a class="link" href="equal_range.html#range.reference.algorithms.non_mutating.equal_range.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">equal_range</span></code> returns a + range in the form of a pair of iterators where all of the elements are + equal to <code class="computeroutput"><span class="identifier">val</span></code>. If no values + are found that are equal to <code class="computeroutput"><span class="identifier">val</span></code>, + then an empty range is returned, hence <code class="computeroutput"><span class="identifier">result</span><span class="special">.</span><span class="identifier">first</span> <span class="special">==</span> <span class="identifier">result</span><span class="special">.</span><span class="identifier">second</span></code>. + For the non-predicate versions of <code class="computeroutput"><span class="identifier">equal_range</span></code> + the equality of elements is determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. For the predicate versions of <code class="computeroutput"><span class="identifier">equal_range</span></code> the equality of elements + is determined by <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.equal_range.definition"></a><h6> +<a name="id716841"></a> + <a class="link" href="equal_range.html#range.reference.algorithms.non_mutating.equal_range.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">equal_range</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.equal_range.requirements"></a><h6> +<a name="id716911"></a> + <a class="link" href="equal_range.html#range.reference.algorithms.non_mutating.equal_range.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">Value</span></code> + is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SortPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to both of <code class="computeroutput"><span class="identifier">SortPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.equal_range.precondition_"></a><h6> +<a name="id717180"></a> + <a class="link" href="equal_range.html#range.reference.algorithms.non_mutating.equal_range.precondition_">Precondition:</a> + </h6> +<p> + For the non-predicate versions: <code class="computeroutput"><span class="identifier">rng</span></code> + is ordered in ascending order according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + For the predicate versions: <code class="computeroutput"><span class="identifier">rng</span></code> + is ordered in ascending order according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.equal_range.complexity"></a><h6> +<a name="id717254"></a> + <a class="link" href="equal_range.html#range.reference.algorithms.non_mutating.equal_range.complexity">Complexity</a> + </h6> +<p> + For random-access ranges, the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">log</span> <span class="identifier">N</span><span class="special">)</span></code>, + otherwise the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="equal.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/find.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/find.html new file mode 100644 index 0000000000..0cdb415362 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/find.html @@ -0,0 +1,110 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>find</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="for_each.html" title="for_each"> +<link rel="next" href="find_end.html" title="find_end"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="for_each.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find_end.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.find"></a><a class="link" href="find.html" title="find">find</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.find.prototype"></a><h6> +<a name="id717917"></a> + <a class="link" href="find.html#range.reference.algorithms.non_mutating.find.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.find.description"></a><h6> +<a name="id718205"></a> + <a class="link" href="find.html#range.reference.algorithms.non_mutating.find.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">find</span></code> + that return an iterator, returns the first iterator in the range <code class="computeroutput"><span class="identifier">rng</span></code> such that <code class="computeroutput"><span class="special">*</span><span class="identifier">i</span> <span class="special">==</span> <span class="identifier">value</span></code>. <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> is returned if no such iterator exists. + The versions of find that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.find.definition"></a><h6> +<a name="id718322"></a> + <a class="link" href="find.html#range.reference.algorithms.non_mutating.find.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.find.requirements"></a><h6> +<a name="id718392"></a> + <a class="link" href="find.html#range.reference.algorithms.non_mutating.find.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + The <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> + is defined for type <code class="computeroutput"><span class="identifier">Value</span></code> + to be compared with the <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.find.complexity"></a><h6> +<a name="id718511"></a> + <a class="link" href="find.html#range.reference.algorithms.non_mutating.find.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> comparisons for equality. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="for_each.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find_end.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/find_end.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/find_end.html new file mode 100644 index 0000000000..2381696a9d --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/find_end.html @@ -0,0 +1,173 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>find_end</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="find.html" title="find"> +<link rel="next" href="find_first_of.html" title="find_first_of"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find_first_of.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.find_end"></a><a class="link" href="find_end.html" title="find_end">find_end</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.find_end.prototype"></a><h6> +<a name="id718575"></a> + <a class="link" href="find_end.html#range.reference.algorithms.non_mutating.find_end.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_end</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_end</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_end</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_end</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.find_end.description"></a><h6> +<a name="id719235"></a> + <a class="link" href="find_end.html#range.reference.algorithms.non_mutating.find_end.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">find_end</span></code> + that return an iterator, return an iterator to the beginning of the last + sub-sequence equal to <code class="computeroutput"><span class="identifier">rng2</span></code> + within <code class="computeroutput"><span class="identifier">rng1</span></code>. Equality + is determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> for non-predicate versions of <code class="computeroutput"><span class="identifier">find_end</span></code>, and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code> in the predicate versions. The + versions of <code class="computeroutput"><span class="identifier">find_end</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.find_end.definition"></a><h6> +<a name="id719359"></a> + <a class="link" href="find_end.html#range.reference.algorithms.non_mutating.find_end.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_end</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.find_end.requirements"></a><h6> +<a name="id719430"></a> + <a class="link" href="find_end.html#range.reference.algorithms.non_mutating.find_end.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + Objects of <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s + value type can be compared for equality with objects of <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value type. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.find_end.complexity"></a><h6> +<a name="id719742"></a> + <a class="link" href="find_end.html#range.reference.algorithms.non_mutating.find_end.complexity">Complexity</a> + </h6> +<p> + The number of comparisons is proportional to <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">*</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. If both <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> + and <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> are + models of <code class="computeroutput"><span class="identifier">BidirectionalRangeConcept</span></code> + then the average complexity is linear and the worst case is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">*</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find_first_of.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/find_first_of.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/find_first_of.html new file mode 100644 index 0000000000..6421a4dc75 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/find_first_of.html @@ -0,0 +1,169 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>find_first_of</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="find_end.html" title="find_end"> +<link rel="next" href="find_if.html" title="find_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find_end.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.find_first_of"></a><a class="link" href="find_first_of.html" title="find_first_of">find_first_of</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.find_first_of.prototype"></a><h6> +<a name="id719912"></a> + <a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_first_of</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_first_of</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_first_of</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_first_of</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.find_first_of.description"></a><h6> +<a name="id720570"></a> + <a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">find_first_of</span></code> + that return an iterator, return an iterator to the first occurrence in + <code class="computeroutput"><span class="identifier">rng1</span></code> of any of the elements + in <code class="computeroutput"><span class="identifier">rng2</span></code>. Equality is + determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> + for non-predicate versions of <code class="computeroutput"><span class="identifier">find_first_of</span></code>, + and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code> + in the predicate versions. + </p> +<p> + The versions of <code class="computeroutput"><span class="identifier">find_first_of</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.find_first_of.definition"></a><h6> +<a name="id720699"></a> + <a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_first_of</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.find_first_of.requirements"></a><h6> +<a name="id720771"></a> + <a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>, + and can be compared for equality with <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s + value type. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.find_first_of.complexity"></a><h6> +<a name="id721037"></a> + <a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.complexity">Complexity</a> + </h6> +<p> + At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">*</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code> comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find_end.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/find_if.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/find_if.html new file mode 100644 index 0000000000..836b67514e --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/find_if.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>find_if</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="find_first_of.html" title="find_first_of"> +<link rel="next" href="lexicographical_compare.html" title="lexicographical_compare"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find_first_of.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lexicographical_compare.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.find_if"></a><a class="link" href="find_if.html" title="find_if">find_if</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.find_if.prototype"></a><h6> +<a name="id721127"></a> + <a class="link" href="find_if.html#range.reference.algorithms.non_mutating.find_if.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_if</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">find_if</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.find_if.description"></a><h6> +<a name="id721417"></a> + <a class="link" href="find_if.html#range.reference.algorithms.non_mutating.find_if.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">find_if</span></code> + that return an iterator, returns the first iterator in the range <code class="computeroutput"><span class="identifier">rng</span></code> such that <code class="computeroutput"><span class="identifier">pred</span><span class="special">(*</span><span class="identifier">i</span><span class="special">)</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. + <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + is returned if no such iterator exists. + </p> +<p> + The versions of <code class="computeroutput"><span class="identifier">find_if</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines found in the same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.find_if.definition"></a><h6> +<a name="id721545"></a> + <a class="link" href="find_if.html#range.reference.algorithms.non_mutating.find_if.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">find_if</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.find_if.requirements"></a><h6> +<a name="id721616"></a> + <a class="link" href="find_if.html#range.reference.algorithms.non_mutating.find_if.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">PredicateConcept</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to the argument type of <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.find_if.precondition_"></a><h6> +<a name="id721721"></a> + <a class="link" href="find_if.html#range.reference.algorithms.non_mutating.find_if.precondition_">Precondition:</a> + </h6> +<p> + For each iterator <code class="computeroutput"><span class="identifier">i</span></code> in + <code class="computeroutput"><span class="identifier">rng</span></code>, <code class="computeroutput"><span class="special">*</span><span class="identifier">i</span></code> is in the domain of <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.find_if.complexity"></a><h6> +<a name="id721791"></a> + <a class="link" href="find_if.html#range.reference.algorithms.non_mutating.find_if.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> invocations of <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find_first_of.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lexicographical_compare.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/for_each.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/for_each.html new file mode 100644 index 0000000000..daa7ec1ddc --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/for_each.html @@ -0,0 +1,112 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>for_each</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="equal_range.html" title="equal_range"> +<link rel="next" href="find.html" title="find"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="equal_range.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.for_each"></a><a class="link" href="for_each.html" title="for_each">for_each</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.for_each.prototype"></a><h6> +<a name="id717348"></a> + <a class="link" href="for_each.html#range.reference.algorithms.non_mutating.for_each.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryFunction</span> + <span class="special">></span> +<span class="identifier">UnaryFunction</span> <span class="identifier">for_each</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryFunction</span> <span class="identifier">fun</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">UnaryFunction</span> + <span class="special">></span> +<span class="identifier">UnaryFunction</span> <span class="identifier">for_each</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryFunction</span> <span class="identifier">fun</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.for_each.description"></a><h6> +<a name="id717573"></a> + <a class="link" href="for_each.html#range.reference.algorithms.non_mutating.for_each.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">for_each</span></code> traverses forward + through <code class="computeroutput"><span class="identifier">rng</span></code> and for each + element <code class="computeroutput"><span class="identifier">x</span></code> it invokes + <code class="computeroutput"><span class="identifier">fun</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.for_each.definition"></a><h6> +<a name="id717651"></a> + <a class="link" href="for_each.html#range.reference.algorithms.non_mutating.for_each.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.for_each.requirements"></a><h6> +<a name="id717722"></a> + <a class="link" href="for_each.html#range.reference.algorithms.non_mutating.for_each.requirements">Requirements</a> + </h6> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryFunction</span></code> is + a model of the <code class="computeroutput"><span class="identifier">UnaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">UnaryFunction</span></code> does + not apply any non-constant operation through its argument. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">UnaryFunction</span></code>'s + argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.for_each.complexity"></a><h6> +<a name="id717844"></a> + <a class="link" href="for_each.html#range.reference.algorithms.non_mutating.for_each.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> applications of <code class="computeroutput"><span class="identifier">UnaryFunction</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="equal_range.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="find.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/lexicographical_compare.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/lexicographical_compare.html new file mode 100644 index 0000000000..704296a55b --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/lexicographical_compare.html @@ -0,0 +1,169 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>lexicographical_compare</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="find_if.html" title="find_if"> +<link rel="next" href="lower_bound.html" title="lower_bound"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lower_bound.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.lexicographical_compare"></a><a class="link" href="lexicographical_compare.html" title="lexicographical_compare">lexicographical_compare</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.lexicographical_compare.prototype"></a><h6> +<a name="id721867"></a> + <a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span> + <span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">lexicographical_compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">lexicographical_compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.lexicographical_compare.description"></a><h6> +<a name="id722150"></a> + <a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">lexicographical_compare</span></code> + compares element by element <code class="computeroutput"><span class="identifier">rng1</span></code> + against <code class="computeroutput"><span class="identifier">rng2</span></code>. If the + element from <code class="computeroutput"><span class="identifier">rng1</span></code> is + less than the element from <code class="computeroutput"><span class="identifier">rng2</span></code> + then <code class="computeroutput"><span class="keyword">true</span></code> is returned. If + the end of <code class="computeroutput"><span class="identifier">rng1</span></code> without + reaching the end of <code class="computeroutput"><span class="identifier">rng2</span></code> + this also causes the return value to be <code class="computeroutput"><span class="keyword">true</span></code>. + The return value is <code class="computeroutput"><span class="keyword">false</span></code> + in all other circumstances. The elements are compared using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> + in the non-predicate versions of <code class="computeroutput"><span class="identifier">lexicographical_compare</span></code> + and using <code class="computeroutput"><span class="identifier">pred</span></code> in the + predicate versions. + </p> +<a name="range.reference.algorithms.non_mutating.lexicographical_compare.definition"></a><h6> +<a name="id722318"></a> + <a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">lexicographical_compare</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.lexicographical_compare.requirements"></a><h6> +<a name="id722389"></a> + <a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions of lexicographical_compare:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + Let <code class="computeroutput"><span class="identifier">x</span></code> be an object + of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type. Let <code class="computeroutput"><span class="identifier">y</span></code> + be an obect of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type. <code class="computeroutput"><span class="identifier">x</span> <span class="special"><</span> + <span class="identifier">y</span></code> must be valid. <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> + <span class="identifier">x</span></code> must be valid. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions of lexicographical_compare:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.lexicographical_compare.complexity"></a><h6> +<a name="id722764"></a> + <a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="number">2</span> <span class="special">*</span> + <span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="find_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lower_bound.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/lower_bound.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/lower_bound.html new file mode 100644 index 0000000000..b74ddd7427 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/lower_bound.html @@ -0,0 +1,175 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>lower_bound</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="lexicographical_compare.html" title="lexicographical_compare"> +<link rel="next" href="max_element.html" title="max_element"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lexicographical_compare.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="max_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.lower_bound"></a><a class="link" href="lower_bound.html" title="lower_bound">lower_bound</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.lower_bound.prototype"></a><h6> +<a name="id722868"></a> + <a class="link" href="lower_bound.html#range.reference.algorithms.non_mutating.lower_bound.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">lower_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">lower_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.lower_bound.description"></a><h6> +<a name="id723158"></a> + <a class="link" href="lower_bound.html#range.reference.algorithms.non_mutating.lower_bound.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">lower_bound</span></code> + that return an iterator, returns the first iterator in the range <code class="computeroutput"><span class="identifier">rng</span></code> such that: without predicate - + <code class="computeroutput"><span class="special">*</span><span class="identifier">i</span> + <span class="special"><</span> <span class="identifier">value</span></code> + is <code class="computeroutput"><span class="keyword">false</span></code>, with predicate + - <code class="computeroutput"><span class="identifier">pred</span><span class="special">(*</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">value</span><span class="special">)</span></code> + is <code class="computeroutput"><span class="keyword">false</span></code>. + </p> +<p> + <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + is returned if no such iterator exists. + </p> +<p> + The versions of <code class="computeroutput"><span class="identifier">lower_bound</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.lower_bound.definition"></a><h6> +<a name="id723347"></a> + <a class="link" href="lower_bound.html#range.reference.algorithms.non_mutating.lower_bound.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">lower_bound</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.lower_bound.requirements"></a><h6> +<a name="id723418"></a> + <a class="link" href="lower_bound.html#range.reference.algorithms.non_mutating.lower_bound.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">Value</span></code> + is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.lower_bound.precondition_"></a><h6> +<a name="id723687"></a> + <a class="link" href="lower_bound.html#range.reference.algorithms.non_mutating.lower_bound.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is sorted in ascending + order according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is sorted in ascending + order according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.lower_bound.complexity"></a><h6> +<a name="id723780"></a> + <a class="link" href="lower_bound.html#range.reference.algorithms.non_mutating.lower_bound.complexity">Complexity</a> + </h6> +<p> + For ranges that model the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> concept the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">log</span> <span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +<p> + For all other range types the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lexicographical_compare.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="max_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/max_element.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/max_element.html new file mode 100644 index 0000000000..52f7c53759 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/max_element.html @@ -0,0 +1,165 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>max_element</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="lower_bound.html" title="lower_bound"> +<link rel="next" href="min_element.html" title="min_element"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lower_bound.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="min_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.max_element"></a><a class="link" href="max_element.html" title="max_element">max_element</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.max_element.prototype"></a><h6> +<a name="id723919"></a> + <a class="link" href="max_element.html#range.reference.algorithms.non_mutating.max_element.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value_re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">max_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.max_element.description"></a><h6> +<a name="id724905"></a> + <a class="link" href="max_element.html#range.reference.algorithms.non_mutating.max_element.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">max_element</span></code> + that return an iterator, return the iterator to the maximum value as + determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> if a predicate is not supplied. Otherwise + the predicate <code class="computeroutput"><span class="identifier">pred</span></code> is + used to determine the maximum value. The versions of <code class="computeroutput"><span class="identifier">max_element</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.max_element.definition"></a><h6> +<a name="id725000"></a> + <a class="link" href="max_element.html#range.reference.algorithms.non_mutating.max_element.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">max_element</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.max_element.requirements"></a><h6> +<a name="id725071"></a> + <a class="link" href="max_element.html#range.reference.algorithms.non_mutating.max_element.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.max_element.complexity"></a><h6> +<a name="id725249"></a> + <a class="link" href="max_element.html#range.reference.algorithms.non_mutating.max_element.complexity">Complexity</a> + </h6> +<p> + Linear. Zero comparisons if <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>, otherwise <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lower_bound.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="min_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/min_element.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/min_element.html new file mode 100644 index 0000000000..26cd301b8b --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/min_element.html @@ -0,0 +1,165 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>min_element</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="max_element.html" title="max_element"> +<link rel="next" href="mismatch.html" title="mismatch"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="max_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mismatch.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.min_element"></a><a class="link" href="min_element.html" title="min_element">min_element</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.min_element.prototype"></a><h6> +<a name="id725348"></a> + <a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value_re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.min_element.description"></a><h6> +<a name="id726335"></a> + <a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">min_element</span></code> + that return an iterator, return the iterator to the minimum value as + determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> if a predicate is not supplied. Otherwise + the predicate <code class="computeroutput"><span class="identifier">pred</span></code> is + used to determine the minimum value. The versions of <code class="computeroutput"><span class="identifier">min_element</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.min_element.definition"></a><h6> +<a name="id726429"></a> + <a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">min_element</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.min_element.requirements"></a><h6> +<a name="id726500"></a> + <a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.min_element.complexity"></a><h6> +<a name="id726678"></a> + <a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.complexity">Complexity</a> + </h6> +<p> + Linear. Zero comparisons if <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>, otherwise <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="max_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mismatch.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/mismatch.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/mismatch.html new file mode 100644 index 0000000000..cbfad8ad94 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/mismatch.html @@ -0,0 +1,215 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>mismatch</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="min_element.html" title="min_element"> +<link rel="next" href="search.html" title="search"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="min_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="search.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.mismatch"></a><a class="link" href="mismatch.html" title="mismatch">mismatch</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.mismatch.prototype"></a><h6> +<a name="id726777"></a> + <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">mismatch</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.mismatch.description"></a><h6> +<a name="id728481"></a> + <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">mismatch</span></code> finds the first + position where the correseponding elements from the two ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> + are not equal. + </p> +<p> + Equality is determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> for non-predicate versions of <code class="computeroutput"><span class="identifier">mismatch</span></code>, and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code> in the predicate versions. + </p> +<a name="range.reference.algorithms.non_mutating.mismatch.definition"></a><h6> +<a name="id728578"></a> + <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">mismatch</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.mismatch.requirements"></a><h6> +<a name="id728648"></a> + <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>s + value type can be compared for equality with <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.mismatch.precondition_"></a><h6> +<a name="id728960"></a> + <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.precondition_">Precondition:</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">>=</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.mismatch.complexity"></a><h6> +<a name="id729032"></a> + <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> comparisons. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="min_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="search.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/search.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/search.html new file mode 100644 index 0000000000..427642b5c5 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/search.html @@ -0,0 +1,205 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>search</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="mismatch.html" title="mismatch"> +<link rel="next" href="search_n.html" title="search_n"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mismatch.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="search_n.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.search"></a><a class="link" href="search.html" title="search">search</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.search.prototype"></a><h6> +<a name="id729096"></a> + <a class="link" href="search.html#range.reference.algorithms.non_mutating.search.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> +<span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> +<span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.search.description"></a><h6> +<a name="id730434"></a> + <a class="link" href="search.html#range.reference.algorithms.non_mutating.search.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">search</span></code> + that return an iterator, return an iterator to the start of the first + subsequence in <code class="computeroutput"><span class="identifier">rng1</span></code> that + is equal to the subsequence <code class="computeroutput"><span class="identifier">rng2</span></code>. + The <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> + is returned if no such subsequence exists in <code class="computeroutput"><span class="identifier">rng1</span></code>. + Equality is determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> for non-predicate versions of <code class="computeroutput"><span class="identifier">search</span></code>, and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code> in the predicate versions. + </p> +<p> + The versions of <code class="computeroutput"><span class="identifier">search</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.search.definition"></a><h6> +<a name="id730597"></a> + <a class="link" href="search.html#range.reference.algorithms.non_mutating.search.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">search</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.search.requirements"></a><h6> +<a name="id730668"></a> + <a class="link" href="search.html#range.reference.algorithms.non_mutating.search.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>s value + type can be compared for equality with <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s + value type. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is + a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.search.complexity"></a><h6> +<a name="id730979"></a> + <a class="link" href="search.html#range.reference.algorithms.non_mutating.search.complexity">Complexity</a> + </h6> +<p> + Average complexity is Linear. Worst-case complexity is quadratic. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mismatch.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="search_n.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/search_n.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/search_n.html new file mode 100644 index 0000000000..6bc149dfa7 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/search_n.html @@ -0,0 +1,147 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>search_n</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="search.html" title="search"> +<link rel="next" href="upper_bound.html" title="upper_bound"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="search.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upper_bound.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.search_n"></a><a class="link" href="search_n.html" title="search_n">search_n</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.search_n.prototype"></a><h6> +<a name="id731020"></a> + <a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search_n</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">value</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search_n</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">value</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search_n</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">value</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">binary_pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">search_n</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">value</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">binary_pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.search_n.description"></a><h6> +<a name="id731769"></a> + <a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">search_n</span></code> searches <code class="computeroutput"><span class="identifier">rng</span></code> for a sequence of length <code class="computeroutput"><span class="identifier">n</span></code> equal to <code class="computeroutput"><span class="identifier">value</span></code> + where equality is determined by operator== in the non-predicate case, + and by a predicate when one is supplied. + </p> +<a name="range.reference.algorithms.non_mutating.search_n.definition"></a><h6> +<a name="id731836"></a> + <a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">search_n</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.search_n.requirements"></a><h6> +<a name="id731906"></a> + <a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>s value + type can be compared for equality with <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Integer</span></code> is a model + of the <code class="computeroutput"><span class="identifier">IntegerConcept</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Integer</span></code> is a model + of the <code class="computeroutput"><span class="identifier">IntegerConcept</span></code>. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.search_n.complexity"></a><h6> +<a name="id732195"></a> + <a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.complexity">Complexity</a> + </h6> +<p> + Average complexity is Linear. Worst-case complexity is quadratic. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="search.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upper_bound.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/non_mutating/upper_bound.html b/libs/range/doc/html/range/reference/algorithms/non_mutating/upper_bound.html new file mode 100644 index 0000000000..7c5b03e08f --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/non_mutating/upper_bound.html @@ -0,0 +1,172 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>upper_bound</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> +<link rel="prev" href="search_n.html" title="search_n"> +<link rel="next" href="../set.html" title="Set algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="search_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../set.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.non_mutating.upper_bound"></a><a class="link" href="upper_bound.html" title="upper_bound">upper_bound</a> +</h5></div></div></div> +<a name="range.reference.algorithms.non_mutating.upper_bound.prototype"></a><h6> +<a name="id732236"></a> + <a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">upper_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> +<span class="identifier">upper_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.non_mutating.upper_bound.description"></a><h6> +<a name="id732525"></a> + <a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.description">Description</a> + </h6> +<p> + The versions of <code class="computeroutput"><span class="identifier">upper_bound</span></code> + that return an iterator, returns the first iterator in the range <code class="computeroutput"><span class="identifier">rng</span></code> such that: without predicate - + <code class="computeroutput"><span class="identifier">val</span> <span class="special"><</span> + <span class="special">*</span><span class="identifier">i</span></code> + is <code class="computeroutput"><span class="keyword">true</span></code>, with predicate + - <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">val</span><span class="special">,</span> <span class="special">*</span><span class="identifier">i</span><span class="special">)</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. + </p> +<p> + <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + is returned if no such iterator exists. + </p> +<p> + The versions of <code class="computeroutput"><span class="identifier">upper_bound</span></code> + that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, + defines <code class="computeroutput"><span class="identifier">found</span></code> in the + same manner as the returned iterator described above. + </p> +<a name="range.reference.algorithms.non_mutating.upper_bound.definition"></a><h6> +<a name="id732719"></a> + <a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">upper_bound</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.non_mutating.upper_bound.requirements"></a><h6> +<a name="id732790"></a> + <a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">Value</span></code> + is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a + model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value + type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.non_mutating.upper_bound.precondition_"></a><h6> +<a name="id733059"></a> + <a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is sorted in ascending + order according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng</span></code> is sorted in ascending + order according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.non_mutating.upper_bound.complexity"></a><h6> +<a name="id733150"></a> + <a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.complexity">Complexity</a> + </h6> +<p> + For ranges that model the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">log</span> <span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + For all other range types the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="search_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../set.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/numeric.html b/libs/range/doc/html/range/reference/algorithms/numeric.html new file mode 100644 index 0000000000..b71fd546d6 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/numeric.html @@ -0,0 +1,49 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Numeric algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="new/remove_erase_if.html" title="remove_erase_if"> +<link rel="next" href="numeric/accumulate.html" title="accumulate"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="new/remove_erase_if.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="numeric/accumulate.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.numeric"></a><a class="link" href="numeric.html" title="Numeric algorithms">Numeric algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="numeric/accumulate.html">accumulate</a></span></dt> +<dt><span class="section"><a href="numeric/adjacent_difference.html">adjacent_difference</a></span></dt> +<dt><span class="section"><a href="numeric/inner_product.html">inner_product</a></span></dt> +<dt><span class="section"><a href="numeric/partial_sum.html">partial_sum</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="new/remove_erase_if.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="numeric/accumulate.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/numeric/accumulate.html b/libs/range/doc/html/range/reference/algorithms/numeric/accumulate.html new file mode 100644 index 0000000000..a98dc0f9ac --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/numeric/accumulate.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>accumulate</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../numeric.html" title="Numeric algorithms"> +<link rel="prev" href="../numeric.html" title="Numeric algorithms"> +<link rel="next" href="adjacent_difference.html" title="adjacent_difference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../numeric.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adjacent_difference.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.numeric.accumulate"></a><a class="link" href="accumulate.html" title="accumulate">accumulate</a> +</h5></div></div></div> +<a name="range.reference.algorithms.numeric.accumulate.prototype"></a><h6> +<a name="id750741"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">></span> +<span class="identifier">Value</span> <span class="identifier">accumulate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> + <span class="identifier">Value</span> <span class="identifier">init</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryOperation</span> + <span class="special">></span> +<span class="identifier">Value</span> <span class="identifier">accumulate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> + <span class="identifier">Value</span> <span class="identifier">init</span><span class="special">,</span> + <span class="identifier">BinaryOperation</span> <span class="identifier">op</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.numeric.accumulate.description"></a><h6> +<a name="id751002"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">accumulate</span></code> is a generalisation + of summation. It computes a binary operation (<code class="computeroutput"><span class="keyword">operator</span><span class="special">+</span></code> in the non-predicate version) of <code class="computeroutput"><span class="identifier">init</span></code> and all of the elements in <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<p> + The return value is the resultant value of the above algorithm. + </p> +<a name="range.reference.algorithms.numeric.accumulate.definition"></a><h6> +<a name="id751077"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.numeric.accumulate.requirements"></a><h6> +<a name="id751139"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.requirements">Requirements</a> + </h6> +<a name="range.reference.algorithms.numeric.accumulate.for_the_first_version"></a><h6> +<a name="id751160"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.for_the_first_version">For + the first version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + An <code class="computeroutput"><span class="keyword">operator</span><span class="special">+</span></code> + is defined for a left-hand operand of type <code class="computeroutput"><span class="identifier">Value</span></code> + and a right-hand operance of the <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + value type. + </li> +<li class="listitem"> + The return type of the above operator is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.accumulate.for_the_second_version"></a><h6> +<a name="id751302"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.for_the_second_version">For + the second version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to <code class="computeroutput"><span class="identifier">BinaryOperation</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryOperation</span></code>'s + second argument type. + </li> +<li class="listitem"> + The return type of <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> + is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.accumulate.complexity"></a><h6> +<a name="id751495"></a> + <a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">source_rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../numeric.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adjacent_difference.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/numeric/adjacent_difference.html b/libs/range/doc/html/range/reference/algorithms/numeric/adjacent_difference.html new file mode 100644 index 0000000000..c704d2a872 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/numeric/adjacent_difference.html @@ -0,0 +1,178 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>adjacent_difference</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../numeric.html" title="Numeric algorithms"> +<link rel="prev" href="accumulate.html" title="accumulate"> +<link rel="next" href="inner_product.html" title="inner_product"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="accumulate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="inner_product.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.numeric.adjacent_difference"></a><a class="link" href="adjacent_difference.html" title="adjacent_difference">adjacent_difference</a> +</h5></div></div></div> +<a name="range.reference.algorithms.numeric.adjacent_difference.prototype"></a><h6> +<a name="id751560"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">adjacent_difference</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryOperation</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">adjacent_difference</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">,</span> + <span class="identifier">BinaryOperation</span> <span class="identifier">op</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.numeric.adjacent_difference.description"></a><h6> +<a name="id751824"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">adjacent_difference</span></code> calculates + the differences of adjacent_elements in <code class="computeroutput"><span class="identifier">rng</span></code>. + </p> +<p> + The first version of <code class="computeroutput"><span class="identifier">adjacent_difference</span></code> + uses <code class="computeroutput"><span class="keyword">operator</span><span class="special">-()</span></code> + to calculate the differences. The second version uses <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> + instead of <code class="computeroutput"><span class="keyword">operator</span><span class="special">-()</span></code>. + </p> +<a name="range.reference.algorithms.numeric.adjacent_difference.definition"></a><h6> +<a name="id751925"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.numeric.adjacent_difference.requirements"></a><h6> +<a name="id751986"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.requirements">Requirements</a> + </h6> +<a name="range.reference.algorithms.numeric.adjacent_difference.for_the_first_version"></a><h6> +<a name="id752008"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_first_version">For + the first version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + If <code class="computeroutput"><span class="identifier">x</span></code> and <code class="computeroutput"><span class="identifier">y</span></code> are objects of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s value type, then + <code class="computeroutput"><span class="identifier">x</span> <span class="special">-</span> + <span class="identifier">y</span></code> is defined. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +<li class="listitem"> + The return type of <code class="computeroutput"><span class="identifier">x</span> <span class="special">-</span> <span class="identifier">y</span></code> + is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.adjacent_difference.for_the_second_version"></a><h6> +<a name="id752216"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_second_version">For + the second version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to <code class="computeroutput"><span class="identifier">BinaryOperation</span></code>'s + first and second argument types. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +<li class="listitem"> + The result type of <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> + is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.adjacent_difference.precondition_"></a><h6> +<a name="id752409"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.precondition_">Precondition:</a> + </h6> +<p> + <code class="computeroutput"><span class="special">[</span><span class="identifier">result</span><span class="special">,</span> <span class="identifier">result</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range. + </p> +<a name="range.reference.algorithms.numeric.adjacent_difference.complexity"></a><h6> +<a name="id752483"></a> + <a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.complexity">Complexity</a> + </h6> +<p> + Linear. If <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + then zero applications, otherwise <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + applications are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="accumulate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="inner_product.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/numeric/inner_product.html b/libs/range/doc/html/range/reference/algorithms/numeric/inner_product.html new file mode 100644 index 0000000000..bebd578286 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/numeric/inner_product.html @@ -0,0 +1,191 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>inner_product</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../numeric.html" title="Numeric algorithms"> +<link rel="prev" href="adjacent_difference.html" title="adjacent_difference"> +<link rel="next" href="partial_sum.html" title="partial_sum"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adjacent_difference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="partial_sum.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.numeric.inner_product"></a><a class="link" href="inner_product.html" title="inner_product">inner_product</a> +</h5></div></div></div> +<a name="range.reference.algorithms.numeric.inner_product.prototype"></a><h6> +<a name="id752584"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> + <span class="identifier">Value</span> <span class="identifier">inner_product</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">Value</span> <span class="identifier">init</span> <span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryOperation1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryOperation2</span><span class="special">></span> + <span class="identifier">Value</span> <span class="identifier">inner_product</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">Value</span> <span class="identifier">init</span><span class="special">,</span> + <span class="identifier">BinaryOperation1</span> <span class="identifier">op1</span> <span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.numeric.inner_product.description"></a><h6> +<a name="id752946"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">inner_product</span></code> calculates + a generalised inner product of the range <code class="computeroutput"><span class="identifier">rng1</span></code> + and <code class="computeroutput"><span class="identifier">rng2</span></code>. + </p> +<p> + For further information on the <code class="computeroutput"><span class="identifier">inner_product</span></code> + algorithm please see <a href="http://www.sgi.com/tech/stl/inner_product.html" target="_top">inner_product</a>. + </p> +<a name="range.reference.algorithms.numeric.inner_product.definition"></a><h6> +<a name="id753022"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.numeric.inner_product.requirements"></a><h6> +<a name="id753084"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.requirements">Requirements</a> + </h6> +<a name="range.reference.algorithms.numeric.inner_product.for_the_first_version"></a><h6> +<a name="id753104"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_first_version">For + the first version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + If <code class="computeroutput"><span class="identifier">x</span></code> is an object + of type <code class="computeroutput"><span class="identifier">Value</span></code>, <code class="computeroutput"><span class="identifier">y</span></code> is an object of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s value type, + and <code class="computeroutput"><span class="identifier">z</span></code> is an object + of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type, then <code class="computeroutput"><span class="identifier">x</span> <span class="special">+</span> <span class="identifier">y</span> <span class="special">*</span> <span class="identifier">z</span></code> + is defined. + </li> +<li class="listitem"> + The result type of the expression <code class="computeroutput"><span class="identifier">x</span> + <span class="special">+</span> <span class="identifier">y</span> + <span class="special">*</span> <span class="identifier">z</span></code> + is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.inner_product.for_the_second_version"></a><h6> +<a name="id753362"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_second_version">For + the second version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is a model + of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code> + is a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code> + is a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is convertible to the first argument type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is convertible to the second argument type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Value</span></code> is convertible + to the value type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code>. + </li> +<li class="listitem"> + The return type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code> + is convertible to the second argument type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code>. + </li> +<li class="listitem"> + The return type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code> + is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.inner_product.precondition_"></a><h6> +<a name="id753663"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.precondition_">Precondition:</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">>=</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> is a valid range. + </p> +<a name="range.reference.algorithms.numeric.inner_product.complexity"></a><h6> +<a name="id753736"></a> + <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.complexity">Complexity</a> + </h6> +<p> + Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="adjacent_difference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="partial_sum.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/numeric/partial_sum.html b/libs/range/doc/html/range/reference/algorithms/numeric/partial_sum.html new file mode 100644 index 0000000000..68accc119b --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/numeric/partial_sum.html @@ -0,0 +1,160 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>partial_sum</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../numeric.html" title="Numeric algorithms"> +<link rel="prev" href="inner_product.html" title="inner_product"> +<link rel="next" href="../../ranges.html" title="Provided Ranges"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inner_product.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../ranges.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.numeric.partial_sum"></a><a class="link" href="partial_sum.html" title="partial_sum">partial_sum</a> +</h5></div></div></div> +<a name="range.reference.algorithms.numeric.partial_sum.prototype"></a><h6> +<a name="id753801"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">partial_sum</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryOperation</span><span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">partial_sum</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">,</span> + <span class="identifier">BinaryOperation</span> <span class="identifier">op</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.numeric.partial_sum.description"></a><h6> +<a name="id754058"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">partial_sum</span></code> calculates + a generalised partial sum of <code class="computeroutput"><span class="identifier">rng</span></code> + in the same manner as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">partial_sum</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">out_it</span><span class="special">)</span></code>. See <a href="http://www.sgi.com/tech/stl/partial_sum.html" target="_top">partial_sum</a>. + </p> +<a name="range.reference.algorithms.numeric.partial_sum.definition"></a><h6> +<a name="id754198"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.numeric.partial_sum.requirements"></a><h6> +<a name="id754259"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.requirements">Requirements</a> + </h6> +<a name="range.reference.algorithms.numeric.partial_sum.for_the_first_version"></a><h6> +<a name="id754280"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.for_the_first_version">For + the first version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + If <code class="computeroutput"><span class="identifier">x</span></code> and <code class="computeroutput"><span class="identifier">y</span></code> are objects of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s value type, then + <code class="computeroutput"><span class="identifier">x</span> <span class="special">+</span> + <span class="identifier">y</span></code> is defined. + </li> +<li class="listitem"> + The return type of <code class="computeroutput"><span class="identifier">x</span> <span class="special">+</span> <span class="identifier">y</span></code> + is convertible to the value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.partial_sum.for_the_second_version"></a><h6> +<a name="id754487"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.for_the_second_version">For + the second version</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is + a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> is + a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. + </li> +<li class="listitem"> + The result type of <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> + is convertible to the value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>. + </li> +<li class="listitem"> + The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> + is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s + set of value types. + </li> +</ol></div> +<a name="range.reference.algorithms.numeric.partial_sum.precondition_"></a><h6> +<a name="id754652"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.precondition_">Precondition:</a> + </h6> +<p> + <code class="computeroutput"><span class="special">[</span><span class="identifier">result</span><span class="special">,</span> <span class="identifier">result</span> + <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range. + </p> +<a name="range.reference.algorithms.numeric.partial_sum.complexity"></a><h6> +<a name="id754726"></a> + <a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.complexity">Complexity</a> + </h6> +<p> + Linear. If <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + then zero applications, otherwise <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> + applications are performed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inner_product.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../ranges.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/permutation.html b/libs/range/doc/html/range/reference/algorithms/permutation.html new file mode 100644 index 0000000000..d596b341e1 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/permutation.html @@ -0,0 +1,48 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Permutation algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="heap/sort_heap.html" title="sort_heap"> +<link rel="next" href="permutation/next_permutation.html" title="next_permutation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="heap/sort_heap.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="permutation/next_permutation.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.permutation"></a><a class="link" href="permutation.html" title="Permutation algorithms">Permutation + algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="permutation/next_permutation.html">next_permutation</a></span></dt> +<dt><span class="section"><a href="permutation/prev_permutation.html">prev_permutation</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="heap/sort_heap.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="permutation/next_permutation.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/permutation/next_permutation.html b/libs/range/doc/html/range/reference/algorithms/permutation/next_permutation.html new file mode 100644 index 0000000000..1f303914bf --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/permutation/next_permutation.html @@ -0,0 +1,148 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>next_permutation</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../permutation.html" title="Permutation algorithms"> +<link rel="prev" href="../permutation.html" title="Permutation algorithms"> +<link rel="next" href="prev_permutation.html" title="prev_permutation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../permutation.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../permutation.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="prev_permutation.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.permutation.next_permutation"></a><a class="link" href="next_permutation.html" title="next_permutation">next_permutation</a> +</h5></div></div></div> +<a name="range.reference.algorithms.permutation.next_permutation.prototype"></a><h6> +<a name="id743032"></a> + <a class="link" href="next_permutation.html#range.reference.algorithms.permutation.next_permutation.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">next_permutation</span><span class="special">(</span><span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">next_permutation</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">next_permutation</span><span class="special">(</span><span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">next_permutation</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.permutation.next_permutation.description"></a><h6> +<a name="id743378"></a> + <a class="link" href="next_permutation.html#range.reference.algorithms.permutation.next_permutation.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">next_permutation</span></code> transforms + the range of elements <code class="computeroutput"><span class="identifier">rng</span></code> + into the lexicographically next greater permutation of the elements if + such a permutation exists. If one does not exist then the range is transformed + into the lexicographically smallest permutation and <code class="computeroutput"><span class="keyword">false</span></code> + is returned. <code class="computeroutput"><span class="keyword">true</span></code> is returned + when the next greater permutation is successfully generated. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.permutation.next_permutation.definition"></a><h6> +<a name="id743477"></a> + <a class="link" href="next_permutation.html#range.reference.algorithms.permutation.next_permutation.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">permutation</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.permutation.next_permutation.requirements"></a><h6> +<a name="id743548"></a> + <a class="link" href="next_permutation.html#range.reference.algorithms.permutation.next_permutation.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Compare</span></code> is a model + of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.permutation.next_permutation.complexity"></a><h6> +<a name="id743796"></a> + <a class="link" href="next_permutation.html#range.reference.algorithms.permutation.next_permutation.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">/</span> <span class="number">2</span></code> + swaps. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../permutation.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../permutation.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="prev_permutation.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/permutation/prev_permutation.html b/libs/range/doc/html/range/reference/algorithms/permutation/prev_permutation.html new file mode 100644 index 0000000000..c43900a189 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/permutation/prev_permutation.html @@ -0,0 +1,148 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>prev_permutation</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../permutation.html" title="Permutation algorithms"> +<link rel="prev" href="next_permutation.html" title="next_permutation"> +<link rel="next" href="../new.html" title="New algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="next_permutation.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../permutation.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../new.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.permutation.prev_permutation"></a><a class="link" href="prev_permutation.html" title="prev_permutation">prev_permutation</a> +</h5></div></div></div> +<a name="range.reference.algorithms.permutation.prev_permutation.prototype"></a><h6> +<a name="id743872"></a> + <a class="link" href="prev_permutation.html#range.reference.algorithms.permutation.prev_permutation.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">prev_permutation</span><span class="special">(</span><span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">prev_permutation</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">prev_permutation</span><span class="special">(</span><span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">prev_permutation</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.permutation.prev_permutation.description"></a><h6> +<a name="id744218"></a> + <a class="link" href="prev_permutation.html#range.reference.algorithms.permutation.prev_permutation.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">prev_permutation</span></code> transforms + the range of elements <code class="computeroutput"><span class="identifier">rng</span></code> + into the lexicographically next smaller permutation of the elements if + such a permutation exists. If one does not exist then the range is transformed + into the lexicographically largest permutation and <code class="computeroutput"><span class="keyword">false</span></code> + is returned. <code class="computeroutput"><span class="keyword">true</span></code> is returned + when the next smaller permutation is successfully generated. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.permutation.prev_permutation.definition"></a><h6> +<a name="id744318"></a> + <a class="link" href="prev_permutation.html#range.reference.algorithms.permutation.prev_permutation.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">permutation</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.permutation.prev_permutation.requirements"></a><h6> +<a name="id744389"></a> + <a class="link" href="prev_permutation.html#range.reference.algorithms.permutation.prev_permutation.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional + Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> + is mutable. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Compare</span></code> is a model + of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s + value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s + argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.permutation.prev_permutation.complexity"></a><h6> +<a name="id744638"></a> + <a class="link" href="prev_permutation.html#range.reference.algorithms.permutation.prev_permutation.complexity">Complexity</a> + </h6> +<p> + Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">/</span> <span class="number">2</span></code> + swaps. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="next_permutation.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../permutation.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../new.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/range_algorithm_introduction.html b/libs/range/doc/html/range/reference/algorithms/range_algorithm_introduction.html new file mode 100644 index 0000000000..36667b3fd6 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/range_algorithm_introduction.html @@ -0,0 +1,257 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Introduction and motivation</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithm"> +<link rel="prev" href="../algorithms.html" title="Range Algorithm"> +<link rel="next" href="mutating.html" title="Mutating algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../algorithms.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mutating.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.range_algorithm_introduction"></a><a class="link" href="range_algorithm_introduction.html" title="Introduction and motivation"> + Introduction and motivation</a> +</h4></div></div></div> +<p> + In its most simple form a <span class="bold"><strong>Range Algorithm</strong></span> + (or range-based algorithm) is simply an iterator-based algorithm where + the <span class="emphasis"><em>two</em></span> iterator arguments have been replaced by + <span class="emphasis"><em>one</em></span> range argument. For example, we may write + </p> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span> <span class="special">=</span> <span class="special">...;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">);</span> +</pre> +<p> + </p> +<p> + instead of + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span> +</pre> +<p> + </p> +<p> + However, the return type of range algorithms is almost always different + from that of existing iterator-based algorithms. + </p> +<p> + One group of algorithms, like <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">()</span></code>, will simply return the same range so + that we can continue to pass the range around and/or further modify it. + Because of this we may write +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">:</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">));</span> +</pre> +<p> + to first sort the range and then run <code class="computeroutput"><span class="identifier">unique</span><span class="special">()</span></code> on the sorted range. + </p> +<p> + Algorithms like <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special">()</span></code> + fall into another group of algorithms that return (potentially) narrowed + views of the original range. By default <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">found</span><span class="special">)</span></code> + where <code class="computeroutput"><span class="identifier">found</span></code> denotes the + iterator returned by <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + </p> +<p> + Therefore exactly the unique values can be copied by writing +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">)),</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special"><</span><span class="keyword">int</span><span class="special">>(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">));</span> +</pre> +<p> + </p> +<p> + Algorithms like <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span></code> usually return the same range: + <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">found</span><span class="special">)</span></code>. However, this behaviour may be changed + by supplying the algorithms with a template argument: + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns a single iterator like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_begin_found</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> + <span class="identifier">found</span><span class="special">)</span></code> + (this is the default) + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_begin_next</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">next</span><span class="special">(</span><span class="identifier">found</span><span class="special">))</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found_end</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">found</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_next_end</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the range <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">next</span><span class="special">(</span><span class="identifier">found</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_begin_end</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + returns the entire original range. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + This functionality has the following advantages: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + it allows for <span class="emphasis"><em><span class="bold"><strong>seamless functional-style + programming</strong></span></em></span> where you do not need to use named + local variables to store intermediate results + </li> +<li class="listitem"> + it is very <span class="emphasis"><em><span class="bold"><strong>safe</strong></span></em></span> + because the algorithm can verify out-of-bounds conditions and handle + tricky conditions that lead to empty ranges + </li> +</ol></div> +<p> + For example, consider how easy we may erase the duplicates in a sorted + container: + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span> <span class="special">=</span> <span class="special">...;</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found_end</span><span class="special">>(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">)));</span> +</pre> +<p> + </p> +<p> + Notice the use of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_found_end</span></code>. + What if we wanted to erase all the duplicates except one of them? In old-fashined + STL-programming we might write + </p> +<p> + +</p> +<pre class="programlisting"><span class="comment">// assume 'vec' is already sorted +</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">>::</span><span class="identifier">iterator</span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span> + +<span class="comment">// remember this check or you get into problems +</span><span class="keyword">if</span> <span class="special">(</span><span class="identifier">i</span> <span class="special">!=</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span> + <span class="special">++</span><span class="identifier">i</span><span class="special">;</span> + +<span class="identifier">vec</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span> +</pre> +<p> + </p> +<p> + The same task may be accomplished simply with +</p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unique</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">return_next_end</span><span class="special">>(</span><span class="identifier">vec</span><span class="special">));</span> +</pre> +<p> + and there is no need to worry about generating an invalid range. Furthermore, + if the container is complex, calling <code class="computeroutput"><span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code> several times will be more expensive + than using a range algorithm. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../algorithms.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mutating.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/set.html b/libs/range/doc/html/range/reference/algorithms/set.html new file mode 100644 index 0000000000..2d31545578 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/set.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Set algorithms</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../algorithms.html" title="Range Algorithms"> +<link rel="prev" href="non_mutating/upper_bound.html" title="upper_bound"> +<link rel="next" href="set/includes.html" title="includes"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="non_mutating/upper_bound.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set/includes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.algorithms.set"></a><a class="link" href="set.html" title="Set algorithms">Set algorithms</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="set/includes.html">includes</a></span></dt> +<dt><span class="section"><a href="set/set_union.html">set_union</a></span></dt> +<dt><span class="section"><a href="set/set_intersection.html">set_intersection</a></span></dt> +<dt><span class="section"><a href="set/set_difference.html">set_difference</a></span></dt> +<dt><span class="section"><a href="set/set_symmetric_difference.html">set_symmetric_difference</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="non_mutating/upper_bound.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set/includes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/set/includes.html b/libs/range/doc/html/range/reference/algorithms/set/includes.html new file mode 100644 index 0000000000..9baedb3a99 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/set/includes.html @@ -0,0 +1,186 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>includes</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../set.html" title="Set algorithms"> +<link rel="prev" href="../set.html" title="Set algorithms"> +<link rel="next" href="set_union.html" title="set_union"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../set.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_union.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.set.includes"></a><a class="link" href="includes.html" title="includes">includes</a> +</h5></div></div></div> +<a name="range.reference.algorithms.set.includes.prototype"></a><h6> +<a name="id733300"></a> + <a class="link" href="includes.html#range.reference.algorithms.set.includes.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">includes</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="keyword">bool</span> <span class="identifier">includes</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.set.includes.description"></a><h6> +<a name="id733580"></a> + <a class="link" href="includes.html#range.reference.algorithms.set.includes.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">includes</span></code> returns <code class="computeroutput"><span class="keyword">true</span></code> if and only if, for every element + in <code class="computeroutput"><span class="identifier">rng2</span></code>, an equivalent + element is also present in <code class="computeroutput"><span class="identifier">rng1</span></code>. + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.set.includes.definition"></a><h6> +<a name="id733674"></a> + <a class="link" href="includes.html#range.reference.algorithms.set.includes.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.set.includes.requirements"></a><h6> +<a name="id733743"></a> + <a class="link" href="includes.html#range.reference.algorithms.set.includes.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.set.includes.precondition_"></a><h6> +<a name="id734152"></a> + <a class="link" href="includes.html#range.reference.algorithms.set.includes.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.set.includes.complexity"></a><h6> +<a name="id734266"></a> + <a class="link" href="includes.html#range.reference.algorithms.set.includes.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../set.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_union.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/set/set_difference.html b/libs/range/doc/html/range/reference/algorithms/set/set_difference.html new file mode 100644 index 0000000000..7712445d93 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/set/set_difference.html @@ -0,0 +1,205 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>set_difference</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../set.html" title="Set algorithms"> +<link rel="prev" href="set_intersection.html" title="set_intersection"> +<link rel="next" href="set_symmetric_difference.html" title="set_symmetric_difference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set_intersection.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_symmetric_difference.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.set.set_difference"></a><a class="link" href="set_difference.html" title="set_difference">set_difference</a> +</h5></div></div></div> +<a name="range.reference.algorithms.set.set_difference.prototype"></a><h6> +<a name="id736793"></a> + <a class="link" href="set_difference.html#range.reference.algorithms.set.set_difference.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">set_difference</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">set_difference</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.set.set_difference.description"></a><h6> +<a name="id737139"></a> + <a class="link" href="set_difference.html#range.reference.algorithms.set.set_difference.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">set_difference</span></code> constructs + a sorted range that is the set difference of the sorted ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code>. + The return value is the end of the output range. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.set.set_difference.definition"></a><h6> +<a name="id737226"></a> + <a class="link" href="set_difference.html#range.reference.algorithms.set.set_difference.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.set.set_difference.requirements"></a><h6> +<a name="id737297"></a> + <a class="link" href="set_difference.html#range.reference.algorithms.set.set_difference.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.set.set_difference.precondition_"></a><h6> +<a name="id737763"></a> + <a class="link" href="set_difference.html#range.reference.algorithms.set.set_difference.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.set.set_difference.complexity"></a><h6> +<a name="id737877"></a> + <a class="link" href="set_difference.html#range.reference.algorithms.set.set_difference.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set_intersection.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_symmetric_difference.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/set/set_intersection.html b/libs/range/doc/html/range/reference/algorithms/set/set_intersection.html new file mode 100644 index 0000000000..1a2040d88b --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/set/set_intersection.html @@ -0,0 +1,205 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>set_intersection</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../set.html" title="Set algorithms"> +<link rel="prev" href="set_union.html" title="set_union"> +<link rel="next" href="set_difference.html" title="set_difference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set_union.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_difference.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.set.set_intersection"></a><a class="link" href="set_intersection.html" title="set_intersection">set_intersection</a> +</h5></div></div></div> +<a name="range.reference.algorithms.set.set_intersection.prototype"></a><h6> +<a name="id735588"></a> + <a class="link" href="set_intersection.html#range.reference.algorithms.set.set_intersection.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">set_intersection</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">set_intersection</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.set.set_intersection.description"></a><h6> +<a name="id735934"></a> + <a class="link" href="set_intersection.html#range.reference.algorithms.set.set_intersection.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">set_intersection</span></code> constructs + a sorted range that is the intersection of the sorted ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code>. + The return value is the end of the output range. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.set.set_intersection.definition"></a><h6> +<a name="id736021"></a> + <a class="link" href="set_intersection.html#range.reference.algorithms.set.set_intersection.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.set.set_intersection.requirements"></a><h6> +<a name="id736091"></a> + <a class="link" href="set_intersection.html#range.reference.algorithms.set.set_intersection.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.set.set_intersection.precondition_"></a><h6> +<a name="id736557"></a> + <a class="link" href="set_intersection.html#range.reference.algorithms.set.set_intersection.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.set.set_intersection.complexity"></a><h6> +<a name="id736671"></a> + <a class="link" href="set_intersection.html#range.reference.algorithms.set.set_intersection.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set_union.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_difference.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/set/set_symmetric_difference.html b/libs/range/doc/html/range/reference/algorithms/set/set_symmetric_difference.html new file mode 100644 index 0000000000..215facc96e --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/set/set_symmetric_difference.html @@ -0,0 +1,209 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>set_symmetric_difference</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../set.html" title="Set algorithms"> +<link rel="prev" href="set_difference.html" title="set_difference"> +<link rel="next" href="../heap.html" title="Heap algorithms"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set_difference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.set.set_symmetric_difference"></a><a class="link" href="set_symmetric_difference.html" title="set_symmetric_difference">set_symmetric_difference</a> +</h5></div></div></div> +<a name="range.reference.algorithms.set.set_symmetric_difference.prototype"></a><h6> +<a name="id738000"></a> + <a class="link" href="set_symmetric_difference.html#range.reference.algorithms.set.set_symmetric_difference.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> +<span class="identifier">set_symmetric_difference</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> +<span class="identifier">set_symmetric_difference</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.algorithms.set.set_symmetric_difference.description"></a><h6> +<a name="id738347"></a> + <a class="link" href="set_symmetric_difference.html#range.reference.algorithms.set.set_symmetric_difference.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">set_symmetric_difference</span></code> + constructs a sorted range that is the set symmetric difference of the + sorted ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and + <code class="computeroutput"><span class="identifier">rng2</span></code>. The return value + is the end of the output range. + </p> +<p> + The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> in the non-predicate versions, and + by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in + the predicate versions. + </p> +<a name="range.reference.algorithms.set.set_symmetric_difference.definition"></a><h6> +<a name="id738434"></a> + <a class="link" href="set_symmetric_difference.html#range.reference.algorithms.set.set_symmetric_difference.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.set.set_symmetric_difference.requirements"></a><h6> +<a name="id738504"></a> + <a class="link" href="set_symmetric_difference.html#range.reference.algorithms.set.set_symmetric_difference.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.set.set_symmetric_difference.precondition_"></a><h6> +<a name="id738968"></a> + <a class="link" href="set_symmetric_difference.html#range.reference.algorithms.set.set_symmetric_difference.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.set.set_symmetric_difference.complexity"></a><h6> +<a name="id739082"></a> + <a class="link" href="set_symmetric_difference.html#range.reference.algorithms.set.set_symmetric_difference.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="set_difference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/algorithms/set/set_union.html b/libs/range/doc/html/range/reference/algorithms/set/set_union.html new file mode 100644 index 0000000000..5dc51760c2 --- /dev/null +++ b/libs/range/doc/html/range/reference/algorithms/set/set_union.html @@ -0,0 +1,204 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>set_union</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../set.html" title="Set algorithms"> +<link rel="prev" href="includes.html" title="includes"> +<link rel="next" href="set_intersection.html" title="set_intersection"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="includes.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_intersection.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.algorithms.set.set_union"></a><a class="link" href="set_union.html" title="set_union">set_union</a> +</h5></div></div></div> +<a name="range.reference.algorithms.set.set_union.prototype"></a><h6> +<a name="id734387"></a> + <a class="link" href="set_union.html#range.reference.algorithms.set.set_union.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">set_union</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> + <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> + <span class="special">></span> +<span class="identifier">OutputIterator</span> <span class="identifier">set_union</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> + <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> + <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> + </pre> +<p> + </p> +<a name="range.reference.algorithms.set.set_union.description"></a><h6> +<a name="id734733"></a> + <a class="link" href="set_union.html#range.reference.algorithms.set.set_union.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">set_union</span></code> constructs + a sorted range that is the union of the sorted ranges <code class="computeroutput"><span class="identifier">rng1</span></code> + and <code class="computeroutput"><span class="identifier">rng2</span></code>. The return + value is the end of the output range. The ordering relationship is determined + by using <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code> + in the non-predicate versions, and by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> + in the predicate versions. + </p> +<a name="range.reference.algorithms.set.set_union.definition"></a><h6> +<a name="id734816"></a> + <a class="link" href="set_union.html#range.reference.algorithms.set.set_union.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">set_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.algorithms.set.set_union.requirements"></a><h6> +<a name="id734887"></a> + <a class="link" href="set_union.html#range.reference.algorithms.set.set_union.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +<li class="listitem"> + The ordering of objects of type <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, + as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> + requirements. + </li> +</ul></div> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is + a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> + and <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> + have the same value type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is + a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + first argument type. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s + value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s + second argument types. + </li> +</ul></div> +<a name="range.reference.algorithms.set.set_union.precondition_"></a><h6> +<a name="id735352"></a> + <a class="link" href="set_union.html#range.reference.algorithms.set.set_union.precondition_">Precondition:</a> + </h6> +<p> + <span class="bold"><strong>For the non-predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. + </p> +<p> + <span class="bold"><strong>For the predicate versions:</strong></span> + </p> +<p> + <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> are sorted in ascending order + according to <code class="computeroutput"><span class="identifier">pred</span></code>. + </p> +<a name="range.reference.algorithms.set.set_union.complexity"></a><h6> +<a name="id735465"></a> + <a class="link" href="set_union.html#range.reference.algorithms.set.set_union.complexity">Complexity</a> + </h6> +<p> + Linear. <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="includes.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_intersection.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/concept_implementation.html b/libs/range/doc/html/range/reference/concept_implementation.html new file mode 100644 index 0000000000..3c57172f50 --- /dev/null +++ b/libs/range/doc/html/range/reference/concept_implementation.html @@ -0,0 +1,48 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Range concept implementation</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="overview.html" title="Overview"> +<link rel="next" href="concept_implementation/synopsis.html" title="Synopsis"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concept_implementation/synopsis.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.concept_implementation"></a><a class="link" href="concept_implementation.html" title="Range concept implementation">Range concept + implementation</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="concept_implementation/synopsis.html">Synopsis</a></span></dt> +<dt><span class="section"><a href="concept_implementation/semantics.html">Semantics</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concept_implementation/synopsis.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/concept_implementation/semantics.html b/libs/range/doc/html/range/reference/concept_implementation/semantics.html new file mode 100644 index 0000000000..0aed2faf08 --- /dev/null +++ b/libs/range/doc/html/range/reference/concept_implementation/semantics.html @@ -0,0 +1,163 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Semantics</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concept_implementation.html" title="Range concept implementation"> +<link rel="prev" href="synopsis.html" title="Synopsis"> +<link rel="next" href="semantics/metafunctions.html" title="Metafunctions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="synopsis.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concept_implementation.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="semantics/metafunctions.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.concept_implementation.semantics"></a><a class="link" href="semantics.html" title="Semantics">Semantics</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="semantics/metafunctions.html">Metafunctions</a></span></dt> +<dt><span class="section"><a href="semantics/functions.html">Functions</a></span></dt> +</dl></div> +<a name="range.reference.concept_implementation.semantics.notation"></a><h6> +<a name="id654700"></a> + <a class="link" href="semantics.html#range.reference.concept_implementation.semantics.notation">notation</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Type + </p> + </th> +<th> + <p> + Object + </p> + </th> +<th> + <p> + Describes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">X</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">x</span></code> + </p> + </td> +<td> + <p> + any type + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">T</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">t</span></code> + </p> + </td> +<td> + <p> + denotes behavior of the primary templates + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">P</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">p</span></code> + </p> + </td> +<td> + <p> + denotes <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">,</span><span class="identifier">iterator</span><span class="special">></span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">A</span><span class="special">[</span><span class="identifier">sz</span><span class="special">]</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">a</span></code> + </p> + </td> +<td> + <p> + denotes an array of type <code class="computeroutput"><span class="identifier">A</span></code> + of size <code class="computeroutput"><span class="identifier">sz</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">Char</span><span class="special">*</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">s</span></code> + </p> + </td> +<td> + <p> + denotes either <code class="computeroutput"><span class="keyword">char</span><span class="special">*</span></code> or <code class="computeroutput"><span class="keyword">wchar_t</span><span class="special">*</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="synopsis.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concept_implementation.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="semantics/metafunctions.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/concept_implementation/semantics/functions.html b/libs/range/doc/html/range/reference/concept_implementation/semantics/functions.html new file mode 100644 index 0000000000..55f8a17c94 --- /dev/null +++ b/libs/range/doc/html/range/reference/concept_implementation/semantics/functions.html @@ -0,0 +1,410 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Functions</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../semantics.html" title="Semantics"> +<link rel="prev" href="metafunctions.html" title="Metafunctions"> +<link rel="next" href="../../adaptors.html" title="Range Adaptors"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="metafunctions.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../semantics.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../adaptors.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.concept_implementation.semantics.functions"></a><a class="link" href="functions.html" title="Functions">Functions</a> +</h5></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return type + </p> + </th> +<th> + <p> + Returns + </p> + </th> +<th> + <p> + Complexity + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">first</span></code> if <code class="computeroutput"><span class="identifier">p</span></code> + is of type <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code> <code class="computeroutput"><span class="identifier">a</span></code> + if <code class="computeroutput"><span class="identifier">a</span></code> is an + array <code class="computeroutput"><span class="identifier">range_begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> if that expression would invoke + a function found by ADL <code class="computeroutput"><span class="identifier">t</span><span class="special">.</span><span class="identifier">begin</span><span class="special">()</span></code> otherwise + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">second</span></code> if <code class="computeroutput"><span class="identifier">p</span></code> + is of type <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code> <code class="computeroutput"><span class="identifier">a</span> + <span class="special">+</span> <span class="identifier">sz</span></code> + if <code class="computeroutput"><span class="identifier">a</span></code> is an + array of size <code class="computeroutput"><span class="identifier">sz</span></code> + <code class="computeroutput"><span class="identifier">range_end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + if that expression would invoke a function found by ADL <code class="computeroutput"><span class="identifier">t</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code> + otherwise + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="keyword">bool</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> + <span class="special">==</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + - + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">size</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_calculate_size</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> which by default is <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> + <span class="special">-</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code>. Users may supply alternative + implementations by implementing <code class="computeroutput"><span class="identifier">range_calculate_size</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> so that it will be found via + ADL + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">rend</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">const_begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">const_end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">const_rbegin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">const_rend</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td> + <p> + constant time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">as_literal</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span></code> where <code class="computeroutput"><span class="identifier">U</span></code> + is <code class="computeroutput"><span class="identifier">Char</span><span class="special">*</span></code> + if <code class="computeroutput"><span class="identifier">x</span></code> is a pointer + to a string and <code class="computeroutput"><span class="identifier">U</span></code> + is <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + otherwise + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="special">[</span><span class="identifier">s</span><span class="special">,</span><span class="identifier">s</span> + <span class="special">+</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">length</span><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></code> if <code class="computeroutput"><span class="identifier">s</span></code> + is a <code class="computeroutput"><span class="identifier">Char</span><span class="special">*</span></code> + or an array of <code class="computeroutput"><span class="identifier">Char</span></code> + <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> otherwise + </p> + </td> +<td> + <p> + linear time for pointers to a string or arrays of <code class="computeroutput"><span class="identifier">Char</span></code>, constant time otherwise + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">as_array</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">X</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="special">[</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">),</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span></code> + </p> + </td> +<td class="auto-generated"> </td> +</tr> +</tbody> +</table></div> +<p> + The special <code class="computeroutput"><span class="identifier">const_</span></code>-named + functions are useful when you want to document clearly that your code + is read-only. + </p> +<p> + <code class="computeroutput"><span class="identifier">as_literal</span><span class="special">()</span></code> + can be used <span class="emphasis"><em><span class="bold"><strong>internally</strong></span></em></span> + in string algorithm libraries such that arrays of characters are handled + correctly. + </p> +<p> + <code class="computeroutput"><span class="identifier">as_array</span><span class="special">()</span></code> + can be used with string algorithm libraries to make it clear that arrays + of characters are handled like an array and not like a string. + </p> +<p> + Notice that the above functions should always be called with qualification + (<code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span></code>) + to prevent <span class="emphasis"><em><span class="bold"><strong>unintended</strong></span></em></span> + Argument Dependent Lookup (ADL). + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="metafunctions.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../semantics.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../adaptors.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/concept_implementation/semantics/metafunctions.html b/libs/range/doc/html/range/reference/concept_implementation/semantics/metafunctions.html new file mode 100644 index 0000000000..bafa0af0c6 --- /dev/null +++ b/libs/range/doc/html/range/reference/concept_implementation/semantics/metafunctions.html @@ -0,0 +1,274 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Metafunctions</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../semantics.html" title="Semantics"> +<link rel="prev" href="../semantics.html" title="Semantics"> +<link rel="next" href="functions.html" title="Functions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../semantics.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../semantics.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="functions.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.concept_implementation.semantics.metafunctions"></a><a class="link" href="metafunctions.html" title="Metafunctions">Metafunctions</a> +</h5></div></div></div> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Expression + </p> + </th> +<th> + <p> + Return type + </p> + </th> +<th> + <p> + Complexity + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">T</span><span class="special">::</span><span class="identifier">iterator</span> +<span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span> +<span class="identifier">A</span><span class="special">*</span> +</pre> +<p> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">T</span><span class="special">::</span><span class="identifier">const_iterator</span> +<span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span> +<span class="keyword">const</span> <span class="identifier">A</span><span class="special">*</span> +</pre> +<p> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_value</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_reference</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_pointer</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_pointer</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_category</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_category</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_category</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special"><</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">has_range_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code> if <code class="computeroutput"><span class="identifier">range_mutable_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + is a valid expression, <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code> + otherwise + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">has_range_const_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code> if <code class="computeroutput"><span class="identifier">range_const_iterator</span><span class="special"><</span><span class="identifier">X</span><span class="special">>::</span><span class="identifier">type</span></code> + is a valid expression, <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code> + otherwise + </p> + </td> +<td> + <p> + compile time + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../semantics.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../semantics.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="functions.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/concept_implementation/synopsis.html b/libs/range/doc/html/range/reference/concept_implementation/synopsis.html new file mode 100644 index 0000000000..9fdbc911e2 --- /dev/null +++ b/libs/range/doc/html/range/reference/concept_implementation/synopsis.html @@ -0,0 +1,185 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Synopsis</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../concept_implementation.html" title="Range concept implementation"> +<link rel="prev" href="../concept_implementation.html" title="Range concept implementation"> +<link rel="next" href="semantics.html" title="Semantics"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../concept_implementation.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concept_implementation.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="semantics.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.concept_implementation.synopsis"></a><a class="link" href="synopsis.html" title="Synopsis">Synopsis</a> +</h4></div></div></div> +<p> + +</p> +<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> +<span class="special">{</span> + <span class="comment">// +</span> <span class="comment">// Single Pass Range metafunctions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_iterator</span><span class="special">;</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_value</span><span class="special">;</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_reference</span><span class="special">;</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_pointer</span><span class="special">;</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_category</span><span class="special">;</span> + + <span class="comment">// +</span> <span class="comment">// Forward Range metafunctions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_difference</span><span class="special">;</span> + + <span class="comment">// +</span> <span class="comment">// Bidirectional Range metafunctions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_reverse_iterator</span><span class="special">;</span> + + <span class="comment">// +</span> <span class="comment">// Single Pass Range functions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">begin</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">begin</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">end</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">end</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">bool</span> + <span class="identifier">empty</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// +</span> <span class="comment">// Forward Range functions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">distance</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// +</span> <span class="comment">// Bidirectional Range functions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">rbegin</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">rbegin</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">rend</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">rend</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// +</span> <span class="comment">// Random Access Range functions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">size</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// +</span> <span class="comment">// Special const Range functions +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">const_begin</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">const_end</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">const_rbegin</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">typename</span> <span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">const_rend</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// +</span> <span class="comment">// String utilities +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="special">...</span> <span class="identifier">see</span> <span class="identifier">below</span> <span class="special">...</span> <span class="special">></span> + <span class="identifier">as_literal</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="special">...</span> <span class="identifier">see</span> <span class="identifier">below</span> <span class="special">...</span> <span class="special">></span> + <span class="identifier">as_literal</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">as_array</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">as_array</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + +<span class="special">}</span> <span class="comment">// namespace 'boost' +</span></pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../concept_implementation.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concept_implementation.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="semantics.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/extending.html b/libs/range/doc/html/range/reference/extending.html new file mode 100644 index 0000000000..6d418a1526 --- /dev/null +++ b/libs/range/doc/html/range/reference/extending.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Extending the library</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="utilities/join.html" title="Function join"> +<link rel="next" href="extending/method_1.html" title="Method 1: provide member functions and nested types"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="utilities/join.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="extending/method_1.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.extending"></a><a class="link" href="extending.html" title="Extending the library">Extending the library</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="extending/method_1.html">Method 1: provide + member functions and nested types</a></span></dt> +<dt><span class="section"><a href="extending/method_2.html">Method 2: provide + free-standing functions and specialize metafunctions</a></span></dt> +<dt><span class="section"><a href="extending/method_3.html">Method 3: provide + range adaptor implementations</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="utilities/join.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="extending/method_1.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/extending/method_1.html b/libs/range/doc/html/range/reference/extending/method_1.html new file mode 100644 index 0000000000..24b054c51a --- /dev/null +++ b/libs/range/doc/html/range/reference/extending/method_1.html @@ -0,0 +1,161 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Method 1: provide member functions and nested types</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../extending.html" title="Extending the library"> +<link rel="prev" href="../extending.html" title="Extending the library"> +<link rel="next" href="method_2.html" title="Method 2: provide free-standing functions and specialize metafunctions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../extending.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../extending.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.extending.method_1"></a><a class="link" href="method_1.html" title="Method 1: provide member functions and nested types">Method 1: provide + member functions and nested types</a> +</h4></div></div></div> +<p> + This procedure assumes that you have control over the types that should + be made conformant to a Range concept. If not, see <a class="link" href="method_2.html" title="Method 2: provide free-standing functions and specialize metafunctions">method + 2</a>. + </p> +<p> + The primary templates in this library are implemented such that standard + containers will work automatically and so will <a href="../../../../../../../libs/array/index.html" target="_top">boost::array</a>. + Below is given an overview of which member functions and member types a + class must specify to be useable as a certain Range concept. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Member function + </p> + </th> +<th> + <p> + Related concept + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">begin</span><span class="special">()</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">end</span><span class="special">()</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + Notice that <code class="computeroutput"><span class="identifier">rbegin</span><span class="special">()</span></code> + and <code class="computeroutput"><span class="identifier">rend</span><span class="special">()</span></code> + member functions are not needed even though the container can support bidirectional + iteration. + </p> +<p> + The required member types are: + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Member type + </p> + </th> +<th> + <p> + Related concept + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">iterator</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">const_iterator</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + Again one should notice that member types <code class="computeroutput"><span class="identifier">reverse_iterator</span></code> + and <code class="computeroutput"><span class="identifier">const_reverse_iterator</span></code> + are not needed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../extending.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../extending.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/extending/method_2.html b/libs/range/doc/html/range/reference/extending/method_2.html new file mode 100644 index 0000000000..24e9a37fe9 --- /dev/null +++ b/libs/range/doc/html/range/reference/extending/method_2.html @@ -0,0 +1,287 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Method 2: provide free-standing functions and specialize metafunctions</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../extending.html" title="Extending the library"> +<link rel="prev" href="method_1.html" title="Method 1: provide member functions and nested types"> +<link rel="next" href="method_3.html" title="Method 3: provide range adaptor implementations"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method_1.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../extending.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_3.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.extending.method_2"></a><a class="link" href="method_2.html" title="Method 2: provide free-standing functions and specialize metafunctions">Method 2: provide + free-standing functions and specialize metafunctions</a> +</h4></div></div></div> +<p> + This procedure assumes that you cannot (or do not wish to) change the types + that should be made conformant to a Range concept. If this is not true, + see <a class="link" href="method_1.html" title="Method 1: provide member functions and nested types">method 1</a>. + </p> +<p> + The primary templates in this library are implemented such that certain + functions are found via argument-dependent-lookup (ADL). Below is given + an overview of which free-standing functions a class must specify to be + useable as a certain Range concept. Let <code class="computeroutput"><span class="identifier">x</span></code> + be a variable (<code class="computeroutput"><span class="keyword">const</span></code> or <code class="computeroutput"><span class="keyword">mutable</span></code>) of the class in question. + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Related concept + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">range_calculate_size</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + </p> + </td> +<td> + <p> + Optional. This can be used to specify a mechanism for constant-time + computation of the size of a range. The default behaviour is + to return <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> <span class="special">-</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> + for random access ranges, and to return <code class="computeroutput"><span class="identifier">x</span><span class="special">.</span><span class="identifier">size</span><span class="special">()</span></code> for ranges with lesser traversal + capability. This behaviour can be changed by implementing <code class="computeroutput"><span class="identifier">range_calculate_size</span></code> in a manner + that will be found via ADL. The ability to calculate size in + O(1) is often possible even with ranges with traversal categories + less than random access. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + <code class="computeroutput"><span class="identifier">range_begin</span><span class="special">()</span></code> + and <code class="computeroutput"><span class="identifier">range_end</span><span class="special">()</span></code> + must be overloaded for both <code class="computeroutput"><span class="keyword">const</span></code> + and <code class="computeroutput"><span class="keyword">mutable</span></code> reference arguments. + </p> +<p> + You must also specialize two metafunctions for your type <code class="computeroutput"><span class="identifier">X</span></code>: + </p> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Metafunction + </p> + </th> +<th> + <p> + Related concept + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_mutable_iterator</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_const_iterator</span></code> + </p> + </td> +<td> + <p> + <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single Pass + Range</a> + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + A complete example is given here: + </p> +<p> + +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iterator</span><span class="special">></span> <span class="comment">// for std::iterator_traits, std::distance() +</span> +<span class="keyword">namespace</span> <span class="identifier">Foo</span> +<span class="special">{</span> + <span class="comment">// +</span> <span class="comment">// Our sample UDT. A 'Pair' +</span> <span class="comment">// will work as a range when the stored +</span> <span class="comment">// elements are iterators. +</span> <span class="comment">// +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">Pair</span> + <span class="special">{</span> + <span class="identifier">T</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">;</span> + <span class="special">};</span> + +<span class="special">}</span> <span class="comment">// namespace 'Foo' +</span> +<span class="keyword">namespace</span> <span class="identifier">boost</span> +<span class="special">{</span> + <span class="comment">// +</span> <span class="comment">// Specialize metafunctions. We must include the range.hpp header. +</span> <span class="comment">// We must open the 'boost' namespace. +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_mutable_iterator</span><span class="special"><</span> <span class="identifier">Foo</span><span class="special">::</span><span class="identifier">Pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="special">></span> + <span class="special">{</span> + <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="identifier">type</span><span class="special">;</span> + <span class="special">};</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">struct</span> <span class="identifier">range_const_iterator</span><span class="special"><</span> <span class="identifier">Foo</span><span class="special">::</span><span class="identifier">Pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="special">></span> + <span class="special">{</span> + <span class="comment">// +</span> <span class="comment">// Remark: this is defined similar to 'range_iterator' +</span> <span class="comment">// because the 'Pair' type does not distinguish +</span> <span class="comment">// between an iterator and a const_iterator. +</span> <span class="comment">// +</span> <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="identifier">type</span><span class="special">;</span> + <span class="special">};</span> + +<span class="special">}</span> <span class="comment">// namespace 'boost' +</span> +<span class="keyword">namespace</span> <span class="identifier">Foo</span> +<span class="special">{</span> + <span class="comment">// +</span> <span class="comment">// The required functions. These should be defined in +</span> <span class="comment">// the same namespace as 'Pair', in this case +</span> <span class="comment">// in namespace 'Foo'. +</span> <span class="comment">// +</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">inline</span> <span class="identifier">T</span> <span class="identifier">range_begin</span><span class="special">(</span> <span class="identifier">Pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">x</span> <span class="special">)</span> + <span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">x</span><span class="special">.</span><span class="identifier">first</span><span class="special">;</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">inline</span> <span class="identifier">T</span> <span class="identifier">range_begin</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">x</span> <span class="special">)</span> + <span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">x</span><span class="special">.</span><span class="identifier">first</span><span class="special">;</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">inline</span> <span class="identifier">T</span> <span class="identifier">range_end</span><span class="special">(</span> <span class="identifier">Pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">x</span> <span class="special">)</span> + <span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">x</span><span class="special">.</span><span class="identifier">last</span><span class="special">;</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">T</span> <span class="special">></span> + <span class="keyword">inline</span> <span class="identifier">T</span> <span class="identifier">range_end</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Pair</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">x</span> <span class="special">)</span> + <span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">x</span><span class="special">.</span><span class="identifier">last</span><span class="special">;</span> + <span class="special">}</span> + +<span class="special">}</span> <span class="comment">// namespace 'Foo' +</span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">vector</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span> +<span class="special">{</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">>::</span><span class="identifier">iterator</span> <span class="identifier">iter</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span> + <span class="identifier">Foo</span><span class="special">::</span><span class="identifier">Pair</span><span class="special"><</span><span class="identifier">iter</span><span class="special">></span> <span class="identifier">pair</span> <span class="special">=</span> <span class="special">{</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span> <span class="special">};</span> + <span class="keyword">const</span> <span class="identifier">Foo</span><span class="special">::</span><span class="identifier">Pair</span><span class="special"><</span><span class="identifier">iter</span><span class="special">>&</span> <span class="identifier">cpair</span> <span class="special">=</span> <span class="identifier">pair</span><span class="special">;</span> + <span class="comment">// +</span> <span class="comment">// Notice that we call 'begin' etc with qualification. +</span> <span class="comment">// +</span> <span class="identifier">iter</span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pair</span> <span class="special">);</span> + <span class="identifier">iter</span> <span class="identifier">e</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span> <span class="identifier">pair</span> <span class="special">);</span> + <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span> <span class="identifier">cpair</span> <span class="special">);</span> + <span class="identifier">e</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span> <span class="identifier">cpair</span> <span class="special">);</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_difference</span><span class="special"><</span> <span class="identifier">Foo</span><span class="special">::</span><span class="identifier">Pair</span><span class="special"><</span><span class="identifier">iter</span><span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">s</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span> <span class="identifier">pair</span> <span class="special">);</span> + <span class="identifier">s</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span> <span class="identifier">cpair</span> <span class="special">);</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reverse_iterator</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">Foo</span><span class="special">::</span><span class="identifier">Pair</span><span class="special"><</span><span class="identifier">iter</span><span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> + <span class="identifier">ri</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">rbegin</span><span class="special">(</span> <span class="identifier">cpair</span> <span class="special">),</span> + <span class="identifier">re</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">rend</span><span class="special">(</span> <span class="identifier">cpair</span> <span class="special">);</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method_1.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../extending.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_3.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/extending/method_3.html b/libs/range/doc/html/range/reference/extending/method_3.html new file mode 100644 index 0000000000..3cee703401 --- /dev/null +++ b/libs/range/doc/html/range/reference/extending/method_3.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Method 3: provide range adaptor implementations</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../extending.html" title="Extending the library"> +<link rel="prev" href="method_2.html" title="Method 2: provide free-standing functions and specialize metafunctions"> +<link rel="next" href="method_3/method_3_1.html" title="Method 3.1: Implement a Range Adaptor without arguments"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method_2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../extending.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_3/method_3_1.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.extending.method_3"></a><a class="link" href="method_3.html" title="Method 3: provide range adaptor implementations">Method 3: provide + range adaptor implementations</a> +</h4></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="method_3/method_3_1.html">Method + 3.1: Implement a Range Adaptor without arguments</a></span></dt> +<dt><span class="section"><a href="method_3/method_3_2.html">Method + 3.2: Implement a Range Adaptor with arguments</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method_2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../extending.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_3/method_3_1.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/extending/method_3/method_3_1.html b/libs/range/doc/html/range/reference/extending/method_3/method_3_1.html new file mode 100644 index 0000000000..07c18f9c85 --- /dev/null +++ b/libs/range/doc/html/range/reference/extending/method_3/method_3_1.html @@ -0,0 +1,102 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Method 3.1: Implement a Range Adaptor without arguments</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../method_3.html" title="Method 3: provide range adaptor implementations"> +<link rel="prev" href="../method_3.html" title="Method 3: provide range adaptor implementations"> +<link rel="next" href="method_3_2.html" title="Method 3.2: Implement a Range Adaptor with arguments"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../method_3.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../method_3.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_3_2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.extending.method_3.method_3_1"></a><a class="link" href="method_3_1.html" title="Method 3.1: Implement a Range Adaptor without arguments">Method + 3.1: Implement a Range Adaptor without arguments</a> +</h5></div></div></div> +<p> + To implement a Range Adaptor without arguments (e.g. reversed) you need + to: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + Provide a range for your return type, for example: +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">iterator_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">iterator</span><span class="special">/</span><span class="identifier">reverse_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> + +<span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">reverse_range</span> <span class="special">:</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> <span class="special">></span> +<span class="special">{</span> +<span class="keyword">private</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> <span class="special">></span> <span class="identifier">base</span><span class="special">;</span> + +<span class="keyword">public</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special"><</span> + <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> <span class="identifier">iterator</span><span class="special">;</span> + + <span class="identifier">reverse_range</span><span class="special">(</span><span class="identifier">R</span><span class="special">&</span> <span class="identifier">r</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base</span><span class="special">(</span><span class="identifier">iterator</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">r</span><span class="special">)),</span> <span class="identifier">iterator</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">r</span><span class="special">)))</span> + <span class="special">{</span> <span class="special">}</span> +<span class="special">};</span> +</pre> + </li> +<li class="listitem"> + Provide a tag to uniquely identify your adaptor in the <code class="computeroutput"><span class="keyword">operator</span><span class="special">|</span></code> + function overload set +<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">detail</span> <span class="special">{</span> + <span class="keyword">struct</span> <span class="identifier">reverse_forwarder</span> <span class="special">{};</span> +<span class="special">}</span> +</pre> + </li> +<li class="listitem"> + Implement <code class="computeroutput"><span class="keyword">operator</span><span class="special">|</span></code> + +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">BidirectionalRng</span> <span class="special">></span> +<span class="keyword">inline</span> <span class="identifier">reverse_range</span><span class="special"><</span><span class="identifier">BidirectionalRng</span><span class="special">></span> +<span class="keyword">operator</span><span class="special">|(</span> <span class="identifier">BidirectionalRng</span><span class="special">&</span> <span class="identifier">r</span><span class="special">,</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">reverse_forwarder</span> <span class="special">)</span> +<span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">reverse_range</span><span class="special"><</span><span class="identifier">BidirectionalRng</span><span class="special">>(</span> <span class="identifier">r</span> <span class="special">);</span> +<span class="special">}</span> + +<span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">BidirectionalRng</span> <span class="special">></span> +<span class="keyword">inline</span> <span class="identifier">reverse_range</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">BidirectionalRng</span><span class="special">></span> +<span class="keyword">operator</span><span class="special">|(</span> <span class="keyword">const</span> <span class="identifier">BidirectionalRng</span><span class="special">&</span> <span class="identifier">r</span><span class="special">,</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">reverse_forwarder</span> <span class="special">)</span> +<span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">reverse_range</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">BidirectionalRng</span><span class="special">>(</span> <span class="identifier">r</span> <span class="special">);</span> +<span class="special">}</span> +</pre> + </li> +</ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../method_3.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../method_3.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method_3_2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/extending/method_3/method_3_2.html b/libs/range/doc/html/range/reference/extending/method_3/method_3_2.html new file mode 100644 index 0000000000..cb5235ac2e --- /dev/null +++ b/libs/range/doc/html/range/reference/extending/method_3/method_3_2.html @@ -0,0 +1,155 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Method 3.2: Implement a Range Adaptor with arguments</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../method_3.html" title="Method 3: provide range adaptor implementations"> +<link rel="prev" href="method_3_1.html" title="Method 3.1: Implement a Range Adaptor without arguments"> +<link rel="next" href="../../../style_guide.html" title="Terminology and style guidelines"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method_3_1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../method_3.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../style_guide.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="range.reference.extending.method_3.method_3_2"></a><a class="link" href="method_3_2.html" title="Method 3.2: Implement a Range Adaptor with arguments">Method + 3.2: Implement a Range Adaptor with arguments</a> +</h5></div></div></div> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + Provide a range for your return type, for example: +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">argument_fwd</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">iterator_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">iterator</span><span class="special">/</span><span class="identifier">transform_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">replace_value</span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">result_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">argument_type</span><span class="special">;</span> + + <span class="identifier">replace_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">from</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">to</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">m_from</span><span class="special">(</span><span class="identifier">from</span><span class="special">),</span> <span class="identifier">m_to</span><span class="special">(</span><span class="identifier">to</span><span class="special">)</span> + <span class="special">{</span> + <span class="special">}</span> + + <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">()(</span><span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">x</span><span class="special">)</span> <span class="keyword">const</span> + <span class="special">{</span> + <span class="keyword">return</span> <span class="special">(</span><span class="identifier">x</span> <span class="special">==</span> <span class="identifier">m_from</span><span class="special">)</span> <span class="special">?</span> <span class="identifier">m_to</span> <span class="special">:</span> <span class="identifier">x</span><span class="special">;</span> + <span class="special">}</span> +<span class="keyword">private</span><span class="special">:</span> + <span class="identifier">Value</span> <span class="identifier">m_from</span><span class="special">;</span> + <span class="identifier">Value</span> <span class="identifier">m_to</span><span class="special">;</span> +<span class="special">};</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">replace_range</span> +<span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> + <span class="identifier">replace_value</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>,</span> + <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span><span class="special">></span> <span class="special">></span> +<span class="special">{</span> +<span class="keyword">private</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">iterator_base</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">replace_value</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span> <span class="identifier">Fn</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span><span class="identifier">Fn</span><span class="special">,</span> <span class="identifier">iterator_base</span><span class="special">></span> <span class="identifier">replaced_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">replaced_iterator</span><span class="special">></span> <span class="identifier">base_t</span><span class="special">;</span> + +<span class="keyword">public</span><span class="special">:</span> + <span class="identifier">replace_range</span><span class="special">(</span><span class="identifier">Range</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">from</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">to</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base_t</span><span class="special">(</span><span class="identifier">replaced_iterator</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">Fn</span><span class="special">(</span><span class="identifier">from</span><span class="special">,</span><span class="identifier">to</span><span class="special">)),</span> + <span class="identifier">replaced_iterator</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">Fn</span><span class="special">(</span><span class="identifier">from</span><span class="special">,</span><span class="identifier">to</span><span class="special">)))</span> + <span class="special">{</span> + <span class="special">}</span> + <span class="special">};</span> +</pre> + </li> +<li class="listitem"> + Implement a holder class to hold the arguments required to construct + the RangeAdaptor. + </li> +</ol></div> +<p> + The holder combines multiple parameters into one that can be passed as + the right operand of <code class="computeroutput"><span class="keyword">operator</span><span class="special">|()</span></code>. + </p> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">replace_holder</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">holder2</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="identifier">replace_holder</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">from</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">to</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">holder2</span><span class="special"><</span><span class="identifier">T</span><span class="special">>(</span><span class="identifier">from</span><span class="special">,</span> <span class="identifier">to</span><span class="special">)</span> + <span class="special">{</span> <span class="special">}</span> +<span class="keyword">private</span><span class="special">:</span> + <span class="keyword">void</span> <span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">replace_holder</span><span class="special">&);</span> +<span class="special">};</span> +</pre> +<p> + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + Define an instance of the holder with the name of the adaptor + </li></ol></div> +<p> + +</p> +<pre class="programlisting"><span class="keyword">static</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">forwarder2</span><span class="special"><</span><span class="identifier">replace_holder</span><span class="special">></span> +<span class="identifier">replaced</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">forwarder2</span><span class="special"><</span><span class="identifier">replace_holder</span><span class="special">>();</span> +</pre> +<p> + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + Define <code class="computeroutput"><span class="keyword">operator</span><span class="special">|</span></code> + </li></ol></div> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">SinglePassRange</span><span class="special">></span> +<span class="keyword">inline</span> <span class="identifier">replace_range</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">></span> +<span class="keyword">operator</span><span class="special">|(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">replace_holder</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>&</span> <span class="identifier">f</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">replace_range</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">f</span><span class="special">.</span><span class="identifier">val1</span><span class="special">,</span> <span class="identifier">f</span><span class="special">.</span><span class="identifier">val2</span><span class="special">);</span> +<span class="special">}</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">SinglePassRange</span><span class="special">></span> +<span class="keyword">inline</span> <span class="identifier">replace_range</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">></span> +<span class="keyword">operator</span><span class="special">|(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">replace_holder</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span><span class="special">>&</span> <span class="identifier">f</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">replace_range</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">>(</span><span class="identifier">rng</span><span class="special">,</span> <span class="identifier">f</span><span class="special">.</span><span class="identifier">val1</span><span class="special">,</span> <span class="identifier">f</span><span class="special">.</span><span class="identifier">val2</span><span class="special">);</span> +<span class="special">}</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method_3_1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../method_3.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../style_guide.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/overview.html b/libs/range/doc/html/range/reference/overview.html new file mode 100644 index 0000000000..0005ecec8f --- /dev/null +++ b/libs/range/doc/html/range/reference/overview.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Overview</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="../reference.html" title="Reference"> +<link rel="next" href="concept_implementation.html" title="Range concept implementation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concept_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.overview"></a><a class="link" href="overview.html" title="Overview">Overview</a> +</h3></div></div></div> +<p> + Three types of objects are currently supported by the library: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + standard-like containers + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">,</span><span class="identifier">iterator</span><span class="special">></span></code> + </li> +<li class="listitem"> + built-in arrays + </li> +</ul></div> +<p> + Even though the behavior of the primary templates are exactly such that standard + containers will be supported by default, the requirements are much lower + than the standard container requirements. For example, the utility class + <a class="link" href="utilities/iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> + implements the <a class="link" href="extending.html" title="Extending the library">minimal interface</a> + required to make the class a <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward + Range</a>. + </p> +<p> + Please also see <a class="link" href="../concepts.html" title="Range Concepts">Range concepts</a> for + more details. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="concept_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/ranges.html b/libs/range/doc/html/range/reference/ranges.html new file mode 100644 index 0000000000..37919c5644 --- /dev/null +++ b/libs/range/doc/html/range/reference/ranges.html @@ -0,0 +1,49 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Provided Ranges</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="algorithms/numeric/partial_sum.html" title="partial_sum"> +<link rel="next" href="ranges/any_range.html" title="any_range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="algorithms/numeric/partial_sum.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ranges/any_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.ranges"></a><a class="link" href="ranges.html" title="Provided Ranges">Provided Ranges</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="ranges/any_range.html">any_range</a></span></dt> +<dt><span class="section"><a href="ranges/counting_range.html">counting_range</a></span></dt> +<dt><span class="section"><a href="ranges/istream_range.html">istream_range</a></span></dt> +<dt><span class="section"><a href="ranges/irange.html">irange</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="algorithms/numeric/partial_sum.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ranges/any_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/ranges/any_range.html b/libs/range/doc/html/range/reference/ranges/any_range.html new file mode 100644 index 0000000000..3659c9ec87 --- /dev/null +++ b/libs/range/doc/html/range/reference/ranges/any_range.html @@ -0,0 +1,177 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>any_range</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../ranges.html" title="Provided Ranges"> +<link rel="prev" href="../ranges.html" title="Provided Ranges"> +<link rel="next" href="counting_range.html" title="counting_range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../ranges.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="counting_range.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.ranges.any_range"></a><a class="link" href="any_range.html" title="any_range">any_range</a> +</h4></div></div></div> +<a name="range.reference.ranges.any_range.description"></a><h6> +<a name="id754843"></a> + <a class="link" href="any_range.html#range.reference.ranges.any_range.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">any_range</span></code> is a range that + has the type information erased hence a <code class="computeroutput"><span class="identifier">any_range</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">forward_pass_traversal_tag</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span><span class="special">></span></code> + can be used to represent a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span></code>, a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">list</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span></code> or many other types. + </p> +<p> + The <a href="http://www.artima.com/cppsource/type_erasure.html" target="_top">type + erasure article</a> covers the motivation and goals of type erasure + in this context. Clearly my implementation is building upon a lot of prior + art created by others. Thomas Becker's <code class="computeroutput"><span class="identifier">any_iterator</span></code> + was a strong influence. Adobe also have an <code class="computeroutput"><span class="identifier">any_iterator</span></code> + implementation, but this has very tight coupling to other parts of the + library that precluded it from use in Boost.Range. Early development versions + of this Range Adaptor directly used Thomas Becker's any_iterator implementation. + Subsequently I discovered that the heap allocations of this and many other + implementations cause poor speed performance particularly at the tails + of the distribution. To solve this required a new design that incorporated + the embedded buffer optimization. + </p> +<p> + Despite the underlying <code class="computeroutput"><span class="identifier">any_iterator</span></code> + being the fastest available implementation, the performance overhead of + <code class="computeroutput"><span class="identifier">any_range</span></code> is still appreciable + due to the cost of virtual function calls required to implement <code class="computeroutput"><span class="identifier">increment</span></code>, <code class="computeroutput"><span class="identifier">decrement</span></code>, + <code class="computeroutput"><span class="identifier">advance</span></code>, <code class="computeroutput"><span class="identifier">equal</span></code> etc. Frequently a better design + choice is to convert to a canonical form. + </p> +<p> + Please see the <a class="link" href="../adaptors/reference/type_erased.html" title="type_erased">type_erased</a> + for a Range Adaptor that returns <code class="computeroutput"><span class="identifier">any_range</span></code> + instances. + </p> +<a name="range.reference.ranges.any_range.synopsis"></a><h6> +<a name="id755211"></a> + <a class="link" href="any_range.html#range.reference.ranges.any_range.synopsis">Synopsis</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">Value</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Traversal</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Reference</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Difference</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Buffer</span> <span class="special">=</span> <span class="identifier">any_iterator_default_buffer</span> +<span class="special">></span> +<span class="keyword">class</span> <span class="identifier">any_range</span> + <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">iterator_range</span><span class="special"><</span> + <span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">any_iterator</span><span class="special"><</span> + <span class="identifier">Value</span> + <span class="special">,</span> <span class="identifier">Traversal</span> + <span class="special">,</span> <span class="identifier">Reference</span> + <span class="special">,</span> <span class="identifier">Difference</span> + <span class="special">,</span> <span class="identifier">Buffer</span> + <span class="special">></span> + <span class="special">></span> +<span class="special">{</span> + <span class="keyword">typedef</span> <span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">any_iterator</span><span class="special"><</span> + <span class="identifier">Value</span> + <span class="special">,</span> <span class="identifier">Traversal</span> + <span class="special">,</span> <span class="identifier">Reference</span> + <span class="special">,</span> <span class="identifier">Difference</span> + <span class="special">,</span> <span class="identifier">Buffer</span> + <span class="special">></span> <span class="identifier">any_iterator_type</span><span class="special">;</span> + + <span class="keyword">typedef</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">any_iterator_type</span><span class="special">></span> <span class="identifier">base_type</span><span class="special">;</span> + + <span class="keyword">struct</span> <span class="identifier">enabler</span> <span class="special">{};</span> + <span class="keyword">struct</span> <span class="identifier">disabler</span> <span class="special">{};</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="identifier">any_iterator_type</span> <span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">any_iterator_type</span> <span class="identifier">const_iterator</span><span class="special">;</span> + + <span class="identifier">any_range</span><span class="special">()</span> + <span class="special">{</span> + <span class="special">}</span> + + <span class="identifier">any_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">any_range</span><span class="special">&</span> <span class="identifier">other</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base_type</span><span class="special">(</span><span class="identifier">other</span><span class="special">)</span> + <span class="special">{</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">WrappedRange</span><span class="special">></span> + <span class="identifier">any_range</span><span class="special">(</span><span class="identifier">WrappedRange</span><span class="special">&</span> <span class="identifier">wrapped_range</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base_type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">wrapped_range</span><span class="special">),</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">wrapped_range</span><span class="special">))</span> + <span class="special">{</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">WrappedRange</span><span class="special">></span> + <span class="identifier">any_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">WrappedRange</span><span class="special">&</span> <span class="identifier">wrapped_range</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base_type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">wrapped_range</span><span class="special">),</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">wrapped_range</span><span class="special">))</span> + <span class="special">{</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span> + <span class="keyword">class</span> <span class="identifier">OtherValue</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OtherTraversal</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OtherReference</span> + <span class="special">,</span> <span class="keyword">class</span> <span class="identifier">OtherDifference</span> + <span class="special">></span> + <span class="identifier">any_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">any_range</span><span class="special"><</span> + <span class="identifier">OtherValue</span> + <span class="special">,</span> <span class="identifier">OtherTraversal</span> + <span class="special">,</span> <span class="identifier">OtherReference</span> + <span class="special">,</span> <span class="identifier">OtherDifference</span> + <span class="special">,</span> <span class="identifier">Buffer</span> + <span class="special">>&</span> <span class="identifier">other</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base_type</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">other</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">other</span><span class="special">))</span> + <span class="special">{</span> + <span class="special">}</span> + + <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> + <span class="identifier">any_range</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">)</span> + <span class="special">:</span> <span class="identifier">base_type</span><span class="special">(</span><span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">)</span> + <span class="special">{</span> + <span class="special">}</span> +<span class="special">};</span> +</pre> +<p> + </p> +<a name="range.reference.ranges.any_range.definition"></a><h6> +<a name="id756420"></a> + <a class="link" href="any_range.html#range.reference.ranges.any_range.definition">Definition</a> + </h6> +<p> + Defined in header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">any_range</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../ranges.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="counting_range.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/ranges/counting_range.html b/libs/range/doc/html/range/reference/ranges/counting_range.html new file mode 100644 index 0000000000..21a8a1608a --- /dev/null +++ b/libs/range/doc/html/range/reference/ranges/counting_range.html @@ -0,0 +1,90 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>counting_range</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../ranges.html" title="Provided Ranges"> +<link rel="prev" href="any_range.html" title="any_range"> +<link rel="next" href="istream_range.html" title="istream_range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="any_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="istream_range.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.ranges.counting_range"></a><a class="link" href="counting_range.html" title="counting_range">counting_range</a> +</h4></div></div></div> +<a name="range.reference.ranges.counting_range.prototype"></a><h6> +<a name="id756497"></a> + <a class="link" href="counting_range.html#range.reference.ranges.counting_range.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">Incrementable</span> <span class="special">></span> <span class="keyword">inline</span> +<span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">counting_iterator</span><span class="special"><</span><span class="identifier">Incrementable</span><span class="special">></span> <span class="special">></span> +<span class="identifier">counting_range</span><span class="special">(</span><span class="identifier">Incrementable</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Incrementable</span> <span class="identifier">last</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange</span> <span class="special">></span> <span class="keyword">inline</span> +<span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">counting_iterator</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">counting_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">SinglePassRange</span> <span class="special">></span> <span class="keyword">inline</span> +<span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">counting_iterator</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">SinglePassRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> +<span class="identifier">counting_range</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.ranges.counting_range.description"></a><h6> +<a name="id756879"></a> + <a class="link" href="counting_range.html#range.reference.ranges.counting_range.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">counting_range</span></code> is a function + to generator that generates an <code class="computeroutput"><span class="identifier">iterator_range</span></code> + wrapping a <code class="computeroutput"><span class="identifier">counting_iterator</span></code> + (from Boost.Iterator). + </p> +<a name="range.reference.ranges.counting_range.definition"></a><h6> +<a name="id756935"></a> + <a class="link" href="counting_range.html#range.reference.ranges.counting_range.definition">Definition</a> + </h6> +<p> + Defined in header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">counting_range</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.ranges.counting_range.requirements"></a><h6> +<a name="id756996"></a> + <a class="link" href="counting_range.html#range.reference.ranges.counting_range.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + <code class="computeroutput"><span class="identifier">Incrementable</span></code> is a + model of the <code class="computeroutput"><span class="identifier">Incrementable</span></code> + Concept. + </li></ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="any_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="istream_range.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/ranges/irange.html b/libs/range/doc/html/range/reference/ranges/irange.html new file mode 100644 index 0000000000..6cc143cda2 --- /dev/null +++ b/libs/range/doc/html/range/reference/ranges/irange.html @@ -0,0 +1,104 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>irange</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../ranges.html" title="Provided Ranges"> +<link rel="prev" href="istream_range.html" title="istream_range"> +<link rel="next" href="../utilities.html" title="Utilities"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="istream_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../utilities.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.ranges.irange"></a><a class="link" href="irange.html" title="irange">irange</a> +</h4></div></div></div> +<a name="range.reference.ranges.irange.prototype"></a><h6> +<a name="id757425"></a> + <a class="link" href="irange.html#range.reference.ranges.irange.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">></span> +<span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">integer_iterator</span><span class="special"><</span><span class="identifier">Integer</span><span class="special">></span> <span class="special">></span> +<span class="identifier">irange</span><span class="special">(</span><span class="identifier">Integer</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">last</span><span class="special">);</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">StepSize</span><span class="special">></span> +<span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">range_detail</span><span class="special">::</span><span class="identifier">integer_iterator_with_step</span><span class="special"><</span><span class="identifier">Integer</span><span class="special">,</span> <span class="identifier">StepSize</span><span class="special">></span> <span class="special">></span> +<span class="identifier">irange</span><span class="special">(</span><span class="identifier">Integer</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">StepSize</span> <span class="identifier">step_size</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.ranges.irange.description"></a><h6> +<a name="id757718"></a> + <a class="link" href="irange.html#range.reference.ranges.irange.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">irange</span></code> is a function to + generate an Integer Range. + </p> +<p> + <code class="computeroutput"><span class="identifier">irange</span></code> allows treating + integers as a model of the <a class="link" href="../../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a> Concept. It should be noted that the <code class="computeroutput"><span class="identifier">first</span></code> and <code class="computeroutput"><span class="identifier">last</span></code> + parameters denoted a half-open range. + </p> +<a name="range.reference.ranges.irange.definition"></a><h6> +<a name="id757796"></a> + <a class="link" href="irange.html#range.reference.ranges.irange.definition">Definition</a> + </h6> +<p> + Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">irange</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +<a name="range.reference.ranges.irange.requirements"></a><h6> +<a name="id757857"></a> + <a class="link" href="irange.html#range.reference.ranges.irange.requirements">Requirements</a> + </h6> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">Integer</span></code> is a model + of the <code class="computeroutput"><span class="identifier">Integer</span></code> Concept. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">StepSize</span></code> is a model + of the <code class="computeroutput"><span class="identifier">SignedInteger</span></code> + Concept. + </li> +</ol></div> +<a name="range.reference.ranges.irange.complexity"></a><h6> +<a name="id757940"></a> + <a class="link" href="irange.html#range.reference.ranges.irange.complexity">Complexity</a> + </h6> +<p> + Constant. Since this function generates a new range the most significant + performance cost is incurred through the iteration of the generated range. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="istream_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../utilities.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/ranges/istream_range.html b/libs/range/doc/html/range/reference/ranges/istream_range.html new file mode 100644 index 0000000000..8b11dde04c --- /dev/null +++ b/libs/range/doc/html/range/reference/ranges/istream_range.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>istream_range</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../ranges.html" title="Provided Ranges"> +<link rel="prev" href="counting_range.html" title="counting_range"> +<link rel="next" href="irange.html" title="irange"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="counting_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="irange.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.ranges.istream_range"></a><a class="link" href="istream_range.html" title="istream_range">istream_range</a> +</h4></div></div></div> +<a name="range.reference.ranges.istream_range.prototype"></a><h6> +<a name="id757067"></a> + <a class="link" href="istream_range.html#range.reference.ranges.istream_range.prototype">Prototype</a> + </h6> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">Type</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Elem</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="keyword">inline</span> +<span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">istream_iterator</span><span class="special"><</span><span class="identifier">Type</span><span class="special">,</span> <span class="identifier">Elem</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">></span> <span class="special">></span> +<span class="identifier">istream_range</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span><span class="identifier">Elem</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">>&</span> <span class="identifier">in</span><span class="special">);</span> +</pre> +<p> + </p> +<a name="range.reference.ranges.istream_range.description"></a><h6> +<a name="id757284"></a> + <a class="link" href="istream_range.html#range.reference.ranges.istream_range.description">Description</a> + </h6> +<p> + <code class="computeroutput"><span class="identifier">istream_range</span></code> is a function + to generator that generates an <code class="computeroutput"><span class="identifier">iterator_range</span></code> + wrapping a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream_iterator</span></code>. + </p> +<a name="range.reference.ranges.istream_range.definition"></a><h6> +<a name="id757348"></a> + <a class="link" href="istream_range.html#range.reference.ranges.istream_range.definition">Definition</a> + </h6> +<p> + Defined in header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">istream_range</span><span class="special">.</span><span class="identifier">hpp</span></code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="counting_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ranges.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="irange.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/utilities.html b/libs/range/doc/html/range/reference/utilities.html new file mode 100644 index 0000000000..f4b5c90fe9 --- /dev/null +++ b/libs/range/doc/html/range/reference/utilities.html @@ -0,0 +1,83 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Utilities</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../reference.html" title="Reference"> +<link rel="prev" href="ranges/irange.html" title="irange"> +<link rel="next" href="utilities/iterator_range.html" title="Class iterator_range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ranges/irange.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="utilities/iterator_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.reference.utilities"></a><a class="link" href="utilities.html" title="Utilities">Utilities</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="utilities/iterator_range.html">Class <code class="computeroutput"><span class="identifier">iterator_range</span></code></a></span></dt> +<dt><span class="section"><a href="utilities/sub_range.html">Class <code class="computeroutput"><span class="identifier">sub_range</span></code></a></span></dt> +<dt><span class="section"><a href="utilities/join.html">Function join</a></span></dt> +</dl></div> +<p> + Having an abstraction that encapsulates a pair of iterators is very useful. + The standard library uses <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code> + in some circumstances, but that class is cumbersome to use because we need + to specify two template arguments, and for all range algorithm purposes we + must enforce the two template arguments to be the same. Moreover, <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">,</span><span class="identifier">iterator</span><span class="special">></span></code> is hardly self-documenting whereas more + domain specific class names are. Therefore these two classes are provided: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Class <code class="computeroutput"><span class="identifier">iterator_range</span></code> + </li> +<li class="listitem"> + Class <code class="computeroutput"><span class="identifier">sub_range</span></code> + </li> +<li class="listitem"> + Function <code class="computeroutput"><span class="identifier">join</span></code> + </li> +</ul></div> +<p> + The <code class="computeroutput"><span class="identifier">iterator_range</span></code> class + is templated on an <a href="../../../../../../libs/iterator/doc/new-iter-concepts.html#forward-traversal-iterators-lib-forward-traversal-iterators" target="_top">Forward + Traversal Iterator</a> and should be used whenever fairly general code + is needed. The <code class="computeroutput"><span class="identifier">sub_range</span></code> + class is templated on an <a class="link" href="../concepts/forward_range.html" title="Forward Range">Forward + Range</a> and it is less general, but a bit easier to use since its template + argument is easier to specify. The biggest difference is, however, that a + <code class="computeroutput"><span class="identifier">sub_range</span></code> can propagate constness + because it knows what a corresponding <code class="computeroutput"><span class="identifier">const_iterator</span></code> + is. + </p> +<p> + Both classes can be used as ranges since they implement the <a class="link" href="extending.html" title="Extending the library">minimal + interface</a> required for this to work automatically. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ranges/irange.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="utilities/iterator_range.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/utilities/iterator_range.html b/libs/range/doc/html/range/reference/utilities/iterator_range.html new file mode 100644 index 0000000000..bbe4521d50 --- /dev/null +++ b/libs/range/doc/html/range/reference/utilities/iterator_range.html @@ -0,0 +1,285 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class iterator_range</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../utilities.html" title="Utilities"> +<link rel="prev" href="../utilities.html" title="Utilities"> +<link rel="next" href="sub_range.html" title="Class sub_range"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../utilities.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utilities.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sub_range.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.utilities.iterator_range"></a><a class="link" href="iterator_range.html" title="Class iterator_range">Class <code class="computeroutput"><span class="identifier">iterator_range</span></code></a> +</h4></div></div></div> +<p> + The intention of the <code class="computeroutput"><span class="identifier">iterator_range</span></code> + class is to encapsulate two iterators so they fulfill the <a class="link" href="../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> concept. A few other functions are also provided for convenience. + </p> +<p> + If the template argument is not a model of <a href="../../../../../../../libs/iterator/doc/new-iter-concepts.html#forward-traversal-iterators-lib-forward-traversal-iterators" target="_top">Forward + Traversal Iterator</a>, one can still use a subset of the interface. + In particular, <code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code> + requires Random Access Traversal Iterators whereas <code class="computeroutput"><span class="identifier">empty</span><span class="special">()</span></code> only requires Single Pass Iterators. + </p> +<p> + Recall that many default constructed iterators are <span class="bold"><strong><span class="emphasis"><em>singular</em></span></strong></span> + and hence can only be assigned, but not compared or incremented or anything. + However, if one creates a default constructed <code class="computeroutput"><span class="identifier">iterator_range</span></code>, + then one can still call all its member functions. This design decision + avoids the <code class="computeroutput"><span class="identifier">iterator_range</span></code> + imposing limitations upon ranges of iterators that are not singular. Any + singularity limitation is simply propogated from the underlying iterator + type. + </p> +<a name="range.reference.utilities.iterator_range.synopsis"></a><h5> +<a name="id758301"></a> + <a class="link" href="iterator_range.html#range.reference.utilities.iterator_range.synopsis">Synopsis</a> + </h5> +<p> + +</p> +<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> +<span class="special">{</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span> <span class="special">></span> + <span class="keyword">class</span> <span class="identifier">iterator_range</span> + <span class="special">{</span> + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// Forward Range types +</span> <span class="keyword">typedef</span> <span class="identifier">ForwardTraversalIterator</span> <span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">ForwardTraversalIterator</span> <span class="identifier">const_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">iterator_difference</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">difference_type</span><span class="special">;</span> + + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// construction, assignment +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator2</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special">(</span> <span class="identifier">ForwardTraversalIterator2</span> <span class="identifier">Begin</span><span class="special">,</span> <span class="identifier">ForwardTraversalIterator2</span> <span class="identifier">End</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special">(</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// Forward Range functions +</span> <span class="identifier">iterator</span> <span class="identifier">begin</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <span class="identifier">end</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// convenience +</span> <span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <span class="identifier">equal</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special">&</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">value_type</span><span class="special">&</span> <span class="identifier">front</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">value_type</span><span class="special">&</span> <span class="identifier">back</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator_range</span><span class="special">&</span> <span class="identifier">advance_begin</span><span class="special">(</span><span class="identifier">difference_type</span> <span class="identifier">n</span><span class="special">);</span> + <span class="identifier">iterator_range</span><span class="special">&</span> <span class="identifier">advance_end</span><span class="special">(</span><span class="identifier">difference_type</span> <span class="identifier">n</span><span class="special">);</span> + <span class="keyword">bool</span> <span class="identifier">empty</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// for Random Access Range only: +</span> <span class="identifier">reference</span> <span class="keyword">operator</span><span class="special">[](</span> <span class="identifier">difference_type</span> <span class="identifier">at</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">value_type</span> <span class="keyword">operator</span><span class="special">()(</span> <span class="identifier">difference_type</span> <span class="identifier">at</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">size_type</span> <span class="identifier">size</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="special">};</span> + + <span class="comment">// stream output +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Traits</span> <span class="special">></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">Traits</span><span class="special">>&</span> + <span class="keyword">operator</span><span class="special"><<(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">Traits</span><span class="special">>&</span> <span class="identifier">Os</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// comparison +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator2</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator2</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator2</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator2</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator2</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator2</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><(</span> <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">ForwardTraversalIterator</span><span class="special">>&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="comment">// external construction +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">ForwardTraversalIterator</span> <span class="special">></span> + <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="identifier">ForwardTraversalIterator</span> <span class="identifier">Begin</span><span class="special">,</span> + <span class="identifier">ForwardTraversalIterator</span> <span class="identifier">End</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">Range</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="identifier">Range</span><span class="special">&</span> <span class="identifier">r</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">advance_begin</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">advance_end</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">Range</span> <span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span><span class="special">&</span> <span class="identifier">r</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">advance_begin</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">advance_end</span> <span class="special">);</span> + + <span class="comment">// convenience +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">Sequence</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="identifier">Sequence</span> <span class="identifier">copy_range</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + +<span class="special">}</span> <span class="comment">// namespace 'boost' +</span></pre> +<p> + </p> +<p> + If an instance of <code class="computeroutput"><span class="identifier">iterator_range</span></code> + is constructed by a client with two iterators, the client must ensure that + the two iterators delimit a valid closed-open range [begin,end). + </p> +<p> + It is worth noticing that the templated constructors and assignment operators + allow conversion from <code class="computeroutput"><span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">></span></code> to <code class="computeroutput"><span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">const_iterator</span><span class="special">></span></code>. Similarly, since the comparison operators + have two template arguments, we can compare ranges whenever the iterators + are comparable; for example when we are dealing with const and non-const + iterators from the same container. + </p> +<a name="range.reference.utilities.iterator_range.details_member_functions"></a><h5> +<a name="id761507"></a> + <a class="link" href="iterator_range.html#range.reference.utilities.iterator_range.details_member_functions">Details + member functions</a> + </h5> +<p> + <code class="computeroutput"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span></code> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Returns</strong></span></em></span> <code class="computeroutput"><span class="special">!</span><span class="identifier">empty</span><span class="special">();</span></code> + </p></blockquote></div> +<p> + <code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">equal</span><span class="special">(</span> <span class="identifier">iterator_range</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></code> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Returns</strong></span></em></span> <code class="computeroutput"><span class="identifier">begin</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">r</span><span class="special">.</span><span class="identifier">begin</span><span class="special">()</span> <span class="special">&&</span> + <span class="identifier">end</span><span class="special">()</span> + <span class="special">==</span> <span class="identifier">r</span><span class="special">.</span><span class="identifier">end</span><span class="special">();</span></code> + </p></blockquote></div> +<a name="range.reference.utilities.iterator_range.details_functions"></a><h5> +<a name="id761741"></a> + <a class="link" href="iterator_range.html#range.reference.utilities.iterator_range.details_functions">Details + functions</a> + </h5> +<p> + <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> + <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span></code> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Returns</strong></span></em></span> <code class="computeroutput"><span class="identifier">size</span><span class="special">(</span><span class="identifier">l</span><span class="special">)</span> <span class="special">!=</span> <span class="identifier">size</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span> <span class="special">?</span> <span class="keyword">false</span> + <span class="special">:</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">equal</span><span class="special">(</span> <span class="identifier">begin</span><span class="special">(</span><span class="identifier">l</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">l</span><span class="special">),</span> <span class="identifier">begin</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span> <span class="special">);</span></code> + </p></blockquote></div> +<p> + <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> + <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span></code> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Returns</strong></span></em></span> <code class="computeroutput"><span class="special">!(</span> <span class="identifier">l</span> <span class="special">==</span> <span class="identifier">r</span> <span class="special">);</span></code> + </p></blockquote></div> +<p> + <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&</span> + <span class="identifier">l</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span></code> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Returns</strong></span></em></span> <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">lexicographical_compare</span><span class="special">(</span> + <span class="identifier">begin</span><span class="special">(</span><span class="identifier">l</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">l</span><span class="special">),</span> <span class="identifier">begin</span><span class="special">(</span><span class="identifier">r</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span> <span class="special">);</span></code> + </p></blockquote></div> +<p> + +</p> +<pre class="programlisting"><span class="identifier">iterator_range</span> <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="identifier">Range</span><span class="special">&</span> <span class="identifier">r</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">advance_begin</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">Range</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">advance_end</span> <span class="special">);</span> +</pre> +<p> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Effects:</strong></span></em></span> + </p></blockquote></div> +<p> + +</p> +<pre class="programlisting"><span class="identifier">iterator</span> <span class="identifier">new_begin</span> <span class="special">=</span> <span class="identifier">begin</span><span class="special">(</span> <span class="identifier">r</span> <span class="special">),</span> +<span class="identifier">iterator</span> <span class="identifier">new_end</span> <span class="special">=</span> <span class="identifier">end</span><span class="special">(</span> <span class="identifier">r</span> <span class="special">);</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">advance</span><span class="special">(</span> <span class="identifier">new_begin</span><span class="special">,</span> <span class="identifier">advance_begin</span> <span class="special">);</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">advance</span><span class="special">(</span> <span class="identifier">new_end</span><span class="special">,</span> <span class="identifier">advance_end</span> <span class="special">);</span> +<span class="keyword">return</span> <span class="identifier">make_iterator_range</span><span class="special">(</span> <span class="identifier">new_begin</span><span class="special">,</span> <span class="identifier">new_end</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + <code class="computeroutput"><span class="identifier">Sequence</span> <span class="identifier">copy_range</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> + <span class="identifier">r</span> <span class="special">);</span></code> + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + <span class="emphasis"><em><span class="bold"><strong>Returns</strong></span></em></span> <code class="computeroutput"><span class="identifier">Sequence</span><span class="special">(</span> + <span class="identifier">begin</span><span class="special">(</span><span class="identifier">r</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span> <span class="special">);</span></code> + </p></blockquote></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../utilities.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utilities.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sub_range.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/utilities/join.html b/libs/range/doc/html/range/reference/utilities/join.html new file mode 100644 index 0000000000..6b7d8492e9 --- /dev/null +++ b/libs/range/doc/html/range/reference/utilities/join.html @@ -0,0 +1,132 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function join</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../utilities.html" title="Utilities"> +<link rel="prev" href="sub_range.html" title="Class sub_range"> +<link rel="next" href="../extending.html" title="Extending the library"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="sub_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utilities.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../extending.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.utilities.join"></a><a class="link" href="join.html" title="Function join">Function join</a> +</h4></div></div></div> +<p> + The intention of the <code class="computeroutput"><span class="identifier">join</span></code> + function is to join two ranges into one longer range. + </p> +<p> + The resultant range will have the lowest common traversal of the two ranges + supplied as parameters. + </p> +<p> + Note that the joined range incurs a performance cost due to the need to + check if the end of a range has been reached internally during traversal. + </p> +<a name="range.reference.utilities.join.synposis"></a><h5> +<a name="id764138"></a> + <a class="link" href="join.html#range.reference.utilities.join.synposis">Synposis</a> + </h5> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">joined_range</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">join</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">)</span> + +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">joined_range</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">></span> +<span class="identifier">join</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">);</span> +</pre> +<p> + </p> +<p> + For the const version: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code> + must be convertible to <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code>. + The <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code> must be convertible to <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> Both <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> + must be a model of <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> or better. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">joined_range</span><span class="special"><</span><span class="keyword">const</span> + <span class="identifier">SinglePassRange1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">></span></code> which is a model of the lesser + of the two range concepts passed. + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The minimum + of the range category of <code class="computeroutput"><span class="identifier">rng1</span></code> + and <code class="computeroutput"><span class="identifier">rng2</span></code>. + </li> +</ul></div> +<p> + For the mutable version: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <span class="bold"><strong>Precondition:</strong></span> The <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code> + must be convertible to <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code>. + The <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code> + must be convertible to <code class="computeroutput"><span class="identifier">range_reference</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code>. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Category:</strong></span> Both <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> + must be a model of <a class="link" href="../../concepts/single_pass_range.html" title="Single Pass Range">Single + Pass Range</a> or better. + </li> +<li class="listitem"> + <span class="bold"><strong>Range Return Type:</strong></span> <code class="computeroutput"><span class="identifier">joined_range</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">></span></code> which is a model of the lesser + of the two range concepts passed. + </li> +<li class="listitem"> + <span class="bold"><strong>Returned Range Category:</strong></span> The minimum + of the range category of <code class="computeroutput"><span class="identifier">rng1</span></code> + and <code class="computeroutput"><span class="identifier">rng2</span></code>. + </li> +</ul></div> +<a name="range.reference.utilities.join.example"></a><h5> +<a name="id764973"></a> + <a class="link" href="join.html#range.reference.utilities.join.example">Example</a> + </h5> +<p> + The expression <code class="computeroutput"><span class="identifier">join</span><span class="special">(</span><span class="identifier">irange</span><span class="special">(</span><span class="number">0</span><span class="special">,</span><span class="number">5</span><span class="special">),</span> <span class="identifier">irange</span><span class="special">(</span><span class="number">5</span><span class="special">,</span><span class="number">10</span><span class="special">))</span></code> would + evaluate to a range representing an integer range <code class="computeroutput"><span class="special">[</span><span class="number">0</span><span class="special">,</span><span class="number">10</span><span class="special">)</span></code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="sub_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utilities.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../extending.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/reference/utilities/sub_range.html b/libs/range/doc/html/range/reference/utilities/sub_range.html new file mode 100644 index 0000000000..c35e7072d5 --- /dev/null +++ b/libs/range/doc/html/range/reference/utilities/sub_range.html @@ -0,0 +1,123 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class sub_range</title> +<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../utilities.html" title="Utilities"> +<link rel="prev" href="iterator_range.html" title="Class iterator_range"> +<link rel="next" href="join.html" title="Function join"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="iterator_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utilities.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="join.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="range.reference.utilities.sub_range"></a><a class="link" href="sub_range.html" title="Class sub_range">Class <code class="computeroutput"><span class="identifier">sub_range</span></code></a> +</h4></div></div></div> +<p> + The <code class="computeroutput"><span class="identifier">sub_range</span></code> class inherits + all its functionality from the <a class="link" href="iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> class. The <code class="computeroutput"><span class="identifier">sub_range</span></code> class is often easier to use + because one must specify the <a class="link" href="../../concepts/forward_range.html" title="Forward Range">Forward + Range</a> template argument instead of an iterator. Moreover, the <code class="computeroutput"><span class="identifier">sub_range</span></code> class can propagate constness + since it knows what a corresponding <code class="computeroutput"><span class="identifier">const_iterator</span></code> + is. + </p> +<a name="range.reference.utilities.sub_range.synopsis"></a><h5> +<a name="id762873"></a> + <a class="link" href="sub_range.html#range.reference.utilities.sub_range.synopsis">Synopsis</a> + </h5> +<p> + +</p> +<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> +<span class="special">{</span> + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange</span> <span class="special">></span> + <span class="keyword">class</span> <span class="identifier">sub_range</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="special">></span> + <span class="special">{</span> + <span class="keyword">public</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">const_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">iterator_difference</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">difference_type</span><span class="special">;</span> + + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// construction, assignment +</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardTraversalIterator</span> <span class="special">></span> + <span class="identifier">sub_range</span><span class="special">(</span> <span class="identifier">ForwardTraversalIterator</span> <span class="identifier">Begin</span><span class="special">,</span> <span class="identifier">ForwardTraversalIterator</span> <span class="identifier">End</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> <span class="special">></span> + <span class="identifier">sub_range</span><span class="special">(</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> <span class="special">></span> + <span class="identifier">sub_range</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> <span class="special">></span> + <span class="identifier">sub_range</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span> <span class="special">></span> + <span class="identifier">sub_range</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> + + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// Forward Range functions +</span> <span class="identifier">iterator</span> <span class="identifier">begin</span><span class="special">();</span> + <span class="identifier">const_iterator</span> <span class="identifier">begin</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <span class="identifier">end</span><span class="special">();</span> + <span class="identifier">const_iterator</span> <span class="identifier">end</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="keyword">public</span><span class="special">:</span> <span class="comment">// convenience +</span> <span class="identifier">value_type</span><span class="special">&</span> <span class="identifier">front</span><span class="special">();</span> + <span class="keyword">const</span> <span class="identifier">value_type</span><span class="special">&</span> <span class="identifier">front</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">value_type</span><span class="special">&</span> <span class="identifier">back</span><span class="special">();</span> + <span class="keyword">const</span> <span class="identifier">value_type</span><span class="special">&</span> <span class="identifier">back</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// for Random Access Range only: +</span> <span class="identifier">value_type</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">[](</span> <span class="identifier">size_type</span> <span class="identifier">at</span> <span class="special">);</span> + <span class="keyword">const</span> <span class="identifier">value_type</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">[](</span> <span class="identifier">size_type</span> <span class="identifier">at</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="keyword">public</span><span class="special">:</span> + <span class="comment">// rest of interface inherited from iterator_range +</span> <span class="special">};</span> + +<span class="special">}</span> <span class="comment">// namespace 'boost' +</span></pre> +<p> + </p> +<p> + The class should be trivial to use as seen below. Imagine that we have + an algorithm that searches for a sub-string in a string. The result is + an iterator_range, that delimits the match. We need to store the result + from this algorithm. Here is an example of how we can do it with and without + <code class="computeroutput"><span class="identifier">sub_range</span></code> + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">str</span><span class="special">(</span><span class="string">"hello"</span><span class="special">);</span> +<span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">></span> <span class="identifier">ir</span> <span class="special">=</span> <span class="identifier">find_first</span><span class="special">(</span> <span class="identifier">str</span><span class="special">,</span> <span class="string">"ll"</span> <span class="special">);</span> +<span class="identifier">sub_range</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">></span> <span class="identifier">sub</span> <span class="special">=</span> <span class="identifier">find_first</span><span class="special">(</span> <span class="identifier">str</span><span class="special">,</span> <span class="string">"ll"</span> <span class="special">);</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="iterator_range.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utilities.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="join.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/style_guide.html b/libs/range/doc/html/range/style_guide.html new file mode 100644 index 0000000000..5e36efdfc2 --- /dev/null +++ b/libs/range/doc/html/range/style_guide.html @@ -0,0 +1,153 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Terminology and style guidelines</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="reference/extending/method_3/method_3_2.html" title="Method 3.2: Implement a Range Adaptor with arguments"> +<link rel="next" href="headers.html" title="Library Headers"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reference/extending/method_3/method_3_2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="headers.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.style_guide"></a><a class="link" href="style_guide.html" title="Terminology and style guidelines">Terminology and style guidelines</a> +</h2></div></div></div> +<p> + The use of a consistent terminology is as important for <a class="link" href="concepts.html" title="Range Concepts">Ranges</a> + and range-based algorithms as it is for iterators and iterator-based algorithms. + If a conventional set of names are adopted, we can avoid misunderstandings + and write generic function prototypes that are <span class="bold"><strong><span class="emphasis"><em>self-documenting</em></span></strong></span>. + </p> +<p> + Since ranges are characterized by a specific underlying iterator type, we get + a type of range for each type of iterator. Hence we can speak of the following + types of ranges: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<p class="simpara"> + <span class="bold"><strong><span class="emphasis"><em>Value access</em></span></strong></span> category: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + Readable Range + </li> +<li class="listitem"> + Writeable Range + </li> +<li class="listitem"> + Swappable Range + </li> +<li class="listitem"> + Lvalue Range + </li> +</ul></div> +</li> +<li class="listitem"> +<p class="simpara"> + <span class="bold"><strong><span class="emphasis"><em>Traversal</em></span></strong></span> category: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + <a class="link" href="concepts/single_pass_range.html" title="Single Pass Range">Single Pass Range</a> + </li> +<li class="listitem"> + <a class="link" href="concepts/forward_range.html" title="Forward Range">Forward Range</a> + </li> +<li class="listitem"> + <a class="link" href="concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional Range</a> + </li> +<li class="listitem"> + <a class="link" href="concepts/random_access_range.html" title="Random Access Range">Random Access Range</a> + </li> +</ul></div> +</li> +</ul></div> +<p> + Notice how we have used the categories from the <a href="../../../../../libs/iterator/doc/new-iter-concepts.html" target="_top">new + style iterators</a>. + </p> +<p> + Notice that an iterator (and therefore an range) has one <span class="bold"><strong><span class="emphasis"><em>traversal</em></span></strong></span> + property and one or more properties from the <span class="bold"><strong><span class="emphasis"><em>value + access</em></span></strong></span> category. So in reality we will mostly talk about + mixtures such as + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Random Access Readable Writeable Range + </li> +<li class="listitem"> + Forward Lvalue Range + </li> +</ul></div> +<p> + By convention, we should always specify the <span class="bold"><strong><span class="emphasis"><em>traversal</em></span></strong></span> + property first as done above. This seems reasonable since there will only be + one <span class="bold"><strong><span class="emphasis"><em>traversal</em></span></strong></span> property, + but perhaps many <span class="bold"><strong><span class="emphasis"><em>value access</em></span></strong></span> + properties. + </p> +<p> + It might, however, be reasonable to specify only one category if the other + category does not matter. For example, the <a class="link" href="reference/utilities/iterator_range.html" title="Class iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a> can be constructed + from a Forward Range. This means that we do not care about what <span class="bold"><strong><span class="emphasis"><em>value + access</em></span></strong></span> properties the Range has. Similarly, a Readable + Range will be one that has the lowest possible <span class="bold"><strong><span class="emphasis"><em>traversal</em></span></strong></span> + property (Single Pass). + </p> +<p> + As another example, consider how we specify the interface of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">sort</span><span class="special">()</span></code>. Algorithms are usually more cumbersome to + specify the interface of since both <span class="bold"><strong><span class="emphasis"><em>traversal</em></span></strong></span> + and <span class="bold"><strong><span class="emphasis"><em>value access</em></span></strong></span> properties + must be exactly defined. The iterator-based version looks like this: + </p> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">RandomAccessTraversalReadableWritableIterator</span> <span class="special">></span> +<span class="keyword">void</span> <span class="identifier">sort</span><span class="special">(</span> <span class="identifier">RandomAccessTraversalReadableWritableIterator</span> <span class="identifier">first</span><span class="special">,</span> + <span class="identifier">RandomAccessTraversalReadableWritableIterator</span> <span class="identifier">last</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + For ranges the interface becomes + </p> +<p> + +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">RandomAccessReadableWritableRange</span> <span class="special">></span> +<span class="keyword">void</span> <span class="identifier">sort</span><span class="special">(</span> <span class="identifier">RandomAccessReadableWritableRange</span><span class="special">&</span> <span class="identifier">r</span> <span class="special">);</span> +</pre> +<p> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reference/extending/method_3/method_3_2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="headers.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/upgrade.html b/libs/range/doc/html/range/upgrade.html new file mode 100644 index 0000000000..3238193576 --- /dev/null +++ b/libs/range/doc/html/range/upgrade.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Upgrade version of Boost.Range</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../index.html" title="Chapter 1. Range 2.0"> +<link rel="prev" href="mfc_atl/references.html" title="References"> +<link rel="next" href="upgrade/upgrade_from_1_45.html" title="Upgrade from version 1.45"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mfc_atl/references.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upgrade/upgrade_from_1_45.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="range.upgrade"></a><a class="link" href="upgrade.html" title="Upgrade version of Boost.Range">Upgrade version of Boost.Range</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="upgrade/upgrade_from_1_45.html">Upgrade from version + 1.45</a></span></dt> +<dt><span class="section"><a href="upgrade/upgrade_from_1_42.html">Upgrade from version + 1.42</a></span></dt> +<dt><span class="section"><a href="upgrade/upgrade_from_1_34.html">Upgrade from version + 1.34</a></span></dt> +</dl></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="mfc_atl/references.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upgrade/upgrade_from_1_45.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/upgrade/upgrade_from_1_34.html b/libs/range/doc/html/range/upgrade/upgrade_from_1_34.html new file mode 100644 index 0000000000..f0de1468b9 --- /dev/null +++ b/libs/range/doc/html/range/upgrade/upgrade_from_1_34.html @@ -0,0 +1,78 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Upgrade from version 1.34</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../upgrade.html" title="Upgrade version of Boost.Range"> +<link rel="prev" href="upgrade_from_1_42.html" title="Upgrade from version 1.42"> +<link rel="next" href="../portability.html" title="Portability"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="upgrade_from_1_42.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../upgrade.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../portability.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.upgrade.upgrade_from_1_34"></a><a class="link" href="upgrade_from_1_34.html" title="Upgrade from version 1.34">Upgrade from version + 1.34</a> +</h3></div></div></div> +<p> + Boost version 1.35 introduced some larger refactorings of the library: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + Direct support for character arrays was abandoned in favor of uniform + treatment of all arrays. Instead string algorithms can use the new function + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">as_literal</span></code></a><code class="computeroutput"><span class="special">()</span></code>. + </li> +<li class="listitem"> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">size</span></code></a> now requires a <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random + Access Range</a>. The old behavior is provided as <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">distance</span></code></a><code class="computeroutput"><span class="special">()</span></code>. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_size</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span></code> has been completely removed in + favor of <code class="computeroutput"><span class="identifier">range_difference</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">boost_range_begin</span><span class="special">()</span></code> + and <code class="computeroutput"><span class="identifier">boost_range_end</span><span class="special">()</span></code> + have been renamed <code class="computeroutput"><span class="identifier">range_begin</span><span class="special">()</span></code> and <code class="computeroutput"><span class="identifier">range_end</span><span class="special">()</span></code> respectively. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">range_result_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span></code> + and <code class="computeroutput"><span class="identifier">range_reverse_result_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span></code> + have been renamed <code class="computeroutput"><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span></code> + and <code class="computeroutput"><span class="identifier">range_reverse_iterator</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">type</span></code>. + </li> +<li class="listitem"> + The procedure that makes a custom type work with the library has been + greatly simplified. See <a class="link" href="../reference/extending.html" title="Extending the library">Extending + the library for UDTs</a> for details. + </li> +</ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="upgrade_from_1_42.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../upgrade.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../portability.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/upgrade/upgrade_from_1_42.html b/libs/range/doc/html/range/upgrade/upgrade_from_1_42.html new file mode 100644 index 0000000000..f8a5a48075 --- /dev/null +++ b/libs/range/doc/html/range/upgrade/upgrade_from_1_42.html @@ -0,0 +1,68 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Upgrade from version 1.42</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../upgrade.html" title="Upgrade version of Boost.Range"> +<link rel="prev" href="upgrade_from_1_45.html" title="Upgrade from version 1.45"> +<link rel="next" href="upgrade_from_1_34.html" title="Upgrade from version 1.34"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="upgrade_from_1_45.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../upgrade.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upgrade_from_1_34.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.upgrade.upgrade_from_1_42"></a><a class="link" href="upgrade_from_1_42.html" title="Upgrade from version 1.42">Upgrade from version + 1.42</a> +</h3></div></div></div> +<p> + New features: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <a class="link" href="../reference/adaptors.html" title="Range Adaptors">Range adaptors</a> + </li> +<li class="listitem"> + <a class="link" href="../reference/algorithms.html" title="Range Algorithms">Range algorithms</a> + </li> +</ol></div> +<p> + Removed: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + <code class="computeroutput"><span class="identifier">iterator_range</span></code> no longer + has a <code class="computeroutput"><span class="identifier">is_singular</span></code> member + function. The singularity restrictions have been removed from the <code class="computeroutput"><span class="identifier">iterator_range</span></code> class since this added + restrictions to ranges of iterators whose default constructors were not + singular. Previously the <code class="computeroutput"><span class="identifier">is_singular</span></code> + member function always returned <code class="computeroutput"><span class="keyword">false</span></code> + in release build configurations, hence it is not anticipated that this + interface change will produce difficulty in upgrading. + </li></ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="upgrade_from_1_45.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../upgrade.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upgrade_from_1_34.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/html/range/upgrade/upgrade_from_1_45.html b/libs/range/doc/html/range/upgrade/upgrade_from_1_45.html new file mode 100644 index 0000000000..542b5c97c7 --- /dev/null +++ b/libs/range/doc/html/range/upgrade/upgrade_from_1_45.html @@ -0,0 +1,64 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Upgrade from version 1.45</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../index.html" title="Chapter 1. Range 2.0"> +<link rel="up" href="../upgrade.html" title="Upgrade version of Boost.Range"> +<link rel="prev" href="../upgrade.html" title="Upgrade version of Boost.Range"> +<link rel="next" href="upgrade_from_1_42.html" title="Upgrade from version 1.42"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../upgrade.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../upgrade.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upgrade_from_1_42.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="range.upgrade.upgrade_from_1_45"></a><a class="link" href="upgrade_from_1_45.html" title="Upgrade from version 1.45">Upgrade from version + 1.45</a> +</h3></div></div></div> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + <a class="link" href="../reference/concept_implementation/semantics/functions.html" title="Functions"><code class="computeroutput"><span class="identifier">size</span></code></a> in addition to supporting + <a class="link" href="../concepts/random_access_range.html" title="Random Access Range">Random Access Range</a> + now also supports extensibility via calls to the unqualified <code class="computeroutput"><span class="identifier">range_calculate_size</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + function. + </li> +<li class="listitem"> + <a class="link" href="../reference/adaptors/reference/strided.html" title="strided">strided</a> + now in addition to working with any RandomAccessRange additionally works + for any SinglePassRange for which <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> is valid. + </li> +<li class="listitem"> + <a class="link" href="../reference/adaptors/reference/strided.html" title="strided">strided</a> + no longer requires <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">%</span> <span class="identifier">stride_size</span> + <span class="special">==</span> <span class="number">0</span></code> + or <code class="computeroutput"><span class="identifier">stride_size</span> <span class="special"><</span> + <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> + </li> +</ol></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../upgrade.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../upgrade.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="upgrade_from_1_42.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/range/doc/introduction.qbk b/libs/range/doc/introduction.qbk new file mode 100644 index 0000000000..d03a65bc75 --- /dev/null +++ b/libs/range/doc/introduction.qbk @@ -0,0 +1,43 @@ +[/ + 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:introduction Introduction] + +Generic algorithms have so far been specified in terms of two or more iterators. Two iterators would together form a range of values that the algorithm could work on. This leads to a very general interface, but also to a somewhat clumsy use of the algorithms with redundant specification of container names. Therefore we would like to raise the abstraction level for algorithms so they specify their interface in terms of __ranges__ as much as possible. + +The most common form of ranges used throughout the C++ community are standard library containers. When writing algorithms however, one often finds it desirable for the algorithm to accept other types that offer enough functionality to satisfy the needs of the generic code [*/if a suitable layer of indirection is applied/] . For example, raw arrays are often suitable for use with generic code that works with containers, provided a suitable adapter is used. Likewise, null terminated strings can be treated as containers of characters, if suitably adapted. + +This library therefore provides the means to adapt standard-like containers, null terminated strings, `std::pairs` of iterators, and raw arrays (and more), such that the same generic code can work with them all. The basic idea is to add another layer of indirection using __metafunctions__ and free-standing functions so syntactic and/or semantic differences can be removed. + +The main advantages are + +* simpler implementation and specification of generic range algorithms +* more flexible, compact and maintainable client code +* safe use of built-in arrays (for legacy code; why else would you use built-in arrays?) + +[heading Example - Iterate over the values in a map] +`` +using namespace boost; +using namespace boost::adaptors; +for_each( my_map | map_values, fn ); +`` + +[heading Example - Iterate over the keys in a map] +`` +using namespace boost; +using namespace boost::adaptors; +for_each( my_map | map_keys, fn ); +`` + +[heading Example - Push the even values from a map in reverse order into the container `target`] +`` +using namespace boost; +using namespace boost::adaptors; +// Assume that is_even is a predicate that has been implemented elsewhere... +push_back(target, my_map | map_values | filtered(is_even()) | reversed); +`` + +[endsect] + diff --git a/libs/range/doc/mfc_atl.qbk b/libs/range/doc/mfc_atl.qbk new file mode 100644 index 0000000000..051150909b --- /dev/null +++ b/libs/range/doc/mfc_atl.qbk @@ -0,0 +1,144 @@ +[/ + 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) +/] +[def __mfc_collections__ [@http://msdn.microsoft.com/en-us/library/942860sh.aspx MFC Collection Classes]] +[def __atl_collections__ [@http://msdn.microsoft.com/en-us/library/15e672bd.aspx ATL Collection Classes]] + +[section:mfc_atl MFC/ATL (courtesy of Shunsuke Sogame)] + +[h4 Introduction] +This implementation was kindly donated by Shunsuke Sogame. This header adapts MFC and ATL containers to the appropriate Range concepts. + +[table + [] + [[[*Author:]] [Shunsuke Sogame]] + [[[*Contact:]] [mb2act@yahoo.co.jp]] + [[[*Date:]] [26th of May 2006]] + [[[*Copyright:]] [Shunsuke Sogame 2005-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0]] +] + +[h4 Overview] + +Boost.Range MFC/ATL Extension provides Boost.Range support for MFC/ATL collection and string types. + +`` +CTypedPtrArray<CPtrArray, CList<CString> *> myArray; +... +BOOST_FOREACH (CList<CString> *theList, myArray) +{ + BOOST_FOREACH (CString& str, *theList) + { + boost::to_upper(str); + std::sort(boost::begin(str), boost::end(str)); + ... + } +} +`` + +[section:requirements Requirements] + +* Boost C++ Libraries Version 1.34.0 or later (no compilation required) +* Visual C++ 7.1 or later (for MFC and ATL) + +[endsect] + +[section:mfc_ranges MFC Ranges] +If the `<boost/range/mfc.hpp>` is included before or after Boost.Range headers, the MFC collections and strings become models of Range. The table below lists the Traversal Category and `range_reference` of MFC ranges. + +[table + [[Range] [Traversal Category] [`range_reference<Range>::type`]] + [[`CArray<T,A>`] [__random_access_range__] [`T&`]] + [[`CList<T,A>`] [__bidirectional_range__] [`T&`]] + [[`CMap<K,AK,M,AM>`] [__forward_range__] [`Range::CPair&`]] + [[`CTypedPtrArray<B,T*>`] [__random_access_range__] [`T* const`]] + [[`CTypedPtrList<B,T*>`] [__bidirectional_range__] [`T* const`]] + [[`CTypedPtrMap<B,T*,V*>`] [__forward_range__] [`std::pair<T*,V*> const`]] + [[`CByteArray`] [__random_access_range__] [`BYTE&`]] + [[`CDWordArray`] [__random_access_range__] [`DWORD&`]] + [[`CObArray`] [__random_access_range__] [`CObject*&`]] + [[`CPtrArray`] [__random_access_range__] [`void*&`]] + [[`CStringArray`] [__random_access_range__] [`CString&`]] + [[`CUIntArray`] [__random_access_range__] [`UINT&`]] + [[`CWordArray`] [__random_access_range__] [`WORD&`]] + [[`CObList`] [__bidirectional_range__] [`CObject*&`]] + [[`CPtrList`] [__bidirectional_range__] [`void*&`]] + [[`CStringList`] [__bidirectional_range__] [`CString&`]] + [[`CMapPtrToWord`] [__forward_range__] [`std::pair<void*,WORD> const`]] + [[`CMapPtrToPtr`] [__forward_range__] [`std::pair<void*,void*> const`]] + [[`CMapStringToOb`] [__forward_range__] [`std::pair<String,CObject*> const`]] + [[`CMapStringToString`] [__forward_range__] [`Range::CPair&`]] + [[`CMapWordToOb`] [__forward_range__] [`std::pair<WORD,CObject*> const`]] + [[`CMapWordToPtr`] [__forward_range__] [`std::pair<WORD,void*> const`]] +] + +Other Boost.Range metafunctions are defined by the following. Let `Range` be any type listed above and `Ref` be the same as `range_reference<Range>::type`. `range_value<Range>::type` is the same as `remove_reference<remove_const<Ref>::type>::type`, `range_difference<Range>::type` is the same as `std::ptrdiff_t`, and `range_pointer<Range>::type` is the same as `add_pointer<remove_reference<Ref>::type>::type`. As for `const Range`, see below. +[endsect] + +[section:atl_ranges ATL Ranges] + +If the `<boost/range/atl.hpp>` is included before or after Boost.Range headers, the ATL collections and strings become models of Range. The table below lists the Traversal Category and `range_reference` of ATL ranges. + +[table + [[Range] [Traversal Category] [`range_reference<Range>::type`]] + [[`CAtlArray<E,ET>`] [__random_access_range__] [`E&`]] + [[`CAutoPtrArray<E>`] [__random_access_range__] [`E&`]] + [[`CInterfaceArray<I,pi>`] [__random_access_range__] [`CComQIPtr<I,pi>&`]] + [[`CAtlList<E,ET>`] [__bidirectional_range__] [`E&`]] + [[`CAutoPtrList<E>`] [__bidirectional_range__] [`E&`]] + [[`CHeapPtrList<E,A>`] [__bidirectional_range__] [`E&`]] + [[`CInterfaceList<I,pi>`] [__bidirectional_range__] [`CComQIPtr<I,pi>&`]] + [[`CAtlMap<K,V,KT,VT>`] [__forward_range__] [`Range::CPair&`]] + [[`CRBTree<K,V,KT,VT>`] [__bidirectional_range__] [`Range::CPair&`]] + [[`CRBMap<K,V,KT,VT>`] [__bidirectional_range__] [`Range::CPair&`]] + [[`CRBMultiMap<K,V,KT,VT>`] [__bidirectional_range__] [`Range::CPair&`]] + [[`CSimpleStringT<B,b>`] [__random_access_range__] [`B&`]] + [[`CStringT<B,ST>`] [__random_access_range__] [`B&`]] + [[`CFixedStringT<S,n>`] [__random_access_range__] [`range_reference<S>::type`]] + [[`CComBSTR`] [__random_access_range__] [`OLECHAR&`]] + [[`CSimpleArray<T,TE>`] [__random_access_range__] [`T&`]] +] + +Other __boost_range_home__ metafunctions are defined by the following. Let `Range` be any type listed above and `Ref` be the same as `range_reference<Range>::type`. `range_value<Range>::type` is the same as `remove_reference<Ref>::type`, `range_difference<Range>::type` is the same as `std::ptrdiff_t`, and `range_pointer<Range>::type` is the same as `add_pointer<remove_reference<Ref>::type>::type`. As for `const Range`, see below. + +[endsect] + +[section:const_ranges const Ranges] + +`range_reference<const Range>::type` is defined by the following algorithm. Let `Range` be any type listed above and `Ref` be the same as `range_reference<Range>::type`. + +`` +if (Range is CObArray || Range is CObList) + return CObject const * & +else if (Range is CPtrArray || Range is CPtrList) + return void const * & +else if (there is a type X such that X& is the same as Ref) + return X const & +else if (there is a type X such that X* const is the same as Ref) + return X const * const +else + return Ref +`` + + +Other Boost.Range metafunctions are defined by the following. + +[table + [[Range metafunction] [Result]] + [[`range_value<const Range>::type`] [`range_value<Range>::type`]] + [[`range_difference<const Range>::type`] [`std::ptrdiff_t`]] + [[`range_pointer<const Range>::type`] [`add_pointer<remove_reference<range_reference<const Range>::type>::type>::type`]] +] + +[endsect] + +[section:references References] + +# __boost_range_home__ +# __mfc_collections__ +# __atl_collections__ + +[endsect] + +[endsect] diff --git a/libs/range/doc/mfc_atl.rst b/libs/range/doc/mfc_atl.rst new file mode 100644 index 0000000000..67498fb255 --- /dev/null +++ b/libs/range/doc/mfc_atl.rst @@ -0,0 +1,232 @@ + +++++++++++++++++++++++++++++++++ + |Boost| Range MFC/ATL Extension +++++++++++++++++++++++++++++++++ + +.. |Boost| image:: http://www.boost.org/libs/ptr_container/doc/boost.png + + + +:Author: Shunsuke Sogame +:Contact: mb2act@yahoo.co.jp +:date: 26th of May 2006 +:copyright: Shunsuke Sogame 2005-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see LICENSE_1_0.txt__). + +__ http://www.boost.org/LICENSE_1_0.txt + + + +======== +Overview +======== + +Boost.Range MFC/ATL Extension provides `Boost.Range`_ support for MFC/ATL collection and string types. + + +.. parsed-literal:: + + CTypedPtrArray<CPtrArray, CList<CString> \*> myArray; + ... + BOOST_FOREACH (CList<CString> \*theList, myArray) + { + BOOST_FOREACH (CString& str, \*theList) + { + boost::to_upper(str); + std::sort(boost::begin(str), boost::end(str)); + ... + } + } + + + +* `Requirements`_ +* `MFC Ranges`_ +* `ATL Ranges`_ +* `const Ranges`_ +* `References`_ + + + +============ +Requirements +============ + +- `Boost C++ Libraries Version 1.34.0`__ or later (no compilation required) +- Visual C++ 7.1 or Visual C++ 8.0 + +__ Boost_ + + + +========== +MFC Ranges +========== + +If the ``<boost/range/mfc.hpp>`` is included before or after `Boost.Range`_ headers, +the MFC collections and strings become models of Range. +The table below lists the Traversal Category and ``range_reference`` of MFC ranges. + + +============================= ================== ======================================= +``Range`` Traversal Category ``range_reference<Range>::type`` +============================= ================== ======================================= +``CArray<T,A>`` Random Access ``T&`` +----------------------------- ------------------ --------------------------------------- +``CList<T,A>`` Bidirectional ``T&`` +----------------------------- ------------------ --------------------------------------- +``CMap<K,AK,M,AM>`` Forward ``Range::CPair&`` +----------------------------- ------------------ --------------------------------------- +``CTypedPtrArray<B,T*>`` Random Access ``T* const`` +----------------------------- ------------------ --------------------------------------- +``CTypedPtrList<B,T*>`` Bidirectional ``T* const`` +----------------------------- ------------------ --------------------------------------- +``CTypedPtrMap<B,T*,V*>`` Forward ``std::pair<T*,V*> const`` +----------------------------- ------------------ --------------------------------------- +``CByteArray`` Random Access ``BYTE&`` +----------------------------- ------------------ --------------------------------------- +``CDWordArray`` Random Access ``DWORD&`` +----------------------------- ------------------ --------------------------------------- +``CObArray`` Random Access ``CObject* &`` +----------------------------- ------------------ --------------------------------------- +``CPtrArray`` Random Access ``void* &`` +----------------------------- ------------------ --------------------------------------- +``CStringArray`` Random Access ``CString&`` +----------------------------- ------------------ --------------------------------------- +``CUIntArray`` Random Access ``UINT&`` +----------------------------- ------------------ --------------------------------------- +``CWordArray`` Random Access ``WORD&`` +----------------------------- ------------------ --------------------------------------- +``CObList`` Bidirectional ``CObject* &`` +----------------------------- ------------------ --------------------------------------- +``CPtrList`` Bidirectional ``void* &`` +----------------------------- ------------------ --------------------------------------- +``CStringList`` Bidirectional ``CString&`` +----------------------------- ------------------ --------------------------------------- +``CMapPtrToWord`` Forward ``std::pair<void*,WORD> const`` +----------------------------- ------------------ --------------------------------------- +``CMapPtrToPtr`` Forward ``std::pair<void*,void*> const`` +----------------------------- ------------------ --------------------------------------- +``CMapStringToOb`` Forward ``std::pair<String,CObject*> const`` +----------------------------- ------------------ --------------------------------------- +``CMapStringToString`` Forward ``Range::CPair&`` +----------------------------- ------------------ --------------------------------------- +``CMapWordToOb`` Forward ``std::pair<WORD,CObject*> const`` +----------------------------- ------------------ --------------------------------------- +``CMapWordToPtr`` Forward ``std::pair<WORD,void*> const`` +============================= ================== ======================================= + + +Other `Boost.Range`_ metafunctions are defined by the following. +Let ``Range`` be any type listed above and ``ReF`` be the same as ``range_reference<Range>::type``. +``range_value<Range>::type`` is the same as ``remove_reference<remove_const<Ref>::type>::type``, +``range_difference<Range>::type`` is the same as ``std::ptrdiff_t``, and +``range_pointer<Range>::type`` is the same as ``add_pointer<remove_reference<Ref>::type>::type``. +As for ``const Range``, see `const Ranges`_. + + + +========== +ATL Ranges +========== + +If the ``<boost/range/atl.hpp>`` is included before or after `Boost.Range`_ headers, +the ATL collections and strings become models of Range. +The table below lists the Traversal Category and ``range_reference`` of ATL ranges. + + +============================= ================== ======================================= +``Range`` Traversal Category ``range_reference<Range>::type`` +============================= ================== ======================================= +``CAtlArray<E,ET>`` Random Access ``E&`` +----------------------------- ------------------ --------------------------------------- +``CAutoPtrArray<E>`` Random Access ``E&`` +----------------------------- ------------------ --------------------------------------- +``CInterfaceArray<I,pi>`` Random Access ``CComQIPtr<I,pi>&`` +----------------------------- ------------------ --------------------------------------- +``CAtlList<E,ET>`` Bidirectional ``E&`` +----------------------------- ------------------ --------------------------------------- +``CAutoPtrList<E>`` Bidirectional ``E&`` +----------------------------- ------------------ --------------------------------------- +``CHeapPtrList<E,A>`` Bidirectional ``E&`` +----------------------------- ------------------ --------------------------------------- +``CInterfaceList<I,pi>`` Bidirectional ``CComQIPtr<I,pi>&`` +----------------------------- ------------------ --------------------------------------- +``CAtlMap<K,V,KT,VT>`` Forward ``Range::CPair&`` +----------------------------- ------------------ --------------------------------------- +``CRBTree<K,V,KT,VT>`` Bidirectional ``Range::CPair&`` +----------------------------- ------------------ --------------------------------------- +``CRBMap<K,V,KT,VT>`` Bidirectional ``Range::CPair&`` +----------------------------- ------------------ --------------------------------------- +``CRBMultiMap<K,V,KT,VT>`` Bidirectional ``Range::CPair&`` +----------------------------- ------------------ --------------------------------------- +``CSimpleStringT<B,b>`` Random Access ``B&`` +----------------------------- ------------------ --------------------------------------- +``CStringT<B,ST>`` Random Access ``B&`` +----------------------------- ------------------ --------------------------------------- +``CFixedStringT<S,n>`` Random Access ``range_reference<S>::type`` +----------------------------- ------------------ --------------------------------------- +``CStringT<B,ST>`` Random Access ``B&`` +----------------------------- ------------------ --------------------------------------- +``CComBSTR`` Random Access ``OLECHAR&`` +----------------------------- ------------------ --------------------------------------- +``CSimpleArray<T,TE>`` Random Access ``T&`` +============================= ================== ======================================= + + +Other `Boost.Range`_ metafunctions are defined by the following. +Let ``Range`` be any type listed above and ``ReF`` be the same as ``range_reference<Range>::type``. +``range_value<Range>::type`` is the same as ``remove_reference<Ref>::type``, +``range_difference<Range>::type`` is the same as ``std::ptrdiff_t``, and +``range_pointer<Range>::type`` is the same as ``add_pointer<remove_reference<Ref>::type>::type``. +As for ``const Range``, see `const Ranges`_. + + + +============ +const Ranges +============ + +``range_reference<const Range>::type`` is defined by the following algorithm. +Let ``Range`` be any type listed above and ``ReF`` be the same as ``range_reference<Range>::type``. + + +.. parsed-literal:: + + if (Range is CObArray || Range is CObList) + return CObject const \* & + else if (Range is CPtrArray || Range is CPtrList) + return void const \* & + else if (there is a type X such that X& is the same as ReF) + return X const & + else if (there is a type X such that X* const is the same as ReF) + return X const \* const + else + return ReF + + +Other `Boost.Range`_ metafunctions are defined by the following. +``range_value<const Range>::type`` is the same as ``range_value<Range>::type``, +``range_difference<const Range>::type`` is the same as ``std::ptrdiff_t``, and +``range_pointer<const Range>::type`` is the same as ``add_pointer<remove_reference<range_reference<const Range>::type>::type>::type``. + + + +========== +References +========== +- `Boost.Range`_ +- `MFC Collections`__ +- `ATL Collection Classes`__ + +__ http://msdn2.microsoft.com/en-us/library/942860sh.aspx +__ http://msdn2.microsoft.com/en-US/library/15e672bd.aspx + + + +.. _Boost C++ Libraries: http://www.boost.org/ +.. _Boost: `Boost C++ Libraries`_ +.. _Boost.Range: ../index.html +.. _forward: range.html#forward_range +.. _bidirectional: range.html#forward_range +.. _random access: range.html#random_access_range + diff --git a/libs/range/doc/portability.qbk b/libs/range/doc/portability.qbk new file mode 100644 index 0000000000..aed3825859 --- /dev/null +++ b/libs/range/doc/portability.qbk @@ -0,0 +1,27 @@ +[/ + 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:portability Portability] + +A huge effort has been made to port the library to as many compilers as possible. + +Full support for built-in arrays require that the compiler supports class template partial specialization. For non-conforming compilers there might be a chance that it works anyway thanks to workarounds in the type traits library. +Visual C++ 6/7.0 has a limited support for arrays: as long as the arrays are of built-in type it should work. + +Notice also that some compilers cannot do function template ordering properly. In that case one must rely of __range_iterator__ and a single function definition instead of overloaded versions for const and non-const arguments. So if one cares about old compilers, one should not pass rvalues to the functions. + +For maximum portability you should follow these guidelines: + +# do not use built-in arrays, +# do not pass rvalues to __begin__`()`, __end__`()` and __iterator_range__ Range constructors and assignment operators, +# use __const_begin__`()` and __const_end__`()` whenever your code by intention is read-only; this will also solve most rvalue problems, +# do not rely on ADL: + * if you overload functions, include that header before the headers in this library, + * put all overloads in namespace boost. + + + +[endsect] + diff --git a/libs/range/doc/reference.qbk b/libs/range/doc/reference.qbk new file mode 100644 index 0000000000..14cf8e865e --- /dev/null +++ b/libs/range/doc/reference.qbk @@ -0,0 +1,21 @@ +[/ + 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:reference Reference] + +[include reference/overview.qbk] + +[section:concept_implementation Range concept implementation] +[include reference/synopsis.qbk] +[include reference/semantics.qbk] +[endsect] + +[include reference/adaptors.qbk] +[include reference/algorithms.qbk] +[include reference/ranges.qbk] +[include reference/utilities.qbk] +[include reference/extending.qbk] + +[endsect] diff --git a/libs/range/doc/reference/adaptors.qbk b/libs/range/doc/reference/adaptors.qbk new file mode 100644 index 0000000000..91401c0d46 --- /dev/null +++ b/libs/range/doc/reference/adaptors.qbk @@ -0,0 +1,187 @@ +[/ + 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:adaptors Range Adaptors] + +[section:introduction Introduction and motivation] + +A [*Range Adaptor] is a class that wraps an existing Range to provide a new Range with different behaviour. Since the behaviour of Ranges is determined by their associated iterators, a Range Adaptor simply wraps the underlying iterators with new special iterators. In this example + +`` +#include <boost/range/adaptors.hpp> +#include <boost/range/algorithm.hpp> +#include <iostream> +#include <vector> + +std::vector<int> vec; +boost::copy( vec | boost::adaptors::reversed, + std::ostream_iterator<int>(std::cout) ); +`` + +the iterators from `vec` are wrapped `reverse_iterator`s. The type of the underlying Range Adapter is not documented because you do not need to know it. All that is relevant is that the expression + +`` +vec | boost::adaptors::reversed +`` + +returns a Range Adaptor where the iterator type is now the iterator type of the range `vec` wrapped in `reverse_iterator`. The expression `boost::adaptors::reversed` is called an *Adaptor Generator*. + +There are two ways of constructing a range adaptor. The first is by using `operator|()`. This is my preferred technique, however while discussing range adaptors with others it became clear that some users of the library strongly prefer a more familiar function syntax, so equivalent functions of the present tense form have been added as an alternative syntax. The equivalent to `rng | reversed` is `adaptors::reverse(rng)` for example. + +Why do I prefer the `operator|` syntax? The answer is readability: + +`` +std::vector<int> vec; +boost::copy( boost::adaptors::reverse(vec), + std::ostream_iterator<int>(std::cout) ); +`` + +This might not look so bad, but when we apply several adaptors, it becomes much worse. Just compare + +`` +std::vector<int> vec; +boost::copy( boost::adaptors::unique( boost::adaptors::reverse( vec ) ), + std::ostream_iterator<int>(std::cout) ); +`` + +to + +`` +std::vector<int> vec; +boost::copy( vec | boost::adaptors::reversed + | boost::adaptors::uniqued, + std::ostream_iterator<int>(std::cout) ); +`` + +Furthermore, some of the adaptor generators take arguments themselves and these arguments are expressed with function call notation too. In those situations, you will really appreciate the succinctness of `operator|()`. + +[heading Composition of Adaptors] + +Range Adaptors are a powerful complement to Range algorithms. The reason is that adaptors are ['*orthogonal*] to algorithms. For example, consider these Range algorithms: + +* `boost::copy( rng, out )` +* `boost::count( rng, pred )` + +What should we do if we only want to copy an element `a` if it satisfies some predicate, say `pred(a)`? And what if we only want to count the elements that satisfy the same predicate? The naive answer would be to use these algorithms: + +* `boost::copy_if( rng, pred, out )` +* `boost::count_if( rng, pred )` + +These algorithms are only defined to maintain a one to one relationship with the standard library algorithms. This approach of adding algorithm suffers a combinatorial explosion. Inevitably many algorithms are missing `_if` variants and there is redundant development overhead for each new algorithm. The Adaptor Generator is the design solution to this problem. + +[heading Range Adaptor alternative to copy_if algorithm] +`` +boost::copy_if( rng, pred, out ); +`` +can be expressed as +`` +boost::copy( rng | boost::adaptors::filtered(pred), out ); +`` + +[heading Range Adaptor alternative to count_if algorithm] +`` +boost::count_if( rng, pred ); +`` +can be expressed as +`` +boost::count( rng | boost::adaptors::filtered(pred), out ); +`` + +What this means is that ['*no*] algorithm with the `_if` suffix is needed. Furthermore, it turns out that algorithms with the `_copy` suffix are not needed either. Consider the somewhat misdesigned `replace_copy_if()` which may be used as + +`` +std::vector<int> vec; +boost::replace_copy_if( rng, std::back_inserter(vec), pred ); +`` + +With adaptors and algorithms we can express this as + +`` +std::vector<int> vec; +boost::push_back(vec, rng | boost::adaptors::replaced_if(pred, new_value)); +`` + +The latter code has several benefits: + +1. it is more ['*efficient*] because we avoid extra allocations as might happen with `std::back_inserter` + +2. it is ['*flexible*] as we can subsequently apply even more adaptors, for example: `` +boost::push_back(vec, rng | boost::adaptors::replaced_if(pred, new_value) + | boost::adaptors::reversed); +`` + +3. it is ['*safer*] because there is no use of an unbounded output iterator. + +In this manner, the ['*composition*] of Range Adaptors has the following consequences: + +1. we no longer need `_if`, `_copy`, `_copy_if` and `_n` variants of algorithms. + +2. we can generate a multitude of new algorithms on the fly, for example, above we generated `reverse_replace_copy_if()` + +In other words: + +[*Range Adaptors are to algorithms what algorithms are to containers] + +[endsect] + +[section:general_requirements General Requirements] + +In the description of generator expressions, the following notation is used: + +* `fwdRng` is an expression of a type `R` that models `ForwardRange` +* `biRng` is an expression of a type `R` that models `BidirectionalRange` +* `rndRng` is an expression of a type `R` that models `RandomAccessRange` +* `pred` is an expression of a type that models `UnaryPredicate` +* `bi_pred` is an expression of a type that models `BinaryPredicate` +* `fun` is an expression of a type that models `UnaryFunction` +* `value`, `new_value` and `old_value` are objects convertible to `boost::range_value<R>::type` +* `n,m` are integer expressions convertible to `range_difference<R>::type` + +Also note that `boost::range_value<R>::type` must be implicitly convertible to the type arguments to `pred`, `bi_pred` and `fun`. + +Range Category in the following adaptor descriptions refers to the minimum range concept required by the range passed to the adaptor. The resultant range is a model of the same range concept as the input range unless specified otherwise. + +Returned Range Category is the concept of the returned range. In some cases the returned range is of a lesser category than the range passed to the adaptor. For example, the `filtered` adaptor returns only a `ForwardRange` regardless of the input. + +Furthermore, the following rules apply to any expression of the form +`` +rng | boost::adaptors::adaptor_generator +`` + +1. Applying `operator|()` to a range `R` (always left argument) and a range adapter `RA` (always right argument) yields a new range type which may not conform to the same range concept as `R`. + +2. The return-type of `operator|()` is otherwise unspecified. + +3. `operator|()` is found by Argument Dependent Lookup (ADL) because a range adaptor is implemented in namespace `boost::adaptors`. + +4. `operator|()` is used to add new behaviour ['*lazily*] and never modifies its left argument. + +5. All iterators extracted from the left argument are extracted using qualified calls to `boost::begin()` and `boost::end()`. + +6. In addition to the `throw`-clauses below, `operator|()` may throw exceptions as a result of copying iterators. If such copying cannot throw an exception, then neither can the whole expression. + +[endsect] + +[section:reference Reference] +[include adaptors/adjacent_filtered.qbk] +[include adaptors/copied.qbk] +[include adaptors/filtered.qbk] +[include adaptors/indexed.qbk] +[include adaptors/indirected.qbk] +[include adaptors/map_keys.qbk] +[include adaptors/map_values.qbk] +[include adaptors/replaced.qbk] +[include adaptors/replaced_if.qbk] +[include adaptors/reversed.qbk] +[include adaptors/sliced.qbk] +[include adaptors/strided.qbk] +[include adaptors/type_erased.qbk] +[include adaptors/tokenized.qbk] +[include adaptors/transformed.qbk] +[include adaptors/uniqued.qbk] +[endsect] + +[endsect] + diff --git a/libs/range/doc/reference/adaptors/adjacent_filtered.qbk b/libs/range/doc/reference/adaptors/adjacent_filtered.qbk new file mode 100644 index 0000000000..a15f992c36 --- /dev/null +++ b/libs/range/doc/reference/adaptors/adjacent_filtered.qbk @@ -0,0 +1,54 @@ +[/ + 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:adjacent_filtered adjacent_filtered] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::adjacent_filtered(bi_pred)`]] + [[Function] [`boost::adaptors::adjacent_filter(rng, bi_pred)`]] +] + +* [*Precondition:] The `value_type` of the range is convertible to both argument types of `bi_pred`. +* [*Postcondition:] For all adjacent elements `[x,y]` in the returned range, `bi_pred(x,y)` is `true`. +* [*Throws:] Whatever the copy constructor of `bi_pred` might throw. +* [*Range Category:] __single_pass_range__ +* [*Return Type:] `boost::adjacent_filtered_range<typeof(rng)>` +* [*Returned Range Category:] The minimum of the range category of `rng` and __forward_range__ + +[section:adjacent_filtered_example adjacent_filtered example] +`` +#include <boost/range/adaptor/adjacent_filtered.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <functional> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,1,2,2,2,3,4,5,6; + + boost::copy( + input | adjacent_filtered(std::not_equal_to<int>()), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +1,2,3,4,5,6 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/copied.qbk b/libs/range/doc/reference/adaptors/copied.qbk new file mode 100644 index 0000000000..69ee46d9fe --- /dev/null +++ b/libs/range/doc/reference/adaptors/copied.qbk @@ -0,0 +1,51 @@ +[/ + 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:copied copied] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::copied(n, m)`]] + [[Function] [`boost::adaptors::copy(rng, n, m)`]] +] + +* [*Precondition:] `0 <= n && n <= m && m < distance(rng)` +* [*Returns:] A new `iterator_range` that holds the sliced range `[n,m)` of the original range. +* [*Range Category:] __random_access_range__ +* [*Returned Range Category:] __random_access_range__ + +[section:copied_example copied example] +`` +#include <boost/range/adaptor/copied.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9,10; + + boost::copy( + input | copied(1, 5), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +2,3,4,5 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/examples/adjacent_filtered.cpp b/libs/range/doc/reference/adaptors/examples/adjacent_filtered.cpp new file mode 100644 index 0000000000..cc7cd9b658 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/adjacent_filtered.cpp @@ -0,0 +1,32 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/adjacent_filtered.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <functional> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,1,2,2,2,3,4,5,6; + + boost::copy( + input | adjacent_filtered(std::not_equal_to<int>()), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/copied.cpp b/libs/range/doc/reference/adaptors/examples/copied.cpp new file mode 100644 index 0000000000..2de46abf95 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/copied.cpp @@ -0,0 +1,31 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/copied.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9,10; + + boost::copy( + input | copied(1, 5), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/filtered.cpp b/libs/range/doc/reference/adaptors/examples/filtered.cpp new file mode 100644 index 0000000000..647123784d --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/filtered.cpp @@ -0,0 +1,36 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/filtered.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +struct is_even +{ + bool operator()(int x) const { return x % 2 == 0; } +}; + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | filtered(is_even()), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/indexed.cpp b/libs/range/doc/reference/adaptors/examples/indexed.cpp new file mode 100644 index 0000000000..bb141e8297 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/indexed.cpp @@ -0,0 +1,45 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/indexed.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +template<typename Iterator> +void display_element_and_index(Iterator first, Iterator last) +{ + for (Iterator it = first; it != last; ++it) + { + std::cout << "Element = " << *it + << " Index = " << it.index() << std::endl; + } +} + +template<typename SinglePassRange> +void display_element_and_index(const SinglePassRange& rng) +{ + display_element_and_index(boost::begin(rng), boost::end(rng)); +} + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 10,20,30,40,50,60,70,80,90; + + display_element_and_index( input | indexed(0) ); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/indirected.cpp b/libs/range/doc/reference/adaptors/examples/indirected.cpp new file mode 100644 index 0000000000..efb9d13cc4 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/indirected.cpp @@ -0,0 +1,32 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/indirected.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/shared_ptr.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + + std::vector<boost::shared_ptr<int> > input; + + for (int i = 0; i < 10; ++i) + input.push_back(boost::shared_ptr<int>(new int(i))); + + boost::copy( + input | indirected, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/map_keys.cpp b/libs/range/doc/reference/adaptors/examples/map_keys.cpp new file mode 100644 index 0000000000..006e7e922d --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/map_keys.cpp @@ -0,0 +1,33 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/map.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <map> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::map<int, int> input; + for (int i = 0; i < 10; ++i) + input.insert(std::make_pair(i, i * 10)); + + boost::copy( + input | map_keys, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/map_values.cpp b/libs/range/doc/reference/adaptors/examples/map_values.cpp new file mode 100644 index 0000000000..a0fa6515ff --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/map_values.cpp @@ -0,0 +1,33 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/map.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <map> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::map<int, int> input; + for (int i = 0; i < 10; ++i) + input.insert(std::make_pair(i, i * 10)); + + boost::copy( + input | map_values, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/replaced.cpp b/libs/range/doc/reference/adaptors/examples/replaced.cpp new file mode 100644 index 0000000000..7b85ba157f --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/replaced.cpp @@ -0,0 +1,31 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/replaced.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,2,5,2,7,2,9; + + boost::copy( + input | replaced(2, 10), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/replaced_if.cpp b/libs/range/doc/reference/adaptors/examples/replaced_if.cpp new file mode 100644 index 0000000000..23952f7240 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/replaced_if.cpp @@ -0,0 +1,35 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/replaced_if.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +struct is_even +{ + bool operator()(int x) const { return x % 2 == 0; } +}; + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | replaced_if(is_even(), 10), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} diff --git a/libs/range/doc/reference/adaptors/examples/reversed.cpp b/libs/range/doc/reference/adaptors/examples/reversed.cpp new file mode 100644 index 0000000000..85696cbcfe --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/reversed.cpp @@ -0,0 +1,31 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/reversed.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | reversed, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/sliced.cpp b/libs/range/doc/reference/adaptors/examples/sliced.cpp new file mode 100644 index 0000000000..cc8b9cbd15 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/sliced.cpp @@ -0,0 +1,31 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/sliced.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | sliced(2, 5), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/strided.cpp b/libs/range/doc/reference/adaptors/examples/strided.cpp new file mode 100644 index 0000000000..f12b72a5ed --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/strided.cpp @@ -0,0 +1,31 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/strided.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9,10; + + boost::copy( + input | strided(2), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/tokenized.cpp b/libs/range/doc/reference/adaptors/examples/tokenized.cpp new file mode 100644 index 0000000000..273eaf1f2e --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/tokenized.cpp @@ -0,0 +1,28 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/tokenized.hpp> +#include <boost/range/algorithm_ext/push_back.hpp> +#include <boost/assert.hpp> +#include <algorithm> +#include <string> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + + std::string input = " a b c d e f g hijklmnopqrstuvwxyz"; + std::vector< boost::sub_match< std::string::iterator > > result; + boost::push_back(result, input | tokenized(boost::regex("\\b"))); + + BOOST_ASSERT( boost::size(result) == 16u ); + + return 0; +} diff --git a/libs/range/doc/reference/adaptors/examples/transformed.cpp b/libs/range/doc/reference/adaptors/examples/transformed.cpp new file mode 100644 index 0000000000..62bf5d46fb --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/transformed.cpp @@ -0,0 +1,37 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/transformed.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +struct double_int +{ + typedef int result_type; + int operator()(int x) const { return x * 2; } +}; + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9,10; + + boost::copy( + input | transformed(double_int()), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/examples/uniqued.cpp b/libs/range/doc/reference/adaptors/examples/uniqued.cpp new file mode 100644 index 0000000000..a7b2f8e4e4 --- /dev/null +++ b/libs/range/doc/reference/adaptors/examples/uniqued.cpp @@ -0,0 +1,31 @@ +// Boost.Range library +// +// Copyright Thorsten Ottosen 2003-2004. Use, modification and +// distribution is subject to 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) +// +// For more information, see http://www.boost.org/libs/range/ +// +#include <boost/range/adaptor/uniqued.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,1,2,2,2,3,4,5,6; + + boost::copy( + input | uniqued, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} + diff --git a/libs/range/doc/reference/adaptors/filtered.qbk b/libs/range/doc/reference/adaptors/filtered.qbk new file mode 100644 index 0000000000..1b145248d4 --- /dev/null +++ b/libs/range/doc/reference/adaptors/filtered.qbk @@ -0,0 +1,56 @@ +[/ + 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:filtered filtered] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::filtered(pred)`]] + [[Function] [`boost::adaptors::filter(rng, pred)`]] +] + +* [*Precondition:] The `value_type` of the range is convertible to the argument type of `pred`. +* [*Postcondition:] For all adjacent elements `[x]` in the returned range, `pred(x)` is `true`. +* [*Throws:] Whatever the copy constructor of `pred` might throw. +* [*Range Category:] __forward_range__ +* [*Range Return Type:] `boost::filtered_range<typeof(rng)>` +* [*Returned Range Category:] The minimum of the range category of `rng` and __bidirectional_range__ + +[section:filtered_example filtered example] +`` +#include <boost/range/adaptor/filtered.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +struct is_even +{ + bool operator()( int x ) const { return x % 2 == 0; } +}; + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | filtered(is_even()), + std::ostream_iterator<int>(std::cout, ",")); +} +`` +[endsect] + +This would produce the output: +`` +2,4,6,8 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/indexed.qbk b/libs/range/doc/reference/adaptors/indexed.qbk new file mode 100644 index 0000000000..9778f20c4b --- /dev/null +++ b/libs/range/doc/reference/adaptors/indexed.qbk @@ -0,0 +1,93 @@ +[/ + 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:indexed indexed] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::indexed`]] + [[Function] [`boost::adaptors::index(rng)`]] +] + +* [*Returns:] A range adapted to return both the element and the associated index. The returned range consists of iterators that have in addition to the usual iterator member functions an `index()` member function that returns the appropriate index for the element in the sequence corresponding with the iterator. +* [*Range Category:] __single_pass_range__ +* [*Range Return Type:] `boost::indexed_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng` + +[section:indexed_example indexed example] +`` +#include <boost/range/adaptor/indexed.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +template<class Iterator> +void display_element_and_index(Iterator first, Iterator last) +{ + for (Iterator it = first; it != last; ++it) + { + std::cout << "Element = " << *it << " Index = " << it.index() << std::endl; + } +} + +template<class SinglePassRange> +void display_element_and_index(const SinglePassRange& rng) +{ + display_element_and_index(boost::begin(rng), boost::end(rng)); +} + +template<class Iterator1, class Iterator2> +void check_element_and_index( + Iterator1 test_first, + Iterator1 test_last, + Iterator2 reference_first, + Iterator2 reference_last) +{ + BOOST_CHECK_EQUAL( std::distance(test_first, test_last), + std::distance(reference_first, reference_last) ); + + int reference_index = 0; + + Iterator1 test_it = test_first; + Iterator2 reference_it = reference_first; + for (; test_it != test_last; ++test_it, ++reference_it, ++reference_index) + { + BOOST_CHECK_EQUAL( *test_it, *reference_it ); + BOOST_CHECK_EQUAL( test_it.index(), reference_index ); + } +} + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 10,20,30,40,50,60,70,80,90; + + display_element_and_index( input | indexed(0) ); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +Element = 10 Index = 0 +Element = 20 Index = 1 +Element = 30 Index = 2 +Element = 40 Index = 3 +Element = 50 Index = 4 +Element = 60 Index = 5 +Element = 70 Index = 6 +Element = 80 Index = 7 +Element = 90 Index = 8 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/indirected.qbk b/libs/range/doc/reference/adaptors/indirected.qbk new file mode 100644 index 0000000000..5a1ed059e8 --- /dev/null +++ b/libs/range/doc/reference/adaptors/indirected.qbk @@ -0,0 +1,53 @@ +[/ + 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:indirected indirected] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::indirected`]] + [[Function] [`boost::adaptors::indirect(rng)`]] +] + +* [*Precondition:] The `value_type` of the range defines unary `operator*()` +* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `*y` where `y` is the corresponding element in the original range. +* [*Range Category:] __single_pass_range__ +* [*Range Return Type:] `boost::indirected_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng` + +[section:indirected_example indirected example] +`` +#include <boost/range/adaptor/indirected.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/shared_ptr.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + + std::vector<boost::shared_ptr<int> > input; + + for (int i = 0; i < 10; ++i) + input.push_back(boost::shared_ptr<int>(new int(i))); + + boost::copy( + input | indirected, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +0,1,2,3,4,5,6,7,8,9 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/map_keys.qbk b/libs/range/doc/reference/adaptors/map_keys.qbk new file mode 100644 index 0000000000..01b9d34f42 --- /dev/null +++ b/libs/range/doc/reference/adaptors/map_keys.qbk @@ -0,0 +1,54 @@ +[/ + 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:map_keys map_keys] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::map_keys`]] + [[Function] [`boost::adaptors::keys(rng)`]] +] + +* [*Precondition:] The `value_type` of the range is an instantiation of `std::pair`. +* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `y.first` where `y` is the corresponding element in the original range. +* [*Range Category:] __single_pass_range__ +* [*Range Return Type:] `boost::select_first_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng`. + +[section:map_keys_example map_keys example] +`` +#include <boost/range/adaptor/map.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <map> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::map<int,int> input; + for (int i = 0; i < 10; ++i) + input.insert(std::make_pair(i, i * 10)); + + boost::copy( + input | map_keys, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +0,1,2,3,4,5,6,7,8,9 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/map_values.qbk b/libs/range/doc/reference/adaptors/map_values.qbk new file mode 100644 index 0000000000..17ad9c4518 --- /dev/null +++ b/libs/range/doc/reference/adaptors/map_values.qbk @@ -0,0 +1,54 @@ +[/ + 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:map_values map_values] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::map_values`]] + [[Function] [`boost::adaptors::values(rng)`]] +] + +* [*Precondition:] The `value_type` of the range is an instantiation of `std::pair`. +* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `y.second` where `y` is the corresponding element in the original range. +* [*Range Category:] __single_pass_range__ +* [*Range Return Type:] for constant ranges, `boost::select_second_const<typeof(rng)>` otherwise `boost:select_second_mutable<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng`. + +[section:map_values_example map_values example] +`` +#include <boost/range/adaptor/map.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <map> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::map<int,int> input; + for (int i = 0; i < 10; ++i) + input.insert(std::make_pair(i, i * 10)); + + boost::copy( + input | map_values, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +0,10,20,30,40,50,60,70,80,90 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/replaced.qbk b/libs/range/doc/reference/adaptors/replaced.qbk new file mode 100644 index 0000000000..3df708c573 --- /dev/null +++ b/libs/range/doc/reference/adaptors/replaced.qbk @@ -0,0 +1,54 @@ +[/ + 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:replaced replaced] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::replaced(new_value, old_value)`]] + [[Function] [`boost::adaptors::replace(rng, new_value, old_value)`]] +] + +* [*Precondition:] + * `new_value` is convertible to the `value_type` of the range. + * `old_value` is convertible to the `value_type` of the range. +* [*Postcondition:] For all elements `x` in the returned range, the value `x` is equal to the value of `(y == old_value) ? new_value : y` where `y` is the corresponding element in the original range. +* [*Range Category:] __forward_range__ +* [*Range Return Type:] `boost::replaced_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng`. + +[section:replaced_example replaced example] +`` +#include <boost/range/adaptor/replaced.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,2,5,2,7,2,9; + + boost::copy( + input | replaced(2, 10), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +1,10,3,10,5,10,7,10,9 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/replaced_if.qbk b/libs/range/doc/reference/adaptors/replaced_if.qbk new file mode 100644 index 0000000000..b160b34ec4 --- /dev/null +++ b/libs/range/doc/reference/adaptors/replaced_if.qbk @@ -0,0 +1,59 @@ +[/ + 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:replaced_if replaced_if] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::replaced_if(pred, new_value)`]] + [[Function] [`boost::adaptors::replace_if(rng, pred, new_value)`]] +] + +* [*Precondition:] + * The range `value_type` is convertible to the argument type of `pred`. + * `new_value` is convertible to the `value_type` of the range. +* [*Postconditions:] For all elements `x` in the returned range, the value `x` is equal to the value of `pred(y) ? new_value : y` where `y` is the corresponding element in the original range. +* [*Range Category:] __forward_range__ +* [*Range Return Type:] `boost::replaced_if_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng`. + +[section:replaced_if_example replaced_if example] +`` +#include <boost/range/adaptor/replaced_if.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +struct is_even +{ + bool operator()(int x) const { return x % 2 == 0; } +}; + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | replaced_if(is_even(), 10), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +1,10,3,10,5,10,7,10,9 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/reversed.qbk b/libs/range/doc/reference/adaptors/reversed.qbk new file mode 100644 index 0000000000..71164753c0 --- /dev/null +++ b/libs/range/doc/reference/adaptors/reversed.qbk @@ -0,0 +1,51 @@ +[/ + 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:reversed reversed] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::reversed`]] + [[Function] [`boost::adaptors::reverse(rng)`]] +] + +* [*Returns:] A range whose iterators behave as if they were the original iterators wrapped in `reverse_iterator`. +* [*Range Category:] __bidirectional_range__ +* [*Range Return Type:] `boost::reversed_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng`. + +[section:reversed_example reversed example] +`` +#include <boost/range/adaptor/reversed.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +void reversed_example_test() +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | reversed, + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +9,8,7,6,5,4,3,2,1 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/sliced.qbk b/libs/range/doc/reference/adaptors/sliced.qbk new file mode 100644 index 0000000000..33b57ca4b2 --- /dev/null +++ b/libs/range/doc/reference/adaptors/sliced.qbk @@ -0,0 +1,52 @@ +[/ + 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:sliced sliced] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::sliced(n, m)`]] + [[Function] [`boost::adaptors::slice(rng, n, m)`]] +] + +* [*Precondition:] `0 <= n && n <= m && m < distance(rng)` +* [*Returns:] `make_range(rng, n, m)` +* [*Range Category:] __random_access_range__ +* [*Range Return Type:] `boost::sliced_range<typeof(rng)>` +* [*Returned Range Category:] __random_access_range__ + +[section:sliced_example sliced example] +`` +#include <boost/range/adaptor/sliced.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9; + + boost::copy( + input | sliced(2, 5), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +3,4,5 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/strided.qbk b/libs/range/doc/reference/adaptors/strided.qbk new file mode 100644 index 0000000000..e219a83967 --- /dev/null +++ b/libs/range/doc/reference/adaptors/strided.qbk @@ -0,0 +1,51 @@ +[/ + 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:strided strided] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::strided(n)`]] + [[Function] [`boost::adaptors::stride(rng, n)`]] +] + +* [*Precondition:] `0 <= n`. +* [*Returns:] A new range based on `rng` where traversal is performed in steps of `n`. +* [*Range Category:] __single_pass_range__ +* [*Returned Range Category:] The range category of `rng`. + +[section:strided_example strided example] +`` +#include <boost/range/adaptor/strided.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9,10; + + boost::copy( + input | strided(2), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +1,3,5,7,9 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/tokenized.qbk b/libs/range/doc/reference/adaptors/tokenized.qbk new file mode 100644 index 0000000000..2127785ff8 --- /dev/null +++ b/libs/range/doc/reference/adaptors/tokenized.qbk @@ -0,0 +1,49 @@ +[/ + 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:tokenized tokenized] + +[table + [[Syntax] [Code]] + [ + [Pipe] + [ + `` + rng | boost::adaptors::tokenized(regex) + rng | boost::adaptors::tokenized(regex, i) + rng | boost::adaptors::tokenized(regex, rndRng) + rng | boost::adaptors::tokenized(regex, i, flags) + rng | boost::adaptors::tokenized(regex, rndRng, flags) + `` + ] + ] + [ + [Function] + [ + `` + boost::adaptors::tokenize(rng, regex) + boost::adaptors::tokenize(rng, regex, i) + boost::adaptors::tokenize(rng, regex, rndRng) + boost::adaptors::tokenize(rng, regex, i, flags) + boost::adaptors::tokenize(rng, regex, rndRng, flags) + `` + ] + ] +] + +* [*Precondition:] + * Let `T` denote `typename range_value<decltype(rng)>::type`, then `regex` has the type `basic_regex<T>` or is implicitly convertible to one of these types. + * `i` has the type `int`. + * the `value_type` of `rndRng` is `int`. + * `flags` has the type `regex_constants::syntax_option_type`. +* [*Returns:] A range whose iterators behave as if they were the original iterators wrapped in `regex_token_iterator`. The first iterator in the range would be constructed by forwarding all the arguments of `tokenized()` to the `regex_token_iterator` constructor. +* [*Throws:] Whatever constructing and copying equivalent `regex_token_iterator`s might throw. +* [*Range Category:] __random_access_range__ +* [*Range Return Type:] `boost::tokenized_range<typeof(rng)>` +* [*Returned Range Category:] __random_access_range__ + +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/transformed.qbk b/libs/range/doc/reference/adaptors/transformed.qbk new file mode 100644 index 0000000000..ec19583ee2 --- /dev/null +++ b/libs/range/doc/reference/adaptors/transformed.qbk @@ -0,0 +1,59 @@ +[/ + 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:transformed transformed] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::transformed(fun)`]] + [[Function] [`boost::adaptors::transform(rng, fun)`]] +] + +* [*Precondition:] The `value_type` of the range is convertible to the argument type of `fun`. +* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `fun(y)` where `y` is the corresponding element in the original range. +* [*Throws:] Whatever the copy-constructor of `fun` might throw. +* [*Range Category:] __single_pass_range__ +* [*Range Return Type:] `boost::transformed_range<typeof(rng)>` +* [*Returned Range Category:] The range category of `rng`. + +[section:transformed_example transformed example] +`` +#include <boost/range/adaptor/transformed.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +struct double_int +{ + typedef int result_type; + int operator()(int x) const { return x * 2; } +}; + +int main(int argc, const char* argv[]) +{ + using namespace boost::adaptors; + using namespace boost::assign; + + std::vector<int> input; + input += 1,2,3,4,5,6,7,8,9,10; + + boost::copy( + input | transformed(double_int()), + std::ostream_iterator<int>(std::cout, ",")); + + return 0; +} +`` +[endsect] + +This would produce the output: +`` +2,4,6,8,10,12,14,16,18,20 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/type_erased.qbk b/libs/range/doc/reference/adaptors/type_erased.qbk new file mode 100644 index 0000000000..a24bee7cd4 --- /dev/null +++ b/libs/range/doc/reference/adaptors/type_erased.qbk @@ -0,0 +1,151 @@ +[/ + 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:type_erased type_erased] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::type_erased<Value, Traversal, Reference, Difference, Buffer>()`]] + [[Function] [`boost::adaptors::type_erase(rng, boost::adaptors::type_erased<Value, Traversal, Reference, Difference, Buffer>)`]] +] + +Please note that it is frequently unnecessary to use the `type_erased` adaptor. It is often better to use the implicit conversion to `any_range`. + +Let `Rng` be the type of `rng`. + +* [*Template parameters:] + * `Value` is the `value_type` for the `any_range`. If this is set to boost::use_default, `Value` will be calculated from the + range type when the adaptor is applied. + * `Traversal` is the tag used to identify the traversal of the resultant range. Frequently it is desireable to set a traversal category lower than the source container or range to maximize the number of ranges that can convert to the `any_range`. If this is left as boost::use_default then `Traversal` will be `typename boost::iterator_traversal<boost::range_iterator<Rng>::type>::type` + * `Reference` is the `reference` for the `any_range`. `boost::use_default` will equate to `typename range_reference<Rng>::type`. + * `Difference` is the `difference_type` for the any_range. `boost::use_default` will equate to `typename boost::range_difference<Rng>::type` + * `Buffer` is the storage used to allocate the underlying iterator wrappers. This can typically be ignored, but is available as a template parameter for customization. Buffer must be a model of the `AnyIteratorBufferConcept`. +* [*Precondition:] `Traversal` is one of `{ boost::use_default, boost::single_pass_traversal_tag, boost::forward_traversal_tag, boost::bidirectional_traversal_tag, boost::random_access_traversal_tag }` +* [*Returns:] The returned value is the same as `typename any_range_type_generator< Rng, Value, Traversal, Reference, Difference, Buffer >` that represents `rng` in a type-erased manner. +* [*Range Category:] __single_pass_range__ +* [*Returned Range Category:] if `Traversal` was specified as `boost::use_default` then `typename boost::iterator_traversal<boost::range_iterator<Rng>::type>::type`, otherwise `Traversal`. + +[heading AnyIteratorBufferConcept] +`` +class AnyIteratorBufferConcept +{ +public: + AnyIteratorBufferConcept(); + ~AnyIteratorBufferConcept(); + + // bytes is the requested size to allocate. This function + // must return a pointer to an adequate area of memory. + // throws: bad_alloc + // + // The buffer will only ever have zero or one + // outstanding memory allocations. + void* allocate(std::size_t bytes); + + // deallocate this buffer + void deallocate(); +}; +`` + +[section:type_erased_example type-erased example] +`` +#include <boost/range/adaptor/type_erased.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <boost/foreach.hpp> +#include <algorithm> +#include <iostream> +#include <list> +#include <vector> + +// The client interface from an OO perspective merely requires a sequence +// of integers that can be forward traversed +typedef boost::any_range< + int + , boost::forward_traversal_tag + , int + , std::ptrdiff_t +> integer_range; + +namespace server +{ + void display_integers(const integer_range& rng) + { + boost::copy(rng, + std::ostream_iterator<int>(std::cout, ",")); + + std::cout << std::endl; + } +} + +namespace client +{ + void run() + { + using namespace boost::assign; + using namespace boost::adaptors; + + // Under most conditions one would simply use an appropriate + // any_range as a function parameter. The type_erased adaptor + // is often superfluous. However because the type_erased + // adaptor is applied to a range, we can use default template + // arguments that are generated in conjunction with the + // range type to which we are applying the adaptor. + + std::vector<int> input; + input += 1,2,3,4,5; + + // Note that this call is to a non-template function + server::display_integers(input); + + std::list<int> input2; + input2 += 6,7,8,9,10; + + // Note that this call is to the same non-tempate function + server::display_integers(input2); + + input2.clear(); + input2 += 11,12,13,14,15; + + // Calling using the adaptor looks like this: + // Notice that here I have a type_erased that would be a + // bidirectional_traversal_tag, but this is convertible + // to the forward_traversal_tag equivalent hence this + // works. + server::display_integers(input2 | type_erased<>()); + + // However we may simply wish to define an adaptor that + // takes a range and makes it into an appropriate + // forward_traversal any_range... + typedef boost::adaptors::type_erased< + boost::use_default + , boost::forward_traversal_tag + > type_erased_forward; + + // This adaptor can turn other containers with different + // value_types and reference_types into the appropriate + // any_range. + + server::display_integers(input2 | type_erased_forward()); + } +} + +int main(int argc, const char* argv[]) +{ + client::run(); + return 0; +} +`` +[endsect] + +This would produce the output: +`` +1,2,3,4,5 +6,7,8,9,10 +11,12,13,14,15 +11,12,13,14,15 +`` +[endsect] + + diff --git a/libs/range/doc/reference/adaptors/uniqued.qbk b/libs/range/doc/reference/adaptors/uniqued.qbk new file mode 100644 index 0000000000..a74d1a898b --- /dev/null +++ b/libs/range/doc/reference/adaptors/uniqued.qbk @@ -0,0 +1,50 @@ +[/ + 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:uniqued uniqued] + +[table + [[Syntax] [Code]] + [[Pipe] [`rng | boost::adaptors::uniqued`]] + [[Function] [`boost::adaptors::unique(rng)`]] +] + +* [*Precondition:] The `value_type` of the range is comparable with `operator==()`. +* [*Postcondition:] For all adjacent elements `[x,y]` in the returned range, `x==y` is false. +* [*Range Category:] __forward_range__ +* [*Range Return Type:] `boost::uniqued_range<typeof(rng)>` +* [*Returned Range Category:] The minimum of the range concept of `rng` and __forward_range__. + +[section:uniqued_example uniqued example] +`` +#include <boost/range/adaptor/uniqued.hpp> +#include <boost/range/algorithm/copy.hpp> +#include <boost/assign.hpp> +#include <algorithm> +#include <iostream> +#include <vector> + +void uniqued_example_test() +{ + using namespace boost::assign; + using namespace boost::adaptors; + + std::vector<int> input; + input += 1,1,2,2,2,3,4,5,6; + + boost::copy( + input | uniqued, + std::ostream_iterator<int>(std::cout, ",")); +} +`` +[endsect] + +This would produce the output: +`` +1,2,3,4,5,6 +`` +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/adjacent_find.qbk b/libs/range/doc/reference/algorithm/adjacent_find.qbk new file mode 100644 index 0000000000..67d78d48f9 --- /dev/null +++ b/libs/range/doc/reference/algorithm/adjacent_find.qbk @@ -0,0 +1,85 @@ +[/ + 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:adjacent_find adjacent_find] + +[heading Prototype] + +`` +template<class ForwardRange> +typename range_iterator<ForwardRange>::type +adjacent_find(ForwardRange& rng); + +template<class ForwardRange> +typename range_iterator<const ForwardRange>::type +adjacent_find(const ForwardRange& rng); + +template<class ForwardRange, class BinaryPredicate> +typename range_iterator<ForwardRange>::type +adjacent_find(ForwardRange& rng, BinaryPred pred); + +template<class ForwardRange, class BinaryPredicate> +typename range_iterator<const ForwardRange>::type +adjacent_find(const ForwardRange& rng, BinaryPred pred); + +template<range_return_value_re, class ForwardRange> +typename range_return<ForwardRange, re>::type +adjacent_find(ForwardRange& rng); + +template<range_return_value_re, class ForwardRange> +typename range_return<const ForwardRange, re>::type +adjacent_find(const ForwardRange& rng); + +template< + range_return_value re, + class ForwardRange, + class BinaryPredicate + > +typename range_return<ForwardRange, re>::type +adjacent_find(ForwardRange& rng, BinaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class BinaryPredicate + > +typename range_return<const ForwardRange, re>::type +adjacent_find(const ForwardRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +[*Non-predicate versions:] + +`adjacent_find` finds the first adjacent elements `[x,y]` in `rng` where `x == y` + +[*Predicate versions:] + +`adjacent_find` finds the first adjacent elements `[x,y]` in `rng` where `pred(x,y)` is `true`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/adjacent_find.hpp` + +[heading Requirements] + +[*For the non-predicate versions of adjacent_find:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange`'s value type is a model of the `EqualityComparableConcept`. + +[*For the predicate versions of adjacent_find:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange`'s value type is convertible to `BinaryPredicate`'s first argument type and to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +Linear. If `empty(rng)` then no comparisons are performed; otherwise, at most `distance(rng) - 1` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/binary_search.qbk b/libs/range/doc/reference/algorithm/binary_search.qbk new file mode 100644 index 0000000000..42031b33b9 --- /dev/null +++ b/libs/range/doc/reference/algorithm/binary_search.qbk @@ -0,0 +1,60 @@ +[/ + 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:binary_search binary_search] + +[heading Prototype] + +`` +template<class ForwardRange, class Value> +bool binary_search(const ForwardRange& rng, const Value& val); + +template<class ForwardRange, class Value, class BinaryPredicate> +bool binary_search(const ForwardRange& rng, const Value& val, BinaryPredicate pred); +`` + +[heading Description] + +`binary_search` returns `true` if and only if the value `val` exists in the range `rng`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/binary_search.hpp` + +[heading Requirements] + +[*For the non-predicate versions of binary_search:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `Value` is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `Value` is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* `ForwardRange`'s value type is the same type as `Value`. + +[*For the predicate versions of binary_search:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `ForwardRange`'s value type is the same type as `Value`. +* `ForwardRange`'s value type is convertible to `BinaryPredicate`'s argument type. + +[heading Precondition:] + +[*For the non-predicate version:] + +`rng` is ordered in ascending order according to `operator<`. + +[*For the predicate version:] + +`rng` is ordered in ascending order according to the function object `pred`. + +[heading Complexity] + +For non-random-access ranges, the complexity is `O(N)` where `N` is `distance(rng)`. + +For random-access ranges, the complexity is `O(log N)` where `N` is `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/copy.qbk b/libs/range/doc/reference/algorithm/copy.qbk new file mode 100644 index 0000000000..e40f1b1375 --- /dev/null +++ b/libs/range/doc/reference/algorithm/copy.qbk @@ -0,0 +1,41 @@ +[/ + 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:copy copy] + +[heading Prototype] + +`` +template<class SinglePassRange, class OutputIterator> +OutputIterator copy(const SinglePassRange& source_rng, OutputIterator out_it); +`` + +[heading Description] + +`copy` copies all elements from `source_rng` to the range `[out_it, out_it + distance(source_rng))`. +The return value is `out_it + distance(source_rng)` + +[heading Definition] + +Defined in the header file `boost/range/algorithm/copy.hpp` + +[heading Requirements] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* The `value_type` of __single_pass_range__ Concept is convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +* `out_it` is not an iterator within the `source_rng`. +* `[out_it, out_it + distance(source_rng))` is a valid range. + +[heading Complexity] + +Linear. Exactly `distance(source_rng)` assignments are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/copy_backward.qbk b/libs/range/doc/reference/algorithm/copy_backward.qbk new file mode 100644 index 0000000000..8fdac5a861 --- /dev/null +++ b/libs/range/doc/reference/algorithm/copy_backward.qbk @@ -0,0 +1,46 @@ +[/ + 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:copy_backward copy_backward] + +[heading Prototype] + +`` +template<class BidirectionalRange, class BidirectionalOutputIterator> + BidirectionalOutputIterator + copy_backward(const BidirectionalRange& source_rng, + BidirectionalOutputIterator out_it); +`` + +[heading Description] + +`copy_backward` copies all elements from `source_rng` to the range `[out_it - distance(source_rng), out_it)`. + +The values are copied in reverse order. The return value is `out_it - distance(source_rng)`. + +Note well that unlike all other standard algorithms `out_it` denotes the *end* of the output sequence. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/copy_backward.hpp` + +[heading Requirements] + +* `BidirectionalRange` is a model of __bidirectional_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* The `value_type` of __bidirectional_range__ Concept is convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +* `out_it` is not an iterator within the `source_rng`. +* `[out_it, out_it + distance(source_rng))` is a valid range. + +[heading Complexity] + +Linear. Exactly `distance(source_rng)` assignments are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/count.qbk b/libs/range/doc/reference/algorithm/count.qbk new file mode 100644 index 0000000000..a84af3c4aa --- /dev/null +++ b/libs/range/doc/reference/algorithm/count.qbk @@ -0,0 +1,41 @@ +[/ + 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:count count] + +[heading Prototype] + +`` +template<class SinglePassRange, class Value> +typename range_difference<SinglePassRange>::type +count(SinglePassRange& rng, const Value& val); + +template<class SinglePassRange, class Value> +typename range_difference<const SinglePassRange>::type +count(const SinglePassRange& rng, const Value& val); +`` + +[heading Description] + +`count` returns the number of elements `x` in `rng` where `x == val` is `true`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/count.hpp` + +[heading Requirements] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `Value` is a model of the `EqualityComparableConcept`. +* `SinglePassRange`'s value type is a model of the `EqualityComparableConcept`. +* An object of `SinglePassRange`'s value type can be compared for equality with an object of type `Value`. + +[heading Complexity] + +Linear. Exactly `distance(rng)` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/count_if.qbk b/libs/range/doc/reference/algorithm/count_if.qbk new file mode 100644 index 0000000000..b95cc91967 --- /dev/null +++ b/libs/range/doc/reference/algorithm/count_if.qbk @@ -0,0 +1,37 @@ +[/ + 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:count_if count_if] + +[heading Prototype] + +`` +template<class SinglePassRange, class UnaryPredicate> +typename range_difference<const SinglePassRange>::type +count_if(const SinglePassRange& rng, UnaryPredicate pred); +`` + +[heading Description] + +`count_if` returns the number of elements `x` in `rng` where `pred(x)` is `true`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/count_if.hpp` + +[heading Requirements] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `UnaryPredicate` is a model of the `UnaryPredicateConcept`. +* `SinglePassRange`'s value type is a model of the `EqualityComparableConcept`. +* The value type of `SinglePassRange` is convertible to the argument type of `UnaryPredicate`. + +[heading Complexity] + +Linear. Exactly `distance(rng)` invocations of `pred`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/equal.qbk b/libs/range/doc/reference/algorithm/equal.qbk new file mode 100644 index 0000000000..37d1c02fa8 --- /dev/null +++ b/libs/range/doc/reference/algorithm/equal.qbk @@ -0,0 +1,64 @@ +[/ + 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:equal equal] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2 +> +bool equal(const SinglePassRange1& rng1, + const SinglePassRange2& rng2); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate +> +bool equal(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + BinaryPredicate pred); +`` + +[heading Description] + +`equal` returns `true` if `distance(rng1)` is equal to the `distance(rng2)` and for each element `x` in `rng1`, the corresponding element `y` in `rng2` is equal. Otherwise `false` is returned. + +In this range version of `equal` it is perfectly acceptable to pass in two ranges of unequal lengths. + +Elements are considered equal in the non-predicate version if `operator==` returns `true`. Elements are considered equal in the predicate version if `pred(x,y)` is `true`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/equal.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `SinglePassRange1`'s value type is a model of the `EqualityComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `EqualityComparableConcept`. +* `SinglePassRange1`'s value type can be compared for equality with `SinglePassRange2`'s value type. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +Linear. At most `min(distance(rng1), distance(rng2))` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/equal_range.qbk b/libs/range/doc/reference/algorithm/equal_range.qbk new file mode 100644 index 0000000000..2d6c342df8 --- /dev/null +++ b/libs/range/doc/reference/algorithm/equal_range.qbk @@ -0,0 +1,83 @@ +[/ + 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:equal_range equal_range] + +[heading Prototype] + +`` +template< + class ForwardRange, + class Value + > +std::pair<typename range_iterator<ForwardRange>::type, + typename range_iterator<ForwardRange>::type> +equal_range(ForwardRange& rng, const Value& val); + +template< + class ForwardRange, + class Value + > +std::pair<typename range_iterator<const ForwardRange>::type, + typename range_iterator<const ForwardRange>::type> +equal_range(const ForwardRange& rng, const Value& val); + +template< + class ForwardRange, + class Value, + class SortPredicate + > +std::pair<typename range_iterator<ForwardRange>::type, + typename range_iterator<ForwardRange>::type> +equal_range(ForwardRange& rng, const Value& val, SortPredicate pred); + +template< + class ForwardRange, + class Value, + class SortPredicate + > +std::pair<typename range_iterator<const ForwardRange>::type, + typename range_iterator<const ForwardRange>::type> +equal_range(const ForwardRange& rng, const Value& val, SortPredicate pred); + `` + +[heading Description] + +`equal_range` returns a range in the form of a pair of iterators where all of the elements are equal to `val`. If no values are found that are equal to `val`, then an empty range is returned, hence `result.first == result.second`. For the non-predicate versions of `equal_range` the equality of elements is determined by `operator<`. +For the predicate versions of `equal_range` the equality of elements is determined by `pred`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/equal_range.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `Value` is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `Value` is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* `ForwardRange`'s value type is the same type as `Value`. + +[*For the predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `SortPredicate` is a model of the `StrictWeakOrderingConcept`. +* `ForwardRange`'s value type is the same as `Value`. +* `ForwardRange`'s value type is convertible to both of `SortPredicate`'s argument types. + +[heading Precondition:] + +For the non-predicate versions: `rng` is ordered in ascending order according to `operator<`. + +For the predicate versions: `rng` is ordered in ascending order according to `pred`. + +[heading Complexity] + +For random-access ranges, the complexity is `O(log N)`, otherwise the complexity is `O(N)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/fill.qbk b/libs/range/doc/reference/algorithm/fill.qbk new file mode 100644 index 0000000000..4df2c0f4c2 --- /dev/null +++ b/libs/range/doc/reference/algorithm/fill.qbk @@ -0,0 +1,36 @@ +[/ + 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:fill fill] + +[heading Prototype] + +`` +template<class ForwardRange, class Value> +ForwardRange& fill( ForwardRange& rng, const Value& val ); +`` + +[heading Description] + +`fill` assigns the value `val` to every element in the range `rng`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/fill.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is a model of the `AssignableConcept`. +* `Value` is convertible to `ForwardRange`'s value type. + +[heading Complexity] + +Linear. Exactly `distance(rng)` assignments are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/fill_n.qbk b/libs/range/doc/reference/algorithm/fill_n.qbk new file mode 100644 index 0000000000..6458255c71 --- /dev/null +++ b/libs/range/doc/reference/algorithm/fill_n.qbk @@ -0,0 +1,36 @@ +[/ + 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:fill_n fill_n] + +[heading Prototype] + +`` +template<class ForwardRange, class Size, class Value> +ForwardRange& fill( ForwardRange& rng, Size n, const Value& val ); +`` + +[heading Description] + +`fill_n` assigns the value `val` to `n` elements in the range `rng` begining with `boost::begin(rng)`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/fill_n.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is a model of the `AssignableConcept`. +* `Value` is convertible to `ForwardRange`'s value type. + +[heading Complexity] + +Linear. Exactly `n` assignments are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/find.qbk b/libs/range/doc/reference/algorithm/find.qbk new file mode 100644 index 0000000000..ba57637212 --- /dev/null +++ b/libs/range/doc/reference/algorithm/find.qbk @@ -0,0 +1,45 @@ +[/ + 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:find find] + +[heading Prototype] + +`` +template<class SinglePassRange, class Value> +typename range_iterator<SinglePassRange>::type +find(SinglePassRange& rng, Value val); + +template< + range_return_value re, + class SinglePassRange, + class Value + > +typename range_return<SinglePassRange, re>::type +find(SinglePassRange& rng, Value val); +`` + +[heading Description] + +The versions of `find` that return an iterator, returns the first iterator in the range `rng` such that `*i == value`. `end(rng)` is returned if no such iterator exists. +The versions of find that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/find.hpp` + +[heading Requirements] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `Value` is a model of the `EqualityComparableConcept`. +* The `operator==` is defined for type `Value` to be compared with the `SinglePassRange`'s value type. + +[heading Complexity] + +Linear. At most `distance(rng)` comparisons for equality. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/find_end.qbk b/libs/range/doc/reference/algorithm/find_end.qbk new file mode 100644 index 0000000000..dff17cdbee --- /dev/null +++ b/libs/range/doc/reference/algorithm/find_end.qbk @@ -0,0 +1,74 @@ +[/ + 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:find_end find_end] + +[heading Prototype] + +`` +template<class ForwardRange1, class ForwardRange2> +typename range_iterator<ForwardRange1>::type +find_end(ForwardRange1& rng1, const ForwardRange2& rng2); + +template< + class ForwardRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_iterator<ForwardRange1>::type +find_end(ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); + +template< + range_return_value re, + class ForwardRange1, + class ForwardRange2 + > +typename range_return<ForwardRange1, re>::type +find_end(ForwardRange1& rng1, const ForwardRange2& rng2); + +template< + range_return_value re, + class ForwardRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_return<ForwardRange1, re>::type +find_end(ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); +`` + +[heading Description] + +The versions of `find_end` that return an iterator, return an iterator to the beginning of the last sub-sequence equal to `rng2` within `rng1`. +Equality is determined by `operator==` for non-predicate versions of `find_end`, and by satisfying `pred` in the predicate versions. The versions of `find_end` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/find_end.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange1` is a model of the __forward_range__ Concept. +* `ForwardRange2` is a model of the __forward_range__ Concept. +* `ForwardRange1`'s value type is a model of the `EqualityComparableConcept`. +* `ForwardRange2`'s value type is a model of the `EqualityComparableConcept`. +* Objects of `ForwardRange1`'s value type can be compared for equality with objects of `ForwardRange2`'s value type. + +[*For the predicate versions:] + +* `ForwardRange1` is a model of the __forward_range__ Concept. +* `ForwardRange2` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `ForwardRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +The number of comparisons is proportional to `distance(rng1) * distance(rng2)`. If both `ForwardRange1` and `ForwardRange2` are models of `BidirectionalRangeConcept` then the average complexity is linear and the worst case is `distance(rng1) * distance(rng2)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/find_first_of.qbk b/libs/range/doc/reference/algorithm/find_first_of.qbk new file mode 100644 index 0000000000..d10d986f2d --- /dev/null +++ b/libs/range/doc/reference/algorithm/find_first_of.qbk @@ -0,0 +1,74 @@ +[/ + 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:find_first_of find_first_of] + +[heading Prototype] + +`` +template<class SinglePassRange1, class ForwardRange2> +typename range_iterator<SinglePassRange1>::type +find_first_of(SinglePassRange1& rng1, const ForwardRange2& rng2); + +template< + class SinglePassRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_iterator<SinglePassRange1>::type +find_first_of(SinglePassRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); + +template< + range_return_value re, + class SinglePassRange1, + class ForwardRange2 + > +typename range_return<SinglePassRange1, re>::type +find_first_of(SinglePassRange1& rng1, const ForwardRange2& rng2); + +template< + range_return_value re, + class SinglePassRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_return<SinglePassRange1, re>::type +find_first_of(SinglePassRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); +`` + +[heading Description] + +The versions of `find_first_of` that return an iterator, return an iterator to the first occurrence in `rng1` of any of the elements in `rng2`. +Equality is determined by `operator==` for non-predicate versions of `find_first_of`, and by satisfying `pred` in the predicate versions. + +The versions of `find_first_of` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/find_first_of.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `ForwardRange2` is a model of the __forward_range__ Concept. +* `SinglePassRange1`'s value type is a model of the `EqualityComparableConcept`, and can be compared for equality with `ForwardRange2`'s value type. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `ForwardRange2` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `ForwardRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +At most `distance(rng1) * distance(rng2)` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/find_if.qbk b/libs/range/doc/reference/algorithm/find_if.qbk new file mode 100644 index 0000000000..12ff91bcb2 --- /dev/null +++ b/libs/range/doc/reference/algorithm/find_if.qbk @@ -0,0 +1,50 @@ +[/ + 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:find_if find_if] + +[heading Prototype] + +`` +template<class SinglePassRange, class UnaryPredicate> +typename range_iterator<SinglePassRange>::type +find_if(SinglePassRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class SinglePassRange, + class UnaryPredicate + > +typename range_return<SinglePassRange, re>::type +find_if(SinglePassRange& rng, UnaryPredicate pred); +`` + +[heading Description] + +The versions of `find_if` that return an iterator, returns the first iterator in the range `rng` such that `pred(*i)` is `true`. `end(rng)` is returned if no such iterator exists. + +The versions of `find_if` that return a `range_return`, defines found in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/find_if.hpp` + +[heading Requirements] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `UnaryPredicate` is a model of the `PredicateConcept`. +* The value type of `SinglePassRange` is convertible to the argument type of `UnaryPredicate`. + +[heading Precondition:] + +For each iterator `i` in `rng`, `*i` is in the domain of `UnaryPredicate`. + +[heading Complexity] + +Linear. At most `distance(rng)` invocations of `pred`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/for_each.qbk b/libs/range/doc/reference/algorithm/for_each.qbk new file mode 100644 index 0000000000..36613680f7 --- /dev/null +++ b/libs/range/doc/reference/algorithm/for_each.qbk @@ -0,0 +1,45 @@ +[/ + 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:for_each for_each] + +[heading Prototype] + +`` +template< + class SinglePassRange, + class UnaryFunction + > +UnaryFunction for_each(SinglePassRange& rng, UnaryFunction fun); + +template< + class SinglePassRange, + class UnaryFunction + > +UnaryFunction for_each(const SinglePassRange& rng, UnaryFunction fun); +`` + +[heading Description] + +`for_each` traverses forward through `rng` and for each element `x` it invokes `fun(x)`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/for_each.hpp` + +[heading Requirements] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `UnaryFunction` is a model of the `UnaryFunctionConcept`. +* `UnaryFunction` does not apply any non-constant operation through its argument. +* `SinglePassRange`'s value type is convertible to `UnaryFunction`'s argument type. + +[heading Complexity] + +Linear. Exactly `distance(rng)` applications of `UnaryFunction`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/generate.qbk b/libs/range/doc/reference/algorithm/generate.qbk new file mode 100644 index 0000000000..3d196641a4 --- /dev/null +++ b/libs/range/doc/reference/algorithm/generate.qbk @@ -0,0 +1,44 @@ +[/ + 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:generate generate] + +[heading Prototype] + +`` +template<class ForwardRange, class Generator> +ForwardRange& generate( ForwardRange& rng, Generator gen ); + +template<class ForwardRange, class Generator> +const ForwardRange& generate( const ForwardRange& rng, Generator gen ); +`` + +[heading Description] + +`generate` assigns the result of `gen()` to each element in range `rng`. Returns the resultant range. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/generate.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Generator` is a model of the `GeneratorConcept`. +* The `value_type` of `SinglePassRange` is convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +* `out_it` is not an iterator within `rng`. +* `[out_it, out_it + distance(rng))` is a valid range. + +[heading Complexity] + +Linear. Exactly `distance(rng)` assignments are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/includes.qbk b/libs/range/doc/reference/algorithm/includes.qbk new file mode 100644 index 0000000000..5f1ca5f48b --- /dev/null +++ b/libs/range/doc/reference/algorithm/includes.qbk @@ -0,0 +1,69 @@ +[/ + 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:includes includes] + +[heading Prototype] + +`` +template<class SinglePassRange1, class SinglePassRange2> +bool includes(const SinglePassRange1& rng1, const SinglePassRange2& rng2); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate + > +bool includes(const SinglePassRange1& rng1, const SinglePassRange2& rng2, + BinaryPredicate pred); +`` + +[heading Description] + +`includes` returns `true` if and only if, for every element in `rng2`, an equivalent element is also present in `rng1`. +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/set_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `SinglePassRange1`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* The ordering of objects of type `SinglePassRange2`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `pred`. + +[heading Complexity] + +Linear. `O(N)`, where `N` is `distance(rng1) + distance(rng2)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/inplace_merge.qbk b/libs/range/doc/reference/algorithm/inplace_merge.qbk new file mode 100644 index 0000000000..015d9bbafc --- /dev/null +++ b/libs/range/doc/reference/algorithm/inplace_merge.qbk @@ -0,0 +1,77 @@ +[/ + 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:inplace_merge inplace_merge] + +[heading Prototype] + +`` +template<class BidirectionalRange> +BidirectionalRange& +inplace_merge( BidirectionalRange& rng, + typename range_iterator<BidirectionalRange>::type middle ); + +template<class BidirectionalRange> +const BidirectionalRange& +inplace_merge( const BidirectionalRange& rng, + typename range_iterator<const BidirectionalRange>::type middle ); + +template<class BidirectionalRange, class BinaryPredicate> +BidirectionalRange& +inplace_merge( BidirectionalRange& rng, + typename range_iterator<BidirectionalRange>::type middle, + BinaryPredicate pred ); + +template<class BidirectionalRange, class BinaryPredicate> +const BidirectionalRange& +inplace_merge( const BidirectionalRange& rng, + typename range_iterator<const BidirectionalRange>::type middle, + BinaryPredicate pred ); +`` + +[heading Description] + +`inplace_merge` combines two consecutive sorted ranges `[begin(rng), middle)` and `[middle, end(rng))` into a single sorted range `[begin(rng), end(rng))`. That is, it starts with a range `[begin(rng), end(rng))` that consists of two pieces each of which is in ascending order, and rearranges it so that the entire range is in ascending order. `inplace_merge` is stable, meaning both that the relative order of elements within each input range is preserved. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/inplace_merge.hpp` + +[heading Requirements] + +[*For the non-predicate version:] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `range_value<BidirectionalRange>::type` is a model of `LessThanComparableConcept` +* The ordering on objects of `range_type<BidirectionalRange>::type` is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate version:] +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `BidirectionalRange`'s value type is convertible to both `BinaryPredicate`'s argument types. + +[heading Precondition:] + +[heading For the non-predicate version:] + +* `middle` is in the range `rng`. +* `[begin(rng), middle)` is in ascending order. That is for each pair of adjacent elements `[x,y]`, `y < x` is `false`. +* `[middle, end(rng))` is in ascending order. That is for each pair of adjacent elements `[x,y]`, `y < x` is `false`. + +[heading For the predicate version:] + +* `middle` is in the range `rng`. +* `[begin(rng), middle)` is in ascending order. That is for each pair of adjacent elements `[x,y]`, `pred(y,x) == false`. +* `[middle, end(rng))` is in ascending order. That is for each pair of adjacent elements `[x,y]`, `pred(y,x) == false`. + +[heading Complexity] + +Worst case: `O(N log(N))` + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/lexicographical_compare.qbk b/libs/range/doc/reference/algorithm/lexicographical_compare.qbk new file mode 100644 index 0000000000..c8fad4bf30 --- /dev/null +++ b/libs/range/doc/reference/algorithm/lexicographical_compare.qbk @@ -0,0 +1,60 @@ +[/ + 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:lexicographical_compare lexicographical_compare] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2 + > +bool lexicographical_compare(const SinglePassRange1& rng1, + const SinglePassRange2& rng2); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate + > +bool lexicographical_compare(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + BinaryPredicate pred); +`` + +[heading Description] + +`lexicographical_compare` compares element by element `rng1` against `rng2`. If the element from `rng1` is less than the element from `rng2` then `true` is returned. If the end of `rng1` without reaching the end of `rng2` this also causes the return value to be `true`. The return value is `false` in all other circumstances. The elements are compared using `operator<` in the non-predicate versions of `lexicographical_compare` and using `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/lexicographical_compare.hpp` + +[heading Requirements] + +[*For the non-predicate versions of lexicographical_compare:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`. +* Let `x` be an object of `SinglePassRange1`'s value type. Let `y` be an obect of `SinglePassRange2`'s value type. `x < y` must be valid. `y < x` must be valid. + +[*For the predicate versions of lexicographical_compare:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +Linear. At most `2 * min(distance(rng1), distance(rng2))` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/lower_bound.qbk b/libs/range/doc/reference/algorithm/lower_bound.qbk new file mode 100644 index 0000000000..58ed2874d2 --- /dev/null +++ b/libs/range/doc/reference/algorithm/lower_bound.qbk @@ -0,0 +1,73 @@ +[/ + 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:lower_bound lower_bound] + +[heading Prototype] + +`` +template<class ForwardRange, class Value> +typename range_iterator<ForwardRange>::type +lower_bound(ForwardRange& rng, Value val); + +template< + range_return_value re, + class ForwardRange, + class Value + > +typename range_return<ForwardRange, re>::type +lower_bound(ForwardRange& rng, Value val); +`` + +[heading Description] + +The versions of `lower_bound` that return an iterator, returns the first iterator in the range `rng` such that: +without predicate - `*i < value` is `false`, +with predicate - `pred(*i, value)` is `false`. + +`end(rng)` is returned if no such iterator exists. + +The versions of `lower_bound` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/lower_bound.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `Value` is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `Value` is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* `ForwardRange`'s value type is the same type as `Value`. + +[*For the predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `ForwardRange`'s value type is the same type as `Value`. +* `ForwardRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng` is sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng` is sorted in ascending order according to `pred`. + +[heading Complexity] + +For ranges that model the __random_access_range__ concept the complexity is `O(log N)`, where `N` is `distance(rng)`. + +For all other range types the complexity is `O(N)`. + + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/make_heap.qbk b/libs/range/doc/reference/algorithm/make_heap.qbk new file mode 100644 index 0000000000..df47fac226 --- /dev/null +++ b/libs/range/doc/reference/algorithm/make_heap.qbk @@ -0,0 +1,56 @@ +[/ + 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:make_heap make_heap] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& make_heap(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& make_heap(const RandomAccessRange& rng); + +template<class RandomAccessRange, class Compare> +RandomAccessRange& make_heap(RandomAccessRange& rng, Compare pred); + +template<class RandomAccessRange, class Compare> +const RandomAccessRange& make_heap(const RandomAccessRange& rng, Compare pred); +`` + +[heading Description] + +`make_heap` turns `rng` into a heap. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/heap_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `Compare` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `Compare`'s argument types. + +[heading Complexity] + +Linear. At most `3 * distance(rng)` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/max_element.qbk b/libs/range/doc/reference/algorithm/max_element.qbk new file mode 100644 index 0000000000..01101a526e --- /dev/null +++ b/libs/range/doc/reference/algorithm/max_element.qbk @@ -0,0 +1,86 @@ +[/ + 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:max_element max_element] + +[heading Prototype] + +`` +template<class ForwardRange> +typename range_iterator<ForwardRange>::type +max_element(ForwardRange& rng); + +template<class ForwardRange> +typename range_iterator<const ForwardRange>::type +max_element(const ForwardRange& rng); + +template<class ForwardRange, class BinaryPredicate> +typename range_iterator<ForwardRange>::type +max_element(ForwardRange& rng, BinaryPredicate pred); + +template<class ForwardRange, class BinaryPredicate> +typename range_iterator<const ForwardRange>::type +max_element(const ForwardRange& rng, BinaryPredicate pred); + + +template< + range_return_value re, + class ForwardRange + > +typename range_return<ForwardRange, re>::type +max_element(ForwardRange& rng); + +template< + range_return_value_re, + class ForwardRange + > +typename range_return<const ForwardRange, re>::type +max_element(const ForwardRange& rng); + +template< + range_return_value re, + class ForwardRange, + class BinaryPredicate + > +typename range_return<ForwardRange, re>::type +max_element(ForwardRange& rng, BinaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class BinaryPredicate + > +typename range_return<const ForwardRange, re>::type +max_element(const ForwardRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +The versions of `max_element` that return an iterator, return the iterator to the maximum value as determined by using `operator<` if a predicate is not supplied. Otherwise the predicate `pred` is used to determine the maximum value. The versions of `max_element` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/max_element.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange`'s value type is a model of the `LessThanComparableConcept`. + +[*For the predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + +[heading Complexity] + +Linear. Zero comparisons if `empty(rng)`, otherwise `distance(rng) - 1` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/merge.qbk b/libs/range/doc/reference/algorithm/merge.qbk new file mode 100644 index 0000000000..e8383585a9 --- /dev/null +++ b/libs/range/doc/reference/algorithm/merge.qbk @@ -0,0 +1,88 @@ +[/ + 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:merge merge] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator + > +OutputIterator merge(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out); + +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator, + class BinaryPredicate + > +OutputIterator merge(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out, + BinaryPredicate pred); +`` + +[heading Description] + +`merge` combines two sorted ranges `rng1` and `rng2` into a single sorted range by copying elements. `merge` is stable. The return value is `out + distance(rng1) + distance(rng2)`. + +The two versions of `merge` differ by how they compare the elements. + +The non-predicate version uses the `operator<()` for the range value type. The predicate version uses the predicate instead of `operator<()`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/merge.hpp` + +[heading Requirements] + +[*For the non-predicate version:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `range_value<SinglePassRange1>::type` is the same as `range_value<SinglePassRange2>::type`. +* `range_value<SinglePassRange1>::type` is a model of the `LessThanComparableConcept`. +* The ordering on objects of `range_value<SinglePassRange1>::type` is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* `range_value<SinglePassRange1>::type` is convertible to a type in `OutputIterator`'s set of value types. + +[*For the predicate version:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `range_value<SinglePassRange1>::type` is the same as `range_value<SinglePassRange2>::type`. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `SinglePassRange1`'s value type is convertible to both `BinaryPredicate`'s argument types. +* `range_value<SinglePassRange1>::type` is convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +[heading For the non-predicate version:] + +* The elements of `rng1` are in ascending order. That is, for each adjacent element pair `[x,y]` of `rng1`, `y < x == false`. +* The elements of `rng2` are in ascending order. That is, for each adjacent element pair `[x,y]` of `rng2`, `y < x == false`. +* The ranges `rng1` and `[out, out + distance(rng1) + distance(rng2))` do not overlap. +* The ranges `rng2` and `[out, out + distance(rng1) + distance(rng2))` do not overlap. +* `[out, out + distance(rng1) + distance(rng2))` is a valid range. + +[heading For the predicate version:] + +* The elements of `rng1` are in ascending order. That is, for each adjacent element pair `[x,y]`, of `rng1`, `pred(y, x) == false`. +* The elements of `rng2` are in ascending order. That is, for each adjacent element pair `[x,y]`, of `rng2`, `pred(y, x) == false`. +* The ranges `rng1` and `[out, out + distance(rng1) + distance(rng2))` do not overlap. +* The ranges `rng2` and `[out, out + distance(rng1) + distance(rng2))` do not overlap. +* `[out, out + distance(rng1) + distance(rng2))` is a valid range. + +[heading Complexity] + +Linear. There are no comparisons if both `rng1` and `rng2` are empty, otherwise at most `distance(rng1) + distance(rng2) - 1` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/min_element.qbk b/libs/range/doc/reference/algorithm/min_element.qbk new file mode 100644 index 0000000000..38955328f0 --- /dev/null +++ b/libs/range/doc/reference/algorithm/min_element.qbk @@ -0,0 +1,86 @@ +[/ + 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:min_element min_element] + +[heading Prototype] + +`` +template<class ForwardRange> +typename range_iterator<ForwardRange>::type +min_element(ForwardRange& rng); + +template<class ForwardRange> +typename range_iterator<const ForwardRange>::type +min_element(const ForwardRange& rng); + +template<class ForwardRange, class BinaryPredicate> +typename range_iterator<ForwardRange>::type +min_element(ForwardRange& rng, BinaryPredicate pred); + +template<class ForwardRange, class BinaryPredicate> +typename range_iterator<const ForwardRange>::type +min_element(const ForwardRange& rng, BinaryPredicate pred); + + +template< + range_return_value re, + class ForwardRange + > +typename range_return<ForwardRange, re>::type +min_element(ForwardRange& rng); + +template< + range_return_value_re, + class ForwardRange + > +typename range_return<const ForwardRange, re>::type +min_element(const ForwardRange& rng); + +template< + range_return_value re, + class ForwardRange, + class BinaryPredicate + > +typename range_return<ForwardRange, re>::type +min_element(ForwardRange& rng, BinaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class BinaryPredicate + > +typename range_return<const ForwardRange, re>::type +min_element(const ForwardRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +The versions of `min_element` that return an iterator, return the iterator to the minimum value as determined by using `operator<` if a predicate is not supplied. Otherwise the predicate `pred` is used to determine the minimum value. The versions of `min_element` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/min_element.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange`'s value type is a model of the `LessThanComparableConcept`. + +[*For the predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + +[heading Complexity] + +Linear. Zero comparisons if `empty(rng)`, otherwise `distance(rng) - 1` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/mismatch.qbk b/libs/range/doc/reference/algorithm/mismatch.qbk new file mode 100644 index 0000000000..eb23928d2c --- /dev/null +++ b/libs/range/doc/reference/algorithm/mismatch.qbk @@ -0,0 +1,119 @@ +[/ + 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:mismatch mismatch] + +[heading Prototype] + +`` +template<class SinglePassRange1, class SinglePassRange2> +std::pair< + typename range_iterator<SinglePassRange1>::type, + typename range_iterator<const SinglePassRange2>::type > +mismatch(SinglePassRange1& rng1, const SinglePassRange2& rng2); + +template<class SinglePassRange1, class SinglePassRange2> +std::pair< + typename range_iterator<const SinglePassRange1>::type, + typename range_iterator<const SinglePassRange2>::type > +mismatch(const SinglePassRange1& rng1, const SinglePassRange2& rng2); + +template<class SinglePassRange1, class SinglePassRange2> +std::pair< + typename range_iterator<SinglePassRange1>::type, + typename range_iterator<SinglePassRange2>::type > +mismatch(SinglePassRange1& rng1, SinglePassRange2& rng2); + +template<class SinglePassRange1, class SinglePassRange2> +std::pair< + typename range_iterator<const SinglePassRange1>::type, + typename range_iterator<SinglePassRange2>::type > +mismatch(const SinglePassRange1& rng1, SinglePassRange2& rng2); + + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate + > +std::pair< + typename range_iterator<SinglePassRange1>::type, + typename range_iterator<const SinglePassRange2>::type > +mismatch(SinglePassRange1& rng1, const SinglePassRange2& rng2, + BinaryPredicate pred); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate + > +std::pair< + typename range_iterator<const SinglePassRange1>::type, + typename range_iterator<const SinglePassRange2>::type > +mismatch(const SinglePassRange1& rng1, const SinglePassRange2& rng2, + BinaryPredicate pred); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate + > +std::pair< + typename range_iterator<SinglePassRange1>::type, + typename range_iterator<SinglePassRange2>::type > +mismatch(SinglePassRange1& rng1, SinglePassRange2& rng2, + BinaryPredicate pred); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryPredicate + > +std::pair< + typename range_iterator<const SinglePassRange1>::type, + typename range_iterator<SinglePassRange2>::type > +mismatch(const SinglePassRange1& rng1, SinglePassRange2& rng2, + BinaryPredicate pred); +`` + +[heading Description] + +`mismatch` finds the first position where the correseponding elements from the two ranges `rng1` and `rng2` are not equal. + +Equality is determined by `operator==` for non-predicate versions of `mismatch`, and by satisfying `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/mismatch.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `SinglePassRange1`'s value type is a model of the `EqualityComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `EqualityComparableConcept`. +* `SinglePassRange1`s value type can be compared for equality with `SinglePassRange2`'s value type. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. + +[heading Precondition:] + +`distance(rng2) >= distance(rng1)` + +[heading Complexity] + +Linear. At most `distance(rng1)` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/next_permutation.qbk b/libs/range/doc/reference/algorithm/next_permutation.qbk new file mode 100644 index 0000000000..4a8dc21683 --- /dev/null +++ b/libs/range/doc/reference/algorithm/next_permutation.qbk @@ -0,0 +1,56 @@ +[/ + 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:next_permutation next_permutation] + +[heading Prototype] + +`` +template<class BidirectionalRange> +bool next_permutation(BidirectionalRange& rng); + +template<class BidirectionalRange> +bool next_permutation(const BidirectionalRange& rng); + +template<class BidirectionalRange, class Compare> +bool next_permutation(BidirectionalRange& rng, Compare pred); + +template<class BidirectionalRange, class Compare> +bool next_permutation(const BidirectionalRange& rng, Compare pred); +`` + +[heading Description] + +`next_permutation` transforms the range of elements `rng` into the lexicographically next greater permutation of the elements if such a permutation exists. If one does not exist then the range is transformed into the lexicographically smallest permutation and `false` is returned. `true` is returned when the next greater permutation is successfully generated. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/permutation.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `BidirectionalRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `BidirectionalRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `Compare` is a model of the `StrictWeakOrderingConcept`. +* `BidirectionalRange`'s value type is convertible to both of `Compare`'s argument types. + +[heading Complexity] + +Linear. At most `distance(rng) / 2` swaps. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/nth_element.qbk b/libs/range/doc/reference/algorithm/nth_element.qbk new file mode 100644 index 0000000000..9bd785e958 --- /dev/null +++ b/libs/range/doc/reference/algorithm/nth_element.qbk @@ -0,0 +1,67 @@ +[/ + 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:nth_element nth_element] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& nth_element( + RandomAccessRange& rng, + typename range_iterator<RandomAccessRange>::type nth); + +template<class RandomAccessRange> +const RandomAccessRange& nth_element( + const RandomAccessRange& rng, + typename range_iterator<const RandomAccessRange>::type nth); + +template<class RandomAccessRange> +RandomAccessRange& nth_element( + RandomAccessRange& rng, + typename range_iterator<RandomAccessRange>::type nth, + BinaryPredicate sort_pred); + +template<class RandomAccessRange> +const RandomAccessRange& nth_element( + const RandomAccessRange& rng, + typename range_iterator<const RandomAccessRange>::type nth, + BinaryPredicate sort_pred); +`` + +[heading Description] + +`nth_element` partially orders a range of elements. `nth_element` arranges the range `rng` such that the element corresponding with the iterator `nth` is the same as the element that would be in that position if `rng` has been sorted. + + +[heading Definition] + +Defined in the header file `boost/range/algorithm/nth_element.hpp` + +[heading Requirements] + +[*For the non-predicate version:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering relation on `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + + +[*For the predicate version:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + + +[heading Complexity] + +On average, linear in `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/partial_sort.qbk b/libs/range/doc/reference/algorithm/partial_sort.qbk new file mode 100644 index 0000000000..e2b8876602 --- /dev/null +++ b/libs/range/doc/reference/algorithm/partial_sort.qbk @@ -0,0 +1,69 @@ +[/ + 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:partial_sort partial_sort] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& partial_sort( + RandomAccessRange& rng, + typename range_iterator<RandomAccessRange>::type middle); + +template<class RandomAccessRange> +const RandomAccessRange& partial_sort( + const RandomAccessRange& rng, + typename range_iterator<const RandomAccessRange>::type middle); + +template<class RandomAccessRange> +RandomAccessRange& partial_sort( + RandomAccessRange& rng, + typename range_iterator<RandomAccessRange>::type middle, + BinaryPredicate sort_pred); + +template<class RandomAccessRange> +const RandomAccessRange& partial_sort( + const RandomAccessRange& rng, + typename range_iterator<const RandomAccessRange>::type middle, + BinaryPredicate sort_pred); +`` + +[heading Description] + +`partial_sort` rearranges the elements in `rng`. It places the smallest `distance(begin(rng), middle)` elements, sorted in ascending order, into the range `[begin(rng), middle)`. The remaining elements are placed in an unspecified order into `[middle, last)`. + +The non-predicative versions of this function specify that one element is less than another by using `operator<()`. The predicate versions use the predicate instead. + + +[heading Definition] + +Defined in the header file `boost/range/algorithm/partial_sort.hpp` + +[heading Requirements] + +[*For the non-predicate version:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering relation on `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + + +[*For the predicate version:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + + +[heading Complexity] + +Approximately `distance(rng) * log(distance(begin(rng), middle))` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/partition.qbk b/libs/range/doc/reference/algorithm/partition.qbk new file mode 100644 index 0000000000..8ae28e5780 --- /dev/null +++ b/libs/range/doc/reference/algorithm/partition.qbk @@ -0,0 +1,63 @@ +[/ + 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:partition partition] + +[heading Prototype] + +`` +template< + class ForwardRange, + class UnaryPredicate + > +typename range_iterator<ForwardRange>::type +partition(ForwardRange& rng, UnaryPredicate pred); + +template< + class ForwardRange, + class UnaryPredicate + > +typename range_iterator<const ForwardRange>::type +partition(const ForwardRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class UnaryPredicate + > +typename range_return<ForwardRange, re>::type +partition(ForwardRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class UnaryPredicate + > +typename range_return<const ForwardRange, re>::type +partition(const ForwardRange& rng, UnaryPredicate pred); +`` + +[heading Description] + +`partition` orders the elements in `rng` based on `pred`, such that the elements that satisfy `pred` precede the elements that do not. In the versions that return a single iterator, the return value is the middle iterator. In the versions that have a configurable range_return, `found` corresponds to the middle iterator. + + +[heading Definition] + +Defined in the header file `boost/range/algorithm/partition.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `UnaryPredicate` is a model of the `PredicateConcept`. +* `ForwardRange`'s value type is convertible to `UnaryPredicate`'s argument type. + +[heading Complexity] + +Linear. Exactly `distance(rng)` applications of `pred`, and at most `distance(rng) / 2` swaps. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/pop_heap.qbk b/libs/range/doc/reference/algorithm/pop_heap.qbk new file mode 100644 index 0000000000..6950704c89 --- /dev/null +++ b/libs/range/doc/reference/algorithm/pop_heap.qbk @@ -0,0 +1,61 @@ +[/ + 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:pop_heap pop_heap] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& pop_heap(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& pop_heap(const RandomAccessRange& rng); + +template<class RandomAccessRange, class Compare> +RandomAccessRange& pop_heap(RandomAccessRange& rng, Compare pred); + +template<class RandomAccessRange, class Compare> +const RandomAccessRange& pop_heap(const RandomAccessRange& rng, Compare pred); +`` + +[heading Description] + +`pop_heap` removes the largest element from the heap. It is assumed that `begin(rng), prior(end(rng))` is already a heap and that the element to be added is `*prior(end(rng))`. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/heap_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `Compare` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `Compare`'s argument types. + +[heading Precondition:] + +* `!empty(rng)` +* `rng` is a heap. + +[heading Complexity] + +Logarithmic. At most `2 * log(distance(rng))` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/prev_permutation.qbk b/libs/range/doc/reference/algorithm/prev_permutation.qbk new file mode 100644 index 0000000000..6d204317bb --- /dev/null +++ b/libs/range/doc/reference/algorithm/prev_permutation.qbk @@ -0,0 +1,56 @@ +[/ + 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:prev_permutation prev_permutation] + +[heading Prototype] + +`` +template<class BidirectionalRange> +bool prev_permutation(BidirectionalRange& rng); + +template<class BidirectionalRange> +bool prev_permutation(const BidirectionalRange& rng); + +template<class BidirectionalRange, class Compare> +bool prev_permutation(BidirectionalRange& rng, Compare pred); + +template<class BidirectionalRange, class Compare> +bool prev_permutation(const BidirectionalRange& rng, Compare pred); +`` + +[heading Description] + +`prev_permutation` transforms the range of elements `rng` into the lexicographically next smaller permutation of the elements if such a permutation exists. If one does not exist then the range is transformed into the lexicographically largest permutation and `false` is returned. `true` is returned when the next smaller permutation is successfully generated. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/permutation.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `BidirectionalRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `BidirectionalRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `Compare` is a model of the `StrictWeakOrderingConcept`. +* `BidirectionalRange`'s value type is convertible to both of `Compare`'s argument types. + +[heading Complexity] + +Linear. At most `distance(rng) / 2` swaps. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/push_heap.qbk b/libs/range/doc/reference/algorithm/push_heap.qbk new file mode 100644 index 0000000000..8aff8c2f73 --- /dev/null +++ b/libs/range/doc/reference/algorithm/push_heap.qbk @@ -0,0 +1,61 @@ +[/ + 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:push_heap push_heap] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& push_heap(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& push_heap(const RandomAccessRange& rng); + +template<class RandomAccessRange, class Compare> +RandomAccessRange& push_heap(RandomAccessRange& rng, Compare pred); + +template<class RandomAccessRange, class Compare> +const RandomAccessRange& push_heap(const RandomAccessRange& rng, Compare pred); +`` + +[heading Description] + +`push_heap` adds an element to a heap. It is assumed that `begin(rng)`, `prior(end(rng))` is already a heap and that the element to be added is `*prior(end(rng))`. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/heap_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `Compare` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `Compare`'s argument types. + +[heading Precondition:] + +* `!empty(rng)` +* `[begin(rng), prior(end(rng)))` is a heap. + +[heading Complexity] + +Logarithmic. At most `log(distance(rng))` comparisons. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/random_shuffle.qbk b/libs/range/doc/reference/algorithm/random_shuffle.qbk new file mode 100644 index 0000000000..b092c36197 --- /dev/null +++ b/libs/range/doc/reference/algorithm/random_shuffle.qbk @@ -0,0 +1,55 @@ +[/ + 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:random_shuffle random_shuffle] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& random_shuffle(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& random_shuffle(const RandomAccessRange& rng); + +template<class RandomAccessRange, class Generator> +RandomAccessRange& random_shuffle(RandomAccessRange& rng, Generator& gen); + +template<class RandomAccessRange, class Generator> +const RandomAccessRange& random_shuffle(const RandomAccessRange& rng, Generator& gen); +`` + +[heading Description] + +`random_shuffle` randomly rearranges the elements in `rng`. The versions of `random_shuffle` that do not specify a `Generator` use an internal random number generator. The versions of `random_shuffle` that do specify a `Generator` use this instead. Returns the shuffles range. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/random_shuffle.hpp` + +[heading Requirements] + +[*For the version without a Generator:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. + +[*For the version with a Generator:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `Generator` is a model of the `RandomNumberGeneratorConcept`. +* `RandomAccessRange`'s distance type is convertible to `Generator`'s argument type. + +[heading Precondition:] + +* `distance(rng)` is less than `gen`'s maximum value. + + +[heading Complexity] + +Linear. If `!empty(rng)`, exactly `distance(rng) - 1` swaps are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/remove.qbk b/libs/range/doc/reference/algorithm/remove.qbk new file mode 100644 index 0000000000..f26b277c8e --- /dev/null +++ b/libs/range/doc/reference/algorithm/remove.qbk @@ -0,0 +1,60 @@ +[/ + 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:remove remove] +[heading Prototype] + +`` +template< + class ForwardRange, + class Value + > +typename range_iterator<ForwardRange>::type +remove(ForwardRange& rng, const Value& val); + +template< + class ForwardRange, + class Value + > +typename range_iterator<const ForwardRange>::type +remove(const ForwardRange& rng, const Value& val); + +template< + range_return_value re, + class ForwardRange, + class Value + > +typename range_return<ForwardRange,re>::type +remove(ForwardRange& rng, const Value& val); + +template< + range_return_value re, + class ForwardRange, + class Value + > +typename range_return<const ForwardRange,re>::type +remove(const ForwardRange& rng, const Value& val); +`` + +[heading Description] + +`remove` removes from `rng` all of the elements `x` for which `x == val` is `true`. The versions of `remove` that return an iterator, return an iterator `new_last` such that the range `[begin(rng), new_last)` contains no elements equal to `val`. The `range_return` versions of `remove` defines `found` as the new last element. The iterators in the range `[new_last, end(rng))` are dereferenceable, but the elements are unspecified. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/remove.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is a model of the `EqualityComparableConcept`. +* Objects of type `Value` can be compared for equality with objects of `ForwardRange`'s value type. + +[heading Complexity] + +Linear. `remove` performs exactly `distance(rng)` comparisons for equality. + +[endsect]
\ No newline at end of file diff --git a/libs/range/doc/reference/algorithm/remove_copy.qbk b/libs/range/doc/reference/algorithm/remove_copy.qbk new file mode 100644 index 0000000000..b98da4717c --- /dev/null +++ b/libs/range/doc/reference/algorithm/remove_copy.qbk @@ -0,0 +1,39 @@ +[/ + 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:remove_copy remove_copy] + +[heading Prototype] + +`` +template<class ForwardRange, class Outputiterator, class Value> +OutputIterator +remove_copy(ForwardRange& rng, OutputIterator out, const Value& val); + +template<class ForwardRange, class OutputIterator, class Value> +OutputIterator +remove_copy(const ForwardRange& rng, OutputIterator out, const Value& val); +`` + +[heading Description] + +`remove_copy` copied all of the elements `x` from `rng` for which `x == val` is `false`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/remove_copy.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is a model of the `EqualityComparableConcept`. +* Objects of type `Value` can be compared for equality with objects of `ForwardRange`'s value type. + +[heading Complexity] + +Linear. `remove_copy` performs exactly `distance(rng)` comparisons for equality. + +[endsect] diff --git a/libs/range/doc/reference/algorithm/remove_copy_if.qbk b/libs/range/doc/reference/algorithm/remove_copy_if.qbk new file mode 100644 index 0000000000..d56647bc36 --- /dev/null +++ b/libs/range/doc/reference/algorithm/remove_copy_if.qbk @@ -0,0 +1,38 @@ +[/ + 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:remove_copy_if remove_copy_if] + +[heading Prototype] + +`` +template<class ForwardRange, class Outputiterator, class UnaryPred> +OutputIterator +remove_copy_if(ForwardRange& rng, OutputIterator out, UnaryPred pred); + +template<class ForwardRange, class OutputIterator, class UnaryPred> +OutputIterator +remove_copy_if(const ForwardRange& rng, OutputIterator out, UnaryPred pred); +`` + +[heading Description] + +`remove_copy_if` copied all of the elements `x` from `rng` for which `pred(x)` is `false`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/remove_copy_if.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `UnaryPred` is a model of the `UnaryPredicateConcept`. + +[heading Complexity] + +Linear. `remove_copy_if` performs exactly `distance(rng)` comparisons with UnaryPred. + +[endsect] diff --git a/libs/range/doc/reference/algorithm/remove_if.qbk b/libs/range/doc/reference/algorithm/remove_if.qbk new file mode 100644 index 0000000000..64b6ac3c4c --- /dev/null +++ b/libs/range/doc/reference/algorithm/remove_if.qbk @@ -0,0 +1,63 @@ +[/ + 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:remove_if remove_if] + +[heading Prototype] + +`` +template< + class ForwardRange, + class UnaryPredicate + > +typename range_iterator<ForwardRange>::type +remove(ForwardRange& rng, UnaryPredicate pred); + +template< + class ForwardRange, + class UnaryPredicate + > +typename range_iterator<const ForwardRange>::type +remove(const ForwardRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class UnaryPredicate + > +typename range_return<ForwardRange,re>::type +remove(ForwardRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class UnaryPredicate + > +typename range_return<const ForwardRange,re>::type +remove(const ForwardRange& rng, UnaryPredicate pred); +`` + +[heading Description] + +`remove_if` removes from `rng` all of the elements `x` for which `pred(x)` is `true`. The versions of `remove_if` that return an iterator, return an iterator `new_last` such that the range `[begin(rng), new_last)` contains no elements where `pred(x)` is `true`. The iterators in the range `[new_last, end(rng))` are dereferenceable, but the elements are unspecified. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/remove_if.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `UnaryPredicate` is a model of the `PredicateConcept`. +* `ForwardRange`'s value type is convertible to `UnaryPredicate`'s argument type. + +[heading Complexity] + +Linear. `remove_if` performs exactly `distance(rng)` applications of `pred`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/replace.qbk b/libs/range/doc/reference/algorithm/replace.qbk new file mode 100644 index 0000000000..27b6c1b790 --- /dev/null +++ b/libs/range/doc/reference/algorithm/replace.qbk @@ -0,0 +1,46 @@ +[/ + 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:replace replace] + +[heading Prototype] + +`` +template< + class ForwardRange, + class Value + > +ForwardRange& replace(ForwardRange& rng, const Value& what, const Value& with_what); + +template< + class ForwardRange, + class UnaryPredicate + > +const ForwardRange& replace(const ForwardRange& rng, const Value& what, const Value& with_what); +`` + +[heading Description] + +`replace` every element in `rng` equal to `what` with `with_what`. Return a reference to `rng`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/replace.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is convertible to `ForwardRange`'s value type. +* `Value` is a model of the `AssignableConcept`. +* `Value` is a model of the `EqualityComparableConcept`, and may be compared for equality with objects of `ForwardRange`'s value type. + +[heading Complexity] + +Linear. `replace` performs exactly `distance(rng)` comparisons for equality and at most `distance(rng)` assignments. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/replace_copy.qbk b/libs/range/doc/reference/algorithm/replace_copy.qbk new file mode 100644 index 0000000000..e936fc035f --- /dev/null +++ b/libs/range/doc/reference/algorithm/replace_copy.qbk @@ -0,0 +1,38 @@ +[/ + 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:replace_copy replace_copy] + +[heading Prototype] + +`` +template<class ForwardRange, class OutputIterator, class Value> +OutputIterator replace_copy(const ForwardRange& rng, OutputIterator out, + const Value& what, const Value& with_what); +`` + +[heading Description] + +`replace_copy` copy every element `x` in `rng` such that the corresponding element in the output range `y` is `x == what ? with_what : x`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/replace_copy.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is convertible to `ForwardRange`'s value type. +* `Value` is a model of the `AssignableConcept`. +* `OutputIterator` is a model of the `OutputIteratorConcept`. + +[heading Complexity] + +Linear. `replace_copy` performs exactly `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/replace_copy_if.qbk b/libs/range/doc/reference/algorithm/replace_copy_if.qbk new file mode 100644 index 0000000000..13305a770b --- /dev/null +++ b/libs/range/doc/reference/algorithm/replace_copy_if.qbk @@ -0,0 +1,39 @@ +[/ + 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:replace_copy_if replace_copy_if] + +[heading Prototype] + +`` +template<class ForwardRange, class OutputIterator, class UnaryPredicate, class Value> +OutputIterator replace_copy_if(const ForwardRange& rng, OutputIterator out, + UnaryPredicate pred, const Value& with_what); +`` + +[heading Description] + +`replace_copy_if` copy every element `x` in `rng` such that the corresponding element in the output range `y` is `pred(x) ? with_what : x`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/replace_copy_if.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `Value` is convertible to `ForwardRange`'s value type. +* `Value` is a model of the `AssignableConcept`. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `UnaryPredicate` is a model of the `UnaryPredicateConcept`. + +[heading Complexity] + +Linear. `replace_copy_if` performs exactly `distance(rng)` evaluations of `pred`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/replace_if.qbk b/libs/range/doc/reference/algorithm/replace_if.qbk new file mode 100644 index 0000000000..18480a97f1 --- /dev/null +++ b/libs/range/doc/reference/algorithm/replace_if.qbk @@ -0,0 +1,41 @@ +[/ + 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:replace_if replace_if] + +[heading Prototype] + +`` +template<class ForwardRange, class UnaryPredicate, class Value> +ForwardRange& replace_if(ForwardRange& rng, UnaryPredicate pred, const Value& with_what); + +template<class ForwardRange, class UnaryPredicate, class Value> +const ForwardRange& replace_if(const ForwardRange& rng, UnaryPredicate pred, const Value& with_what); +`` + +[heading Description] + +`replace_if` replaces every element `x` in `rng` for which `pred(x) == true` with `with_what`. Returns a reference to `rng`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/replace_if.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `UnaryPredicate` is a model of the `PredicateConcept` +* `ForwardRange`'s value type is convertible to `UnaryPredicate`'s argument type. +* `Value` is convertible to `ForwardRange`'s value type. +* `Value` is a model of the `AssignableConcept`. + +[heading Complexity] + +Linear. `replace_if` performs exactly `distance(rng)` applications of `pred`, and at most `distance(rng)` assignments. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/reverse.qbk b/libs/range/doc/reference/algorithm/reverse.qbk new file mode 100644 index 0000000000..6ecb31b594 --- /dev/null +++ b/libs/range/doc/reference/algorithm/reverse.qbk @@ -0,0 +1,37 @@ +[/ + 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:reverse reverse] + +[heading Prototype] + +`` +template<class BidirectionalRange> +BidirectionalRange& reverse(BidirectionalRange& rng); + +template<class BidirectionalRange> +const BidirectionalRange& reverse(const BidirectionalRange& rng); +`` + +[heading Description] + +`reverse` reverses a range. Returns a reference to the reversed range. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/reverse.hpp` + +[heading Requirements] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. + +[heading Complexity] + +Linear. `reverse` makes `distance(rng)/2` calls to `iter_swap`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/reverse_copy.qbk b/libs/range/doc/reference/algorithm/reverse_copy.qbk new file mode 100644 index 0000000000..b19ed9fe05 --- /dev/null +++ b/libs/range/doc/reference/algorithm/reverse_copy.qbk @@ -0,0 +1,36 @@ +[/ + 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:reverse_copy reverse_copy] + +[heading Prototype] + +`` +template<class BidirectionalRange, class OutputIterator> +OutputIterator reverse_copy(const BidirectionalRange& rng, OutputIterator out); +`` + +[heading Description] + +`reverse_copy` copies the elements from `rng` in reverse order to `out`. +Returns the output iterator one passed the last copied element. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/reverse_copy.hpp` + +[heading Requirements] + +* `BidirectionalRange` is a model of the __bidirectional_range__ Concept. +* `BidirectionalRange` is mutable. +* `OutputIterator` is a model of the `OutputIteratorConcept`. + +[heading Complexity] + +Linear. `reverse_copy` makes `distance(rng)` copies. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/rotate.qbk b/libs/range/doc/reference/algorithm/rotate.qbk new file mode 100644 index 0000000000..e28641b2aa --- /dev/null +++ b/libs/range/doc/reference/algorithm/rotate.qbk @@ -0,0 +1,44 @@ +[/ + 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:rotate rotate] + +[heading Prototype] + +`` +template<class ForwardRange> +ForwardRange& rotate(ForwardRange& rng, + typename range_iterator<ForwardRange>::type middle); + +template<class ForwardRange> +const ForwardRange& rotate(const ForwardRange& rng, + typename range_iterator<const ForwardRange>::type middle); +`` + +[heading Description] + +`rotate` rotates the elements in a range. It exchanges the two ranges `[begin(rng), middle)` and `[middle, end(rng))`. Returns a reference to `rng`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/rotate.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. + +[heading Precondition:] + +* `[begin(rng), middle)` is a valid range. +* `[middle, end(rng))` is a valid range. + +[heading Complexity] + +Linear. At most `distance(rng)` swaps are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/rotate_copy.qbk b/libs/range/doc/reference/algorithm/rotate_copy.qbk new file mode 100644 index 0000000000..0f11bdc7d0 --- /dev/null +++ b/libs/range/doc/reference/algorithm/rotate_copy.qbk @@ -0,0 +1,43 @@ +[/ + 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:rotate_copy rotate_copy] + +[heading Prototype] + +`` +template<class ForwardRange, class OutputIterator> +OutputIterator rotate_copy( + const ForwardRange& rng, + typename range_iterator<ForwardRange>::type middle, + OutputIterator out); +`` + +[heading Description] + +`rotate_copy` rotates the elements in a range. It copies the two ranges `[begin(rng), middle)` and `[middle, end(rng))` to `out`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/rotate_copy.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `OutputIterator` is a model of the `OutputIteratorConcept`. + +[heading Precondition:] + +* `[begin(rng), middle)` is a valid range. +* `[middle, end(rng))` is a valid range. + +[heading Complexity] + +Linear. Exactly `distance(rng)` elements are copied. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/search.qbk b/libs/range/doc/reference/algorithm/search.qbk new file mode 100644 index 0000000000..5c2c2a819c --- /dev/null +++ b/libs/range/doc/reference/algorithm/search.qbk @@ -0,0 +1,106 @@ +[/ + 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:search search] + +[heading Prototype] + +`` +template<class ForwardRange1, class ForwardRange2> +typename range_iterator<ForwardRange1>::type +search(ForwardRange1& rng1, const ForwardRange2& rng2); + +template<class ForwardRange1, class ForwardRange2> +typename range_iterator<const ForwardRange1>::type +search(const ForwardRange1& rng1, const ForwardRange2& rng2); + +template< + class ForwardRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_iterator<ForwardRange1>::type, +search(ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); + +template< + class ForwardRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_iterator<const ForwardRange1>::type +search(const ForwardRange1& rng1, ForwardRange2& rng2, BinaryPredicate pred); + + +template< + range_return_value re, + class ForwardRange1, + class ForwardRange2 + > +typename range_return<ForwardRange1, re>::type +search(ForwardRange1& rng1, const ForwardRange2& rng2); + +template< + range_return_value re, + class ForwardRange1, + class ForwardRange2 + > +typename range_return<const ForwardRange1, re>::type +search(const ForwardRange1& rng1, const ForwardRange2& rng2); + +template< + range_return_value re, + class ForwardRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_return<ForwardRange1, re>::type, +search(ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); + +template< + range_return_value re, + class ForwardRange1, + class ForwardRange2, + class BinaryPredicate + > +typename range_return<const ForwardRange1, re>::type +search(const ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); +`` + +[heading Description] + +The versions of `search` that return an iterator, return an iterator to the start of the first subsequence in `rng1` that is equal to the subsequence `rng2`. The `end(rng1)` is returned if no such subsequence exists in `rng1`. +Equality is determined by `operator==` for non-predicate versions of `search`, and by satisfying `pred` in the predicate versions. + +The versions of `search` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/search.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange1` is a model of the __forward_range__ Concept. +* `ForwardRange2` is a model of the __forward_range__ Concept. +* `ForwardRange1`'s value type is a model of the `EqualityComparableConcept`. +* `ForwardRange2`'s value type is a model of the `EqualityComparableConcept`. +* `ForwardRange1`s value type can be compared for equality with `ForwardRange2`'s value type. + +[*For the predicate versions:] + +* `ForwardRange1` is a model of the __forward_range__ Concept. +* `ForwardRange2` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `ForwardRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +Average complexity is Linear. Worst-case complexity is quadratic. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/search_n.qbk b/libs/range/doc/reference/algorithm/search_n.qbk new file mode 100644 index 0000000000..ad8cbd272f --- /dev/null +++ b/libs/range/doc/reference/algorithm/search_n.qbk @@ -0,0 +1,63 @@ +[/ + 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:search_n search_n] + +[heading Prototype] + +`` +template<class ForwardRange, class Integer, class Value> +typename range_iterator<ForwardRange>::type +search_n(ForwardRange& rng, Integer n, const Value& value); + +template<class ForwardRange, class Integer, class Value> +typename range_iterator<const ForwardRange>::type +search_n(const ForwardRange& rng, Integer n, const Value& value); + +template<class ForwardRange, class Integer, class Value, class BinaryPredicate> +typename range_iterator<ForwardRange>::type +search_n(ForwardRange& rng, Integer n, const Value& value, + BinaryPredicate binary_pred); + +template<class ForwardRange, class Integer, class Value, class BinaryPredicate> +typename range_iterator<const ForwardRange>::type +search_n(const ForwardRange& rng, Integer n, const Value& value, + BinaryPredicate binary_pred); +`` + +[heading Description] + +`search_n` searches `rng` for a sequence of length `n` equal to `value` where +equality is determined by operator== in the non-predicate case, and by a +predicate when one is supplied. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/search_n.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange`'s value type is a model of the `EqualityComparableConcept`. +* `ForwardRange`s value type can be compared for equality with `Value`. +* `Integer` is a model of the `IntegerConcept`. + +[*For the predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `Value` is convertible to `BinaryPredicate`'s second argument type. +* `Integer` is a model of the `IntegerConcept`. + +[heading Complexity] + +Average complexity is Linear. Worst-case complexity is quadratic. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/set_difference.qbk b/libs/range/doc/reference/algorithm/set_difference.qbk new file mode 100644 index 0000000000..8ab5091aae --- /dev/null +++ b/libs/range/doc/reference/algorithm/set_difference.qbk @@ -0,0 +1,81 @@ +[/ + 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:set_difference set_difference] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator + > +OutputIterator set_difference(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out); + +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator, + class BinaryPredicate + > +OutputIterator set_difference(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out, + BinaryPredicate pred); +`` + +[heading Description] + +`set_difference` constructs a sorted range that is the set difference of the sorted ranges `rng1` and `rng2`. The return value is the end of the output range. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/set_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `SinglePassRange1`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* The ordering of objects of type `SinglePassRange2`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `pred`. + +[heading Complexity] + +Linear. `O(N)`, where `N` is `distance(rng1) + distance(rng2)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/set_intersection.qbk b/libs/range/doc/reference/algorithm/set_intersection.qbk new file mode 100644 index 0000000000..3d46109e10 --- /dev/null +++ b/libs/range/doc/reference/algorithm/set_intersection.qbk @@ -0,0 +1,81 @@ +[/ + 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:set_intersection set_intersection] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator + > +OutputIterator set_intersection(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out); + +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator, + class BinaryPredicate + > +OutputIterator set_intersection(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out, + BinaryPredicate pred); +`` + +[heading Description] + +`set_intersection` constructs a sorted range that is the intersection of the sorted ranges `rng1` and `rng2`. The return value is the end of the output range. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/set_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `SinglePassRange1`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* The ordering of objects of type `SinglePassRange2`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `pred`. + +[heading Complexity] + +Linear. `O(N)`, where `N` is `distance(rng1) + distance(rng2)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/set_symmetric_difference.qbk b/libs/range/doc/reference/algorithm/set_symmetric_difference.qbk new file mode 100644 index 0000000000..9110cf07a4 --- /dev/null +++ b/libs/range/doc/reference/algorithm/set_symmetric_difference.qbk @@ -0,0 +1,83 @@ +[/ + 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:set_symmetric_difference set_symmetric_difference] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator + > +OutputIterator +set_symmetric_difference(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out); + +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator, + class BinaryPredicate + > +OutputIterator +set_symmetric_difference(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out, + BinaryPredicate pred); +`` + +[heading Description] + +`set_symmetric_difference` constructs a sorted range that is the set symmetric difference of the sorted ranges `rng1` and `rng2`. The return value is the end of the output range. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/set_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `SinglePassRange1`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* The ordering of objects of type `SinglePassRange2`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `pred`. + +[heading Complexity] + +Linear. `O(N)`, where `N` is `distance(rng1) + distance(rng2)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/set_union.qbk b/libs/range/doc/reference/algorithm/set_union.qbk new file mode 100644 index 0000000000..679ec71cfe --- /dev/null +++ b/libs/range/doc/reference/algorithm/set_union.qbk @@ -0,0 +1,80 @@ +[/ + 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:set_union set_union] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator + > +OutputIterator set_union(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out); + +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator, + class BinaryPredicate + > +OutputIterator set_union(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out, + BinaryPredicate pred); + `` + +[heading Description] + +`set_union` constructs a sorted range that is the union of the sorted ranges `rng1` and `rng2`. The return value is the end of the output range. +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/set_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`. +* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `SinglePassRange1`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* The ordering of objects of type `SinglePassRange2`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `SinglePassRange1` and `SinglePassRange2` have the same value type. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `SinglePassRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. +* `SinglePassRange2`'s value type is convertible to `BinaryPredicate`'s second argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng1` and `rng2` are sorted in ascending order according to `pred`. + +[heading Complexity] + +Linear. `O(N)`, where `N` is `distance(rng1) + distance(rng2)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/sort.qbk b/libs/range/doc/reference/algorithm/sort.qbk new file mode 100644 index 0000000000..3027c8913d --- /dev/null +++ b/libs/range/doc/reference/algorithm/sort.qbk @@ -0,0 +1,58 @@ +[/ + 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:sort sort] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& sort(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& sort(const RandomAccessRange& rng); + +template<class RandomAccessRange, class BinaryPredicate> +RandomAccessRange& sort(RandomAccessRange& rng, BinaryPredicate pred); + +template<class RandomAccessRange, class BinaryPredicate> +const RandomAccessRange& sort(const RandomAccessRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +`sort` sorts the elements in `rng` into ascending order. `sort` is not guaranteed to be stable. Returns the sorted range. + +For versions of the `sort` function without a predicate, ascending order is defined by `operator<()` such that for all adjacent elements `[x,y]`, `y < x == false`. + +For versions of the `sort` function with a predicate, ascending order is defined by `pred` such that for all adjacent elements `[x,y]`, `pred(y, x) == false`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/sort.hpp` + +[heading Requirements] + +[*For versions of sort without a predicate:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering relation on `RandomAccessRange`'s value type is a [*strict weak ordering], as defined in the `LessThanComparableConcept` requirements. + +[*For versions of sort with a predicate] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + +[heading Complexity] + +`O(N log(N))` comparisons (both average and worst-case), where `N` is `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/sort_heap.qbk b/libs/range/doc/reference/algorithm/sort_heap.qbk new file mode 100644 index 0000000000..b065ce5302 --- /dev/null +++ b/libs/range/doc/reference/algorithm/sort_heap.qbk @@ -0,0 +1,60 @@ +[/ + 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:sort_heap sort_heap] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& sort_heap(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& sort_heap(const RandomAccessRange& rng); + +template<class RandomAccessRange, class Compare> +RandomAccessRange& sort_heap(RandomAccessRange& rng, Compare pred); + +template<class RandomAccessRange, class Compare> +const RandomAccessRange& sort_heap(const RandomAccessRange& rng, Compare pred); +`` + +[heading Description] + +`sort_heap` turns a heap into a sorted range. + +The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/heap_algorithm.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. + +[*For the predicate versions:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `Compare` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `Compare`'s argument types. + +[heading Precondition:] + +`rng` is a heap. + +[heading Complexity] + +At most `N * log(N)` comparisons, where `N` is `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/stable_partition.qbk b/libs/range/doc/reference/algorithm/stable_partition.qbk new file mode 100644 index 0000000000..a820bcdba2 --- /dev/null +++ b/libs/range/doc/reference/algorithm/stable_partition.qbk @@ -0,0 +1,61 @@ +[/ + 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:stable_partition stable_partition] + +[heading Prototype] + +`` +template<class ForwardRange, class UnaryPredicate> +typename range_iterator<ForwardRange>::type +stable_partition(ForwardRange& rng, UnaryPredicate pred); + +template<class ForwardRange, class UnaryPredicate> +typename range_iterator<const ForwardRange>::type +stable_partition(const ForwardRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class UnaryPredicate +> +typename range_return<ForwardRange, re>::type +stable_partition(ForwardRange& rng, UnaryPredicate pred); + +template< + range_return_value re, + class ForwardRange, + class UnaryPredicate +> +typename range_return<const ForwardRange, re>::type +stable_partition(const ForwardRange& rng, UnaryPredicate pred); +`` + +[heading Description] + +`stable_partition` reorders the elements in the range `rng` base on the function object `pred`. Once this function has completed all of the elements that satisfy `pred` appear before all of the elements that fail to satisfy it. `stable_partition` differs from `partition` because it preserves relative order. It is stable. + +For the versions that return an iterator, the return value is the iterator to the first element that fails to satisfy `pred`. + +For versions that return a `range_return`, the `found` iterator is the iterator to the first element that fails to satisfy `pred`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/stable_partition.hpp` + +[heading Requirements] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `UnaryPredicate` is a model of the `PredicateConcept`. + +[heading Complexity] + +Best case: `O(N)` where `N` is `distance(rng)`. +Worst case: `N * log(N)` swaps, where `N` is `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/stable_sort.qbk b/libs/range/doc/reference/algorithm/stable_sort.qbk new file mode 100644 index 0000000000..502551f58f --- /dev/null +++ b/libs/range/doc/reference/algorithm/stable_sort.qbk @@ -0,0 +1,59 @@ +[/ + 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:stable_sort stable_sort] + +[heading Prototype] + +`` +template<class RandomAccessRange> +RandomAccessRange& stable_sort(RandomAccessRange& rng); + +template<class RandomAccessRange> +const RandomAccessRange& stable_sort(const RandomAccessRange& rng); + +template<class RandomAccessRange, class BinaryPredicate> +RandomAccessRange& stable_sort(RandomAccessRange& rng, BinaryPredicate pred); + +template<class RandomAccessRange, class BinaryPredicate> +const RandomAccessRange& stable_sort(const RandomAccessRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +`stable_sort` sorts the elements in `rng` into ascending order. `stable_sort` is guaranteed to be stable. The order is preserved for equivalent elements. + +For versions of the `stable_sort` function without a predicate ascending order is defined by `operator<()` such that for all adjacent elements `[x,y]`, `y < x == false`. + +For versions of the `stable_sort` function with a predicate, ascending order is designed by `pred` such that for all adjacent elements `[x,y]`, `pred(y,x) == false`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/stable_sort.hpp` + +[heading Requirements] + +[*For versions of stable_sort without a predicate] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. +* The ordering relation on `RandomAccessRange`'s value type is a [*strict weak ordering], as defined in the `LessThanComparableConcept` requirements. + +[*For versions of stable_sort with a predicate:] + +* `RandomAccessRange` is a model of the __random_access_range__ Concept. +* `RandomAccessRange` is mutable. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `RandomAccessRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + +[heading Complexity] + +Best case: `O(N)` where `N` is `distance(rng)`. +Worst case: `O(N log(N)^2)` comparisons, where `N` is `distance(rng)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/swap_ranges.qbk b/libs/range/doc/reference/algorithm/swap_ranges.qbk new file mode 100644 index 0000000000..9dcb764c60 --- /dev/null +++ b/libs/range/doc/reference/algorithm/swap_ranges.qbk @@ -0,0 +1,37 @@ +[/ + 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:swap_ranges swap_ranges] + +[heading Prototype] + +`` +template<class SinglePassRange1, class SinglePassRange2> +SinglePassRange2& swap_ranges(SinglePassRange1& rng1, SinglePassRange& rng2); +`` + +[heading Description] + +`swap_ranges` swaps each element `x` in `rng1` with the corresponding element `y` in `rng2`. +Returns a reference to `rng2`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/swap_ranges.hpp` + +[heading Requirements] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange1` is mutable. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is mutable. + +[heading Complexity] + +Linear. Exactly `distance(rng1)` elements are swapped. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/transform.qbk b/libs/range/doc/reference/algorithm/transform.qbk new file mode 100644 index 0000000000..d1e5ac44cd --- /dev/null +++ b/libs/range/doc/reference/algorithm/transform.qbk @@ -0,0 +1,88 @@ +[/ + 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:transform transform] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class OutputIterator, + class UnaryOperation +> +OutputIterator transform(const SinglePassRange1& rng, + OutputIterator out, + UnaryOperation fun); + +template< + class SinglePassRange1, + class SinglePassRange2, + class OutputIterator, + class BinaryOperation +> +OutputIterator transform(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + OutputIterator out, + BinaryOperation fun); +`` + +[heading Description] + +[*UnaryOperation version:] + +`transform` assigns the value `y` to each element `[out, out + distance(rng)), y = fun(x)` where `x` is the corresponding value to `y` in `rng1`. The return value is `out + distance(rng)`. + +[*BinaryOperation version:] + +`transform` assigns the value `z` to each element `[out, out + min(distance(rng1), distance(rng2))), z = fun(x,y)` where `x` is the corresponding value in `rng1` and `y` is the corresponding value in `rng2`. This version of `transform` stops upon reaching either the end of `rng1`, or the end of `rng2`. Hence there isn't a requirement for `distance(rng1) == distance(rng2)` since there is a safe guaranteed behaviour, unlike with the iterator counterpart in the standard library. + +The return value is `out + min(distance(rng1), distance(rng2))`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/transform.hpp` + +[heading Requirements] + +[*For the unary versions of transform:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `UnaryOperation` is a model of the `UnaryFunctionConcept`. +* `SinglePassRange1`'s value type must be convertible to `UnaryFunction`'s argument type. +* `UnaryFunction`'s result type must be convertible to a type in `OutputIterator`'s set of value types. + +[*For the binary versions of transform:] + +* `SinglePassRange1` is a model of the __single_pass_range__ Concept. +* `SinglePassRange2` is a model of the __single_pass_range__ Concept. +* `OutputIterator` is a model of the `OutputIteratorConcept`. +* `BinaryOperation` is a model of the `BinaryFunctionConcept`. +* `SinglePassRange1`'s value type must be convertible to `BinaryFunction`'s first argument type. +* `SinglePassRange2`'s value type must be convertible to `BinaryFunction`'s second argument type. +* `BinaryOperation`'s result type must be convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +[*For the unary version of transform:] + +* `out` is not an iterator within the range `[begin(rng1) + 1, end(rng1))`. +* `[out, out + distance(rng1))` is a valid range. + +[*For the binary version of transform:] + +* `out` is not an iterator within the range `[begin(rng1) + 1, end(rng1))`. +* `out` is not an iterator within the range `[begin(rng2) + 1, end(rng2))`. +* `[out, out + min(distance(rng1), distance(rng2)))` is a valid range. + + +[heading Complexity] + +Linear. The operation is applied exactly `distance(rng1)` for the unary version and `min(distance(rng1), distance(rng2))` for the binary version. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/unique.qbk b/libs/range/doc/reference/algorithm/unique.qbk new file mode 100644 index 0000000000..bc2cdcea7f --- /dev/null +++ b/libs/range/doc/reference/algorithm/unique.qbk @@ -0,0 +1,77 @@ +[/ + 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:unique unique] + +[heading Prototype] + +`` +template<class ForwardRange> +typename range_return<ForwardRange, return_begin_found>::type +unique(ForwardRange& rng); + +template<class ForwardRange> +typename range_return<const ForwardRange, return_begin_found>::type +unique(const ForwardRange& rng); + +template<class ForwardRange, class BinaryPredicate> +typename range_return<ForwardRange, return_begin_found>::type +unique(ForwardRange& rng, BinaryPredicate pred); + +template<class ForwardRange, class BinaryPredicate> +typename range_return<const ForwardRange, return_begin_found>::type +unique(const ForwardRange& rng, BinaryPredicate pred); + +template<range_return_value re, class ForwardRange> +typename range_return<ForwardRange, re>::type +unique(ForwardRange& rng); + +template<range_return_value re, class ForwardRange> +typename range_return<const ForwardRange, re>::type +unique(const ForwardRange& rng); + +template<range_return_value re, class ForwardRange, class BinaryPredicate> +typename range_return<ForwardRange, re>::type +unique(ForwardRange& rng, BinaryPredicate pred); + +template<range_return_value re, class ForwardRange, class BinaryPredicate> +typename range_return<const ForwardRange, re>::type +unique(const ForwardRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +`unique` removes all but the first element of each sequence of duplicate encountered in `rng`. + +Elements in the range `[new_last, end(rng))` are dereferenceable but undefined. + +Equality is determined by the predicate if one is supplied, or by `operator==()` for `ForwardRange`'s value type. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/unique.hpp` + +[heading Requirements] + +[*For the non-predicate versions of unique:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `ForwardRange`'s value type is a model of the `EqualityComparableConcept`. + +[*For the predicate versions of unique:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `ForwardRange` is mutable. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `ForwardRange`'s value type is convertible to `BinaryPredicate`'s first argument type and to `BinaryPredicate`'s second argument type. + +[heading Complexity] + +Linear. `O(N)` where `N` is `distance(rng)`. Exactly `distance(rng)` comparisons are performed. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm/unique_copy.qbk b/libs/range/doc/reference/algorithm/unique_copy.qbk new file mode 100644 index 0000000000..f10a85fb13 --- /dev/null +++ b/libs/range/doc/reference/algorithm/unique_copy.qbk @@ -0,0 +1,49 @@ +[/ + 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:unique_copy unique_copy] + +[heading Prototype] + +`` +template<class SinglePassRange, class OutputIterator> +OutputIterator unique_copy(const SinglePassRange& rng, OutputIterator out); + +template<class SinglePassRange, class OutputIterator, class BinaryPredicate> +OutputIterator unique_copy(const SinglePassRange& rng, OutputIterator out, BinaryPredicate pred); +`` + +[heading Description] + +`unique_copy` copies the first element of each sequence of duplicates encountered in `rng` to `out`. + +Equality is determined by the predicate if one is supplied, or by `operator==()` for `SinglePassRange`'s value type. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/unique_copy.hpp` + +[heading Requirements] + +[*For the non-predicate versions of unique:] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `SinglePassRange` is mutable. +* `SinglePassRange`'s value type is a model of the `EqualityComparableConcept`. +* `OutputIterator` is a model of the `OutputIteratorConcept`. + +[*For the predicate versions of unique:] + +* `SinglePassRange` is a model of the __single_pass_range__ Concept. +* `SinglePassRange` is mutable. +* `BinaryPredicate` is a model of the `BinaryPredicateConcept`. +* `SinglePassRange`'s value type is convertible to `BinaryPredicate`'s first argument type and to `BinaryPredicate`'s second argument type. +* `OutputIterator` is a model of the `OutputIteratorConcept`. + +[heading Complexity] + +Linear. `O(N)` where `N` is `distance(rng)`. Exactly `distance(rng)` comparisons are performed. + +[endsect] diff --git a/libs/range/doc/reference/algorithm/upper_bound.qbk b/libs/range/doc/reference/algorithm/upper_bound.qbk new file mode 100644 index 0000000000..cb79aee3b2 --- /dev/null +++ b/libs/range/doc/reference/algorithm/upper_bound.qbk @@ -0,0 +1,70 @@ +[/ + 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:upper_bound upper_bound] + +[heading Prototype] + +`` +template<class ForwardRange, class Value> +typename range_iterator<ForwardRange>::type +upper_bound(ForwardRange& rng, Value val); + +template< + range_return_value re, + class ForwardRange, + class Value + > +typename range_return<ForwardRange, re>::type +upper_bound(ForwardRange& rng, Value val); +`` + +[heading Description] + +The versions of `upper_bound` that return an iterator, returns the first iterator in the range `rng` such that: +without predicate - `val < *i` is `true`, +with predicate - `pred(val, *i)` is `true`. + +`end(rng)` is returned if no such iterator exists. + +The versions of `upper_bound` that return a `range_return`, defines `found` in the same manner as the returned iterator described above. + +[heading Definition] + +Defined in the header file `boost/range/algorithm/upper_bound.hpp` + +[heading Requirements] + +[*For the non-predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `Value` is a model of the `LessThanComparableConcept`. +* The ordering of objects of type `Value` is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. +* `ForwardRange`'s value type is the same type as `Value`. + +[*For the predicate versions:] + +* `ForwardRange` is a model of the __forward_range__ Concept. +* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`. +* `ForwardRange`'s value type is the same type as `Value`. +* `ForwardRange`'s value type is convertible to both of `BinaryPredicate`'s argument types. + +[heading Precondition:] + +[*For the non-predicate versions:] + +`rng` is sorted in ascending order according to `operator<`. + +[*For the predicate versions:] + +`rng` is sorted in ascending order according to `pred`. + +[heading Complexity] + +For ranges that model the __random_access_range__ Concept the complexity is `O(log N)`, where `N` is `distance(rng)`. For all other range types the complexity is `O(N)`. + +[endsect] + + diff --git a/libs/range/doc/reference/algorithm_ext/copy_n.qbk b/libs/range/doc/reference/algorithm_ext/copy_n.qbk new file mode 100644 index 0000000000..6b34c7bf0a --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/copy_n.qbk @@ -0,0 +1,37 @@ +[/ + 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:copy_n copy_n] + +[heading Prototype] + +`` +template<class SinglePassRange, class Size, class OutputIterator> +OutputIterator copy_n(const SinglePassRange& rng, Size n, OutputIterator out); +`` + +[heading Description] + +`copy_n` is provided to completely replicate the standard algorithm header, +it is preferable to use Range Adaptors and the extension functions to achieve +the same result with greater safety. + +`copy_n` copies elements from `[boost::begin(rng), boost::begin(rng) + n)` to the range `[out, out + n)` + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/copy_n.hpp` + +[heading Requirements] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `Size` is a model of the `Integer` Concept. +# `OutputIterator` is a model of the `OutputIteratorConcept`. + +[heading Complexity] + +Linear. Exactly `n` elements are copied. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/erase.qbk b/libs/range/doc/reference/algorithm_ext/erase.qbk new file mode 100644 index 0000000000..5b640a28fd --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/erase.qbk @@ -0,0 +1,37 @@ +[/ + 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:erase erase] + +[heading Prototype] + +`` +template<class Container> +Container& erase( + Container& target, + iterator_range<typename Container::iterator> to_erase); +`` + +[heading Description] + +`erase` the iterator range `to_erase` from the container `target`. + +`remove_erase` performs the frequently used combination equivalent to `target.erase(std::remove(target.begin(), target.end(), value), target.end());` + +`remove_erase_if` performs the frequently used combination equivalent to `target.erase(std::remove_if(target.begin(), target.end(), pred), target.end());` + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/erase.hpp` + +[heading Requirements] + +# `Container` supports erase of an iterator range. + +[heading Complexity] + +Linear. Proprotional to `distance(to_erase)`. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/for_each.qbk b/libs/range/doc/reference/algorithm_ext/for_each.qbk new file mode 100644 index 0000000000..fdfcb999f1 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/for_each.qbk @@ -0,0 +1,73 @@ +[/ + 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:for_each for_each] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryFunction + > +BinaryFunction for_each(const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + BinaryFunction fn); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryFunction + > +BinaryFunction for_each(const SinglePassRange1& rng1, + SinglePassRange2& rng2, + BinaryFunction fn); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryFunction + > +BinaryFunction for_each(SinglePassRange1& rng1, + const SinglePassRange2& rng2, + BinaryFunction fn); + +template< + class SinglePassRange1, + class SinglePassRange2, + class BinaryFunction + > +BinaryFunction for_each(SinglePassRange1& rng1, + SinglePassRange2& rng2, + BinaryFunction fn); +`` + +[heading Description] + +`for_each` traverses forward through `rng1` and `rng2` simultaneously. +For each iteration, the element `x` is used from `rng1` and the corresponding +element `y` is used from `rng2` to invoke `fn(x,y)`. + +Iteration is stopped upon reaching the end of the shorter of `rng1`, or `rng2`. +It is safe to call this function with unequal length ranges. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/for_each.hpp` + +[heading Requirements] + +# `SinglePassRange1` is a model of the __single_pass_range__ Concept. +# `SinglePassRange2` is a model of the __single_pass_range__ Concept. +# `BinaryFunction` is a model of the `BinaryFunctionConcept`. +# `SinglePassRange1`'s value type is convertible to `BinaryFunction`'s first argument type. +# `SinglepassRange2`'s value type is convertible to `BinaryFunction`'s second argument type. + +[heading Complexity] + +Linear. Exactly `min(distance(rng1), distance(rng2))` applications of `BinaryFunction`. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/insert.qbk b/libs/range/doc/reference/algorithm_ext/insert.qbk new file mode 100644 index 0000000000..532e25693a --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/insert.qbk @@ -0,0 +1,38 @@ +[/ + 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:insert insert] + +[heading Prototype] + +`` +template< + class Container, + class SinglePassRange + > +Container& insert(Container& target, + typename Container::iterator before, + const SinglePassRange& from); +`` + +[heading Description] + +`insert` all of the elements in the range `from` before the `before` iterator into `target`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/insert.hpp` + +[heading Requirements] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `Container` supports insert at a specified position. +# `SinglePassRange`'s value type is convertible to `Container`'s value type. + +[heading Complexity] + +Linear. `distance(from)` assignments are performed. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/iota.qbk b/libs/range/doc/reference/algorithm_ext/iota.qbk new file mode 100644 index 0000000000..0a5f799636 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/iota.qbk @@ -0,0 +1,33 @@ +[/ + 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:iota iota] + +[heading Prototype] + +`` +template<class ForwardRange, class Value> +ForwardRange& iota(ForwardRange& rng, Value x); +`` + +[heading Description] + +`iota` traverses forward through `rng`, each element `y` in `rng` is assigned a value equivalent +to `x + boost::distance(boost::begin(rng), it)` + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/iota.hpp` + +[heading Requirements] + +# `ForwardRange` is a model of the __forward_range__ Concept. +# `Value` is a model of the `Incrementable` Concept. + +[heading Complexity] + +Linear. Exactly `distance(rng)` assignments into `rng`. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/is_sorted.qbk b/libs/range/doc/reference/algorithm_ext/is_sorted.qbk new file mode 100644 index 0000000000..f9c07b4f73 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/is_sorted.qbk @@ -0,0 +1,40 @@ +[/ + 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:is_sorted is_sorted] + +[heading Prototype] + +`` +template<class SinglePassRange> +bool is_sorted(const SinglePassRange& rng); + +template<class SinglePassRange, class BinaryPredicate> +bool is_sorted(const SinglePassRange& rng, BinaryPredicate pred); +`` + +[heading Description] + +`is_sorted` determines if a range is sorted. +For the non-predicate version the return value is `true` if and only if for +each adjacent elements `[x,y]` the expression `x < y` is `true`. +For the predicate version the return value is `true` is and only if for each +adjacent elements `[x,y]` the expression `pred(x,y)` is `true`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/is_sorted.hpp` + +[heading Requirements] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `BinaryPredicate` is a model of the `BinaryPredicate` Concept. +# The value type of `SinglePassRange` is convertible to both argument types of `BinaryPredicate`. + +[heading Complexity] + +Linear. A maximum of `distance(rng)` comparisons are performed. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/overwrite.qbk b/libs/range/doc/reference/algorithm_ext/overwrite.qbk new file mode 100644 index 0000000000..a265833c5f --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/overwrite.qbk @@ -0,0 +1,39 @@ +[/ + 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:overwrite overwrite] + +[heading Prototype] + +`` +template< + class SinglePassRange1, + class SinglePassRange2 + > +void overwrite(const SinglePassRange1& from, + SinglePassRange2& to); +`` + +[heading Description] + +`overwrite` assigns the values from the range `from` into the range `to`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/overwrite.hpp` + +[heading Requirements] + +# `SinglePassRange1` is a model of the __single_pass_range__ Concept. +# `SinglePassRange2` is a model of the __single_pass_range__ Concept. +# `SinglePassRange2` is mutable. +# `distance(SinglePassRange1) <= distance(SinglePassRange2)` +# `SinglePassRange1`'s value type is convertible to `SinglePassRange2`'s value type. + +[heading Complexity] + +Linear. `distance(rng1)` assignments are performed. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/push_back.qbk b/libs/range/doc/reference/algorithm_ext/push_back.qbk new file mode 100644 index 0000000000..ec46d0b696 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/push_back.qbk @@ -0,0 +1,37 @@ +[/ + 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:push_back push_back] + +[heading Prototype] + +`` +template< + class Container, + class SinglePassRange + > +Container& push_back(Container& target, + const SinglePassRange& from); +`` + +[heading Description] + +`push_back` all of the elements in the range `from` to the back of the container `target`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/push_back.hpp` + +[heading Requirements] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `Container` supports insert at `end()`. +# `SinglePassRange`'s value type is convertible to `Container`'s value type. + +[heading Complexity] + +Linear. `distance(from)` assignments are performed. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/push_front.qbk b/libs/range/doc/reference/algorithm_ext/push_front.qbk new file mode 100644 index 0000000000..d9ca4fe2e5 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/push_front.qbk @@ -0,0 +1,37 @@ +[/ + 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:push_front push_front] + +[heading Prototype] + +`` +template< + class Container, + class SinglePassRange + > +Container& push_front(Container& target, + const SinglePassRange& from); +`` + +[heading Description] + +`push_front` all of the elements in the range `from` to the front of the container `target`. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/push_front.hpp` + +[heading Requirements] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `Container` supports insert at `begin()`. +# `SinglePassRange`'s value type is convertible to `Container`'s value type. + +[heading Complexity] + +Linear. `distance(from)` assignments are performed. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/remove_erase.qbk b/libs/range/doc/reference/algorithm_ext/remove_erase.qbk new file mode 100644 index 0000000000..eecc97b641 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/remove_erase.qbk @@ -0,0 +1,33 @@ +[/ + 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:remove_erase remove_erase] + +[heading Prototype] + +`` +template<class Container, class Value> +Container& remove_erase(Container& target, + const Value& value); +`` + +[heading Description] + +`remove_erase` actually eliminates the elements equal to `value` from the container. This +is in contrast to the `remove` algorithm which merely rearranges elements. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/erase.hpp` + +[heading Requirements] + +# `Container` supports erase of an iterator range. + +[heading Complexity] + +Linear. Proportional to `distance(target)`s. + +[endsect] diff --git a/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk b/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk new file mode 100644 index 0000000000..5eab446697 --- /dev/null +++ b/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk @@ -0,0 +1,34 @@ +[/ + 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:remove_erase_if remove_erase_if] + +[heading Prototype] + +`` +template<class Container, class Pred> +Container& remove_erase_if(Container& target, + Pred pred); +`` + +[heading Description] + +`remove_erase_if` removes the elements `x` that satisfy `pred(x)` from the container. +This is in contrast to the `erase` algorithm which merely rearranges elements. + +[heading Definition] + +Defined in the header file `boost/range/algorithm_ext/erase.hpp` + +[heading Requirements] + +# `Container` supports erase of an iterator range. +# `Pred` is a model of the `Predicate` Concept. + +[heading Complexity] + +Linear. Proportional to `distance(target)`s. + +[endsect] diff --git a/libs/range/doc/reference/algorithms.qbk b/libs/range/doc/reference/algorithms.qbk new file mode 100644 index 0000000000..5cfabc7ed5 --- /dev/null +++ b/libs/range/doc/reference/algorithms.qbk @@ -0,0 +1,180 @@ +[/ + 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:algorithms Range Algorithms] +[section:introduction Introduction and motivation] +In its most simple form a [*Range Algorithm] (or range-based algorithm) is simply an iterator-based algorithm where the /two/ iterator arguments have been replaced by /one/ range argument. For example, we may write + +`` +#include <boost/range/algorithm.hpp> +#include <vector> + +std::vector<int> vec = ...; +boost::sort(vec); +`` + +instead of + +`` +std::sort(vec.begin(), vec.end()); +`` + +However, the return type of range algorithms is almost always different from that of existing iterator-based algorithms. + +One group of algorithms, like `boost::sort()`, will simply return the same range so that we can continue to pass the range around and/or further modify it. Because of this we may write +`` +boost:unique(boost::sort(vec)); +`` +to first sort the range and then run `unique()` on the sorted range. + +Algorithms like `boost::unique()` fall into another group of algorithms that return (potentially) narrowed views of the original range. By default `boost::unique(rng)` returns the range `[boost::begin(rng), found)` where `found` denotes the iterator returned by `std::unique(boost::begin(rng), boost::end(rng))` + +Therefore exactly the unique values can be copied by writing +`` +boost::copy(boost::unique(boost::sort(vec)), + std::ostream_iterator<int>(std::cout)); +`` + +Algorithms like `boost::unique` usually return the same range: `[boost::begin(rng), found)`. However, this behaviour may be changed by supplying the algorithms with a template argument: + +[table + [[Expression] [Return]] + [[`boost::unique<boost::return_found>(rng)`] [returns a single iterator like `std::unique`]] + [[`boost::unique<boost::return_begin_found>(rng)`] [returns the range `[boost::begin(rng), found)` (this is the default)]] + [[`boost::unique<boost::return_begin_next>(rng)`] [returns the range `[boost::begin(rng), boost::next(found))`]] + [[`boost::unique<boost::return_found_end>(rng)`] [returns the range `[found, boost::end(rng))`]] + [[`boost::unique<boost::return_next_end>(rng)`] [returns the range `[boost::next(found),boost::end(rng))`]] + [[`boost::unique<boost::return_begin_end>(rng)`] [returns the entire original range.]] +] + +This functionality has the following advantages: + +# it allows for ['*seamless functional-style programming*] where you do not need to use named local variables to store intermediate results +# it is very ['*safe*] because the algorithm can verify out-of-bounds conditions and handle tricky conditions that lead to empty ranges + +For example, consider how easy we may erase the duplicates in a sorted container: + +`` +std::vector<int> vec = ...; +boost::erase(vec, boost::unique<boost::return_found_end>(boost::sort(vec))); +`` + +Notice the use of `boost::return_found_end`. What if we wanted to erase all the duplicates except one of them? In old-fashined STL-programming we might write + +`` +// assume 'vec' is already sorted +std::vector<int>::iterator i = std::unique(vec.begin(), vec.end()); + +// remember this check or you get into problems +if (i != vec.end()) + ++i; + +vec.erase(i, vec.end()); +`` + +The same task may be accomplished simply with +`` +boost::erase(vec, boost::unique<boost::return_next_end>(vec)); +`` +and there is no need to worry about generating an invalid range. Furthermore, if the container is complex, calling `vec.end()` several times will be more expensive than using a range algorithm. + +[endsect] + +[section:mutating Mutating algorithms] +[include algorithm/copy.qbk] +[include algorithm/copy_backward.qbk] +[include algorithm/fill.qbk] +[include algorithm/fill_n.qbk] +[include algorithm/generate.qbk] +[include algorithm/inplace_merge.qbk] +[include algorithm/merge.qbk] +[include algorithm/nth_element.qbk] +[include algorithm/partial_sort.qbk] +[include algorithm/partition.qbk] +[include algorithm/random_shuffle.qbk] +[include algorithm/remove.qbk] +[include algorithm/remove_copy.qbk] +[include algorithm/remove_copy_if.qbk] +[include algorithm/remove_if.qbk] +[include algorithm/replace.qbk] +[include algorithm/replace_copy.qbk] +[include algorithm/replace_copy_if.qbk] +[include algorithm/replace_if.qbk] +[include algorithm/reverse.qbk] +[include algorithm/reverse_copy.qbk] +[include algorithm/rotate.qbk] +[include algorithm/rotate_copy.qbk] +[include algorithm/sort.qbk] +[include algorithm/stable_partition.qbk] +[include algorithm/stable_sort.qbk] +[include algorithm/swap_ranges.qbk] +[include algorithm/transform.qbk] +[include algorithm/unique.qbk] +[include algorithm/unique_copy.qbk] +[endsect] + +[section:non_mutating Non-mutating algorithms] +[include algorithm/adjacent_find.qbk] +[include algorithm/binary_search.qbk] +[include algorithm/count.qbk] +[include algorithm/count_if.qbk] +[include algorithm/equal.qbk] +[include algorithm/equal_range.qbk] +[include algorithm/for_each.qbk] +[include algorithm/find.qbk] +[include algorithm/find_end.qbk] +[include algorithm/find_first_of.qbk] +[include algorithm/find_if.qbk] +[include algorithm/lexicographical_compare.qbk] +[include algorithm/lower_bound.qbk] +[include algorithm/max_element.qbk] +[include algorithm/min_element.qbk] +[include algorithm/mismatch.qbk] +[include algorithm/search.qbk] +[include algorithm/search_n.qbk] +[include algorithm/upper_bound.qbk] +[endsect] + +[section:set Set algorithms] +[include algorithm/includes.qbk] +[include algorithm/set_union.qbk] +[include algorithm/set_intersection.qbk] +[include algorithm/set_difference.qbk] +[include algorithm/set_symmetric_difference.qbk] +[endsect] + +[section:heap Heap algorithms] +[include algorithm/push_heap.qbk] +[include algorithm/pop_heap.qbk] +[include algorithm/make_heap.qbk] +[include algorithm/sort_heap.qbk] +[endsect] + +[section:permutation Permutation algorithms] +[include algorithm/next_permutation.qbk] +[include algorithm/prev_permutation.qbk] +[endsect] + +[section:new New algorithms] +[include algorithm_ext/copy_n.qbk] +[include algorithm_ext/erase.qbk] +[include algorithm_ext/for_each.qbk] +[include algorithm_ext/insert.qbk] +[include algorithm_ext/iota.qbk] +[include algorithm_ext/is_sorted.qbk] +[include algorithm_ext/overwrite.qbk] +[include algorithm_ext/push_back.qbk] +[include algorithm_ext/push_front.qbk] +[include algorithm_ext/remove_erase.qbk] +[include algorithm_ext/remove_erase_if.qbk] +[endsect] + +[section:numeric Numeric algorithms] +[include numeric/accumulate.qbk] +[include numeric/adjacent_difference.qbk] +[include numeric/inner_product.qbk] +[include numeric/partial_sum.qbk] +[endsect] +[endsect]
\ No newline at end of file diff --git a/libs/range/doc/reference/extending.qbk b/libs/range/doc/reference/extending.qbk new file mode 100644 index 0000000000..6414e67c9d --- /dev/null +++ b/libs/range/doc/reference/extending.qbk @@ -0,0 +1,324 @@ +[/ + 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:extending Extending the library] + +[section:method_1 Method 1: provide member functions and nested types] + +This procedure assumes that you have control over the types that should be made conformant to a Range concept. If not, see [link range.reference.extending.method_2 method 2]. + +The primary templates in this library are implemented such that standard containers will work automatically and so will __boost_array__. Below is given an overview of which member functions and member types a class must specify to be useable as a certain Range concept. + +[table + [[Member function] [Related concept ]] + [[`begin()` ] [__single_pass_range__]] + [[`end()` ] [__single_pass_range__]] +] + +Notice that `rbegin()` and `rend()` member functions are not needed even though the container can support bidirectional iteration. + +The required member types are: + +[table + [[Member type ] [Related concept ]] + [[`iterator` ] [__single_pass_range__]] + [[`const_iterator`] [__single_pass_range__]] +] + +Again one should notice that member types `reverse_iterator` and `const_reverse_iterator` are not needed. + +[endsect] + +[section:method_2 Method 2: provide free-standing functions and specialize metafunctions] + +This procedure assumes that you cannot (or do not wish to) change the types that should be made conformant to a Range concept. If this is not true, see [link range.reference.extending.method_1 method 1]. + +The primary templates in this library are implemented such that certain functions are found via argument-dependent-lookup (ADL). Below is given an overview of which free-standing functions a class must specify to be useable as a certain Range concept. Let `x` be a variable (`const` or `mutable`) of the class in question. + +[table + [[Function ] [Related concept ]] + [[`range_begin(x)`] [__single_pass_range__]] + [[`range_end(x)` ] [__single_pass_range__]] + [[`range_calculate_size(x)`] [ Optional. This can be used to specify a mechanism for constant-time computation of the size of a range. The default behaviour is to return `boost::end(x) - boost::begin(x)` for random access ranges, and to return `x.size()` for ranges with lesser traversal capability. This behaviour can be changed by implementing `range_calculate_size` in a manner that will be found via ADL. The ability to calculate size in O(1) is often possible even with ranges with traversal categories less than random access.]] +] + +`range_begin()` and `range_end()` must be overloaded for both `const` and `mutable` reference arguments. + +You must also specialize two metafunctions for your type `X`: + +[table + [[Metafunction ] [Related concept ]] + [[`boost::range_mutable_iterator`] [__single_pass_range__]] + [[`boost::range_const_iterator`] [__single_pass_range__]] +] + +A complete example is given here: + +`` + #include <boost/range.hpp> + #include <iterator> // for std::iterator_traits, std::distance() + + namespace Foo + { + // + // Our sample UDT. A 'Pair' + // will work as a range when the stored + // elements are iterators. + // + template< class T > + struct Pair + { + T first, last; + }; + + } // namespace 'Foo' + + namespace boost + { + // + // Specialize metafunctions. We must include the range.hpp header. + // We must open the 'boost' namespace. + // + + template< class T > + struct range_mutable_iterator< Foo::Pair<T> > + { + typedef T type; + }; + + template< class T > + struct range_const_iterator< Foo::Pair<T> > + { + // + // Remark: this is defined similar to 'range_iterator' + // because the 'Pair' type does not distinguish + // between an iterator and a const_iterator. + // + typedef T type; + }; + + } // namespace 'boost' + + namespace Foo + { + // + // The required functions. These should be defined in + // the same namespace as 'Pair', in this case + // in namespace 'Foo'. + // + + template< class T > + inline T range_begin( Pair<T>& x ) + { + return x.first; + } + + template< class T > + inline T range_begin( const Pair<T>& x ) + { + return x.first; + } + + template< class T > + inline T range_end( Pair<T>& x ) + { + return x.last; + } + + template< class T > + inline T range_end( const Pair<T>& x ) + { + return x.last; + } + + } // namespace 'Foo' + + #include <vector> + + int main(int argc, const char* argv[]) + { + typedef std::vector<int>::iterator iter; + std::vector<int> vec; + Foo::Pair<iter> pair = { vec.begin(), vec.end() }; + const Foo::Pair<iter>& cpair = pair; + // + // Notice that we call 'begin' etc with qualification. + // + iter i = boost::begin( pair ); + iter e = boost::end( pair ); + i = boost::begin( cpair ); + e = boost::end( cpair ); + boost::range_difference< Foo::Pair<iter> >::type s = boost::size( pair ); + s = boost::size( cpair ); + boost::range_reverse_iterator< const Foo::Pair<iter> >::type + ri = boost::rbegin( cpair ), + re = boost::rend( cpair ); + + return 0; + } +`` + +[endsect] + +[section:method_3 Method 3: provide range adaptor implementations] + +[section:method_3_1 Method 3.1: Implement a Range Adaptor without arguments] + +To implement a Range Adaptor without arguments (e.g. reversed) you need to: + +# Provide a range for your return type, for example: +`` +#include <boost/range/iterator_range.hpp> +#include <boost/iterator/reverse_iterator.hpp> + +template< typename R > +struct reverse_range : + boost::iterator_range< + boost::reverse_iterator< + typename boost::range_iterator<R>::type> > +{ +private: + typedef boost::iterator_range< + boost::reverse_iterator< + typename boost::range_iterator<R>::type> > base; + +public: + typedef boost::reverse_iterator< + typename boost::range_iterator<R>::type > iterator; + + reverse_range(R& r) + : base(iterator(boost::end(r)), iterator(boost::begin(r))) + { } +}; +`` + +# Provide a tag to uniquely identify your adaptor in the `operator|` function overload set +`` +namespace detail { + struct reverse_forwarder {}; +} +`` + +# Implement `operator|` +`` +template< class BidirectionalRng > +inline reverse_range<BidirectionalRng> +operator|( BidirectionalRng& r, detail::reverse_forwarder ) +{ + return reverse_range<BidirectionalRng>( r ); +} + +template< class BidirectionalRng > +inline reverse_range<const BidirectionalRng> +operator|( const BidirectionalRng& r, detail::reverse_forwarder ) +{ + return reverse_range<const BidirectionalRng>( r ); +} +`` + +[endsect] + +[section:method_3_2 Method 3.2: Implement a Range Adaptor with arguments] + +# Provide a range for your return type, for example: +`` +#include <boost/range/adaptor/argument_fwd.hpp> +#include <boost/range/iterator_range.hpp> +#include <boost/iterator/transform_iterator.hpp> + +template<typename Value> +class replace_value +{ +public: + typedef const Value& result_type; + typedef const Value& argument_type; + + replace_value(const Value& from, const Value& to) + : m_from(from), m_to(to) + { + } + + const Value& operator()(const Value& x) const + { + return (x == m_from) ? m_to : x; + } +private: + Value m_from; + Value m_to; +}; + +template<typename Range> +class replace_range +: public boost::iterator_range< + boost::transform_iterator< + replace_value<typename boost::range_value<Range>::type>, + typename boost::range_iterator<Range>::type> > +{ +private: + typedef typename boost::range_value<Range>::type value_type; + typedef typename boost::range_iterator<Range>::type iterator_base; + typedef replace_value<value_type> Fn; + typedef boost::transform_iterator<Fn, iterator_base> replaced_iterator; + typedef boost::iterator_range<replaced_iterator> base_t; + +public: + replace_range(Range& rng, value_type from, value_type to) + : base_t(replaced_iterator(boost::begin(rng), Fn(from,to)), + replaced_iterator(boost::end(rng), Fn(from,to))) + { + } + }; +`` + +# Implement a holder class to hold the arguments required to construct the RangeAdaptor. + +The holder combines multiple parameters into one that can be passed as the right operand of `operator|()`. + +`` +template<typename T> +class replace_holder : public boost::range_detail::holder2<T> +{ +public: + replace_holder(const T& from, const T& to) + : boost::range_detail::holder2<T>(from, to) + { } +private: + void operator=(const replace_holder&); +}; +`` + +# Define an instance of the holder with the name of the adaptor + +`` +static boost::range_detail::forwarder2<replace_holder> +replaced = boost::range_detail::forwarder2<replace_holder>(); +`` + +# Define `operator|` + +`` +template<typename SinglePassRange> +inline replace_range<SinglePassRange> +operator|(SinglePassRange& rng, + const replace_holder<typename boost::range_value<SinglePassRange>::type>& f) +{ + return replace_range<SinglePassRange>(rng, f.val1, f.val2); +} + +template<typename SinglePassRange> +inline replace_range<const SinglePassRange> +operator|(const SinglePassRange& rng, + const replace_holder<typename boost::range_value<SinglePassRange>::type>& f) +{ + return replace_range<const SinglePassRange>(rng, f.val1, f.val2); +} +`` + +[endsect] + +[endsect] + +[endsect] + diff --git a/libs/range/doc/reference/numeric/accumulate.qbk b/libs/range/doc/reference/numeric/accumulate.qbk new file mode 100644 index 0000000000..af5df1dd9c --- /dev/null +++ b/libs/range/doc/reference/numeric/accumulate.qbk @@ -0,0 +1,61 @@ +[/ + 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:accumulate accumulate] + +[heading Prototype] + +`` +template< + class SinglePassRange, + class Value + > +Value accumulate(const SinglePassRange& source_rng, + Value init); + +template< + class SinglePassRange, + class Value, + class BinaryOperation + > +Value accumulate(const SinglePassRange& source_rng, + Value init, + BinaryOperation op); +`` + +[heading Description] + +`accumulate` is a generalisation of summation. It computes a binary operation (`operator+` +in the non-predicate version) of `init` and all of the elements in `rng`. + +The return value is the resultant value of the above algorithm. + +[heading Definition] + +Defined in the header file `boost/range/numeric.hpp` + +[heading Requirements] + +[heading For the first version] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `Value` is a model of the `AssignableConcept`. +# An `operator+` is defined for a left-hand operand of type `Value` and a right-hand operance of the `SinglePassRange` value type. +# The return type of the above operator is convertible to `Value`. + +[heading For the second version] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `Value` is a model of the `AssignableConcept`. +# `BinaryOperation` is a model of the `BinaryFunctionConcept`. +# `Value` is convertible to `BinaryOperation`'s first argument type. +# `SinglePassRange`'s value type is convertible to `BinaryOperation`'s second argument type. +# The return type of `BinaryOperation` is convertible to `Value`. + +[heading Complexity] + +Linear. Exactly `distance(source_rng)`. + +[endsect] diff --git a/libs/range/doc/reference/numeric/adjacent_difference.qbk b/libs/range/doc/reference/numeric/adjacent_difference.qbk new file mode 100644 index 0000000000..7580036a9c --- /dev/null +++ b/libs/range/doc/reference/numeric/adjacent_difference.qbk @@ -0,0 +1,68 @@ +[/ + 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:adjacent_difference adjacent_difference] + +[heading Prototype] + +`` +template< + class SinglePassRange, + class OutputIterator + > +OutputIterator adjacent_difference( + const SinglePassRange& source_rng, + OutputIterator out_it); + +template< + class SinglePassRange, + class OutputIterator, + class BinaryOperation + > +OutputIterator adjacent_difference( + const SinglePassRange& source_rng, + OutputIterator out_it, + BinaryOperation op); +`` + +[heading Description] + +`adjacent_difference` calculates the differences of adjacent_elements in `rng`. + +The first version of `adjacent_difference` uses `operator-()` to calculate the differences. +The second version uses `BinaryOperation` instead of `operator-()`. + +[heading Definition] + +Defined in the header file `boost/range/numeric.hpp` + +[heading Requirements] + +[heading For the first version] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `OutputIterator` is a model of the `OutputIteratorConcept`. +# If `x` and `y` are objects of `SinglePassRange`'s value type, then `x - y` is defined. +# The value type of `SinglePassRange` is convertible to a type in `OutputIterator`'s set of value types. +# The return type of `x - y` is convertible to a type in `OutputIterator`'s set of value types. + +[heading For the second version] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `OutputIterator` is a model of the `OutputIteratorConcept`. +# `BinaryOperation` is a model of the `BinaryFunctionConcept`. +# The value type of `SinglePassRange` is convertible to `BinaryOperation`'s first and second argument types. +# The value type of `SinglePassRange` is convertible to a type in `OutputIterator`'s set of value types. +# The result type of `BinaryOperation` is convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +`[result, result + distance(rng))` is a valid range. + +[heading Complexity] + +Linear. If `empty(rng)` then zero applications, otherwise `distance(rng) - 1` applications are performed. + +[endsect] diff --git a/libs/range/doc/reference/numeric/inner_product.qbk b/libs/range/doc/reference/numeric/inner_product.qbk new file mode 100644 index 0000000000..1c6fc51d5e --- /dev/null +++ b/libs/range/doc/reference/numeric/inner_product.qbk @@ -0,0 +1,72 @@ +[/ + 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:inner_product inner_product] + +[heading Prototype] + +`` +template<class SinglePassRange1, + class SinglePassRange2, + class Value> + Value inner_product( const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + Value init ); + +template<class SinglePassRange1, + class SinglePassRange2, + class Value, + class BinaryOperation1, + class BinaryOperation2> + Value inner_product( const SinglePassRange1& rng1, + const SinglePassRange2& rng2, + Value init, + BinaryOperation1 op1 ); +`` + +[heading Description] + +`inner_product` calculates a generalised inner product of the range `rng1` and `rng2`. + +For further information on the `inner_product` algorithm please see __sgi_inner_product__. + +[heading Definition] + +Defined in the header file `boost/range/numeric.hpp` + +[heading Requirements] + +[heading For the first version] + +# `SinglePassRange1` is a model of the __single_pass_range__ Concept. +# `SinglePassRange2` is a model of the __single_pass_range__ Concept. +# `Value` is a model of the `AssignableConcept`. +# If `x` is an object of type `Value`, `y` is an object of `SinglePassRange1`'s value +type, and `z` is an object of `SinglePassRange2`'s value type, then `x + y * z` +is defined. +# The result type of the expression `x + y * z` is convertible to `Value`. + +[heading For the second version] + +# `SinglePassRange1` is a model of the __single_pass_range__ Concept. +# `SinglePassRange2` is a model of the __single_pass_range__ Concept. +# `Value` is a model of the `AssignableConcept`. +# `BinaryOperation1` is a model of the `BinaryFunctionConcept`. +# `BinaryOperation2` is a model of the `BinaryFunctionConcept`. +# The value type of `SinglePassRange1` is convertible to the first argument type of `BinaryOperation2`. +# The value type of `SinglePassRange2` is convertible to the second argument type of `BinaryOperation2`. +# `Value` is convertible to the value type of `BinaryOperation1`. +# The return type of `BinaryOperation2` is convertible to the second argument type of `BinaryOperation1`. +# The return type of `BinaryOperation1` is convertible to `Value`. + +[heading Precondition:] + +`distance(rng2) >= distance(rng1)` is a valid range. + +[heading Complexity] + +Linear. Exactly `distance(rng)`. + +[endsect] diff --git a/libs/range/doc/reference/numeric/partial_sum.qbk b/libs/range/doc/reference/numeric/partial_sum.qbk new file mode 100644 index 0000000000..f52e4657d0 --- /dev/null +++ b/libs/range/doc/reference/numeric/partial_sum.qbk @@ -0,0 +1,60 @@ +[/ + 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:partial_sum partial_sum] + +[heading Prototype] + +`` +template<class SinglePassRange, + class OutputIterator> +OutputIterator partial_sum(const SinglePassRange& rng, + OutputIterator out_it); + +template<class SinglePassRange, + class OutputIterator, + class BinaryOperation> +OutputIterator partial_sum(const SinglePassRange& rng, + OutputIterator out_it, + BinaryOperation op); +`` + +[heading Description] + +`partial_sum` calculates a generalised partial sum of `rng` in the same manner as +`std::partial_sum(boost::begin(rng), boost::end(rng), out_it)`. See __sgi_partial_sum__. + + +[heading Definition] + +Defined in the header file `boost/range/numeric.hpp` + +[heading Requirements] + +[heading For the first version] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `OutputIterator` is a model of the `OutputIteratorConcept`. +# If `x` and `y` are objects of `SinglePassRange`'s value type, then `x + y` is defined. +# The return type of `x + y` is convertible to the value type of `SinglePassRange`. +# The value type of `SinglePassRange` is convertible to a type in `OutputIterator`'s set of value types. + +[heading For the second version] + +# `SinglePassRange` is a model of the __single_pass_range__ Concept. +# `OutputIterator` is a model of the `OutputIteratorConcept`. +# `BinaryOperation` is a model of the `BinaryFunctionConcept`. +# The result type of `BinaryOperation` is convertible to the value type of `SinglePassRange`. +# The value type of `SinglePassRange` is convertible to a type in `OutputIterator`'s set of value types. + +[heading Precondition:] + +`[result, result + distance(rng))` is a valid range. + +[heading Complexity] + +Linear. If `empty(rng)` then zero applications, otherwise `distance(rng) - 1` applications are performed. + +[endsect] diff --git a/libs/range/doc/reference/overview.qbk b/libs/range/doc/reference/overview.qbk new file mode 100644 index 0000000000..af7ef2cab2 --- /dev/null +++ b/libs/range/doc/reference/overview.qbk @@ -0,0 +1,19 @@ +[/ + 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:overview Overview] + +Three types of objects are currently supported by the library: + +* standard-like containers +* `std::pair<iterator,iterator>` +* built-in arrays + +Even though the behavior of the primary templates are exactly such that standard containers will be supported by default, the requirements are much lower than the standard container requirements. For example, the utility class __iterator_range__ implements the __minimal_interface__ required to make the class a __forward_range__. + +Please also see __range_concepts__ for more details. + +[endsect] + diff --git a/libs/range/doc/reference/ranges.qbk b/libs/range/doc/reference/ranges.qbk new file mode 100644 index 0000000000..5b853d5458 --- /dev/null +++ b/libs/range/doc/reference/ranges.qbk @@ -0,0 +1,14 @@ +[/ + 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:ranges Provided Ranges] + +[include ranges/any_range.qbk] +[include ranges/counting_range.qbk] +[include ranges/istream_range.qbk] +[include ranges/irange.qbk] + +[endsect] + diff --git a/libs/range/doc/reference/ranges/any_range.qbk b/libs/range/doc/reference/ranges/any_range.qbk new file mode 100644 index 0000000000..6ff224e5f6 --- /dev/null +++ b/libs/range/doc/reference/ranges/any_range.qbk @@ -0,0 +1,115 @@ +[/ + 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:any_range any_range] + +[heading Description] + +`any_range` is a range that has the type information erased hence a `any_range<int, boost::forward_pass_traversal_tag, int, std::ptrdiff_t>` +can be used to represent a `std::vector<int>`, a `std::list<int>` or many other types. + +The __type_erasure_article__ covers the motivation and goals of type erasure in this context. Clearly +my implementation is building upon a lot of prior art created by others. Thomas Becker's `any_iterator` was a strong +influence. Adobe also have an `any_iterator` implementation, but this has very tight coupling to other parts of the +library that precluded it from use in Boost.Range. +Early development versions of this Range Adaptor directly used Thomas Becker's any_iterator implementation. +Subsequently I discovered that the heap allocations of this and many other implementations cause poor +speed performance particularly at the tails of the distribution. To solve this required a new design that +incorporated the embedded buffer optimization. + +Despite the underlying `any_iterator` being the fastest available implementation, the performance overhead of `any_range` is still appreciable due to the cost of virtual function calls required to implement `increment`, `decrement`, `advance`, `equal` etc. Frequently a better design choice is to convert to a canonical form. + +Please see the __range_adaptors_type_erased__ for a Range Adaptor that returns `any_range` instances. + +[heading Synopsis] + +`` +template< + class Value + , class Traversal + , class Reference + , class Difference + , class Buffer = any_iterator_default_buffer +> +class any_range + : public iterator_range< + range_detail::any_iterator< + Value + , Traversal + , Reference + , Difference + , Buffer + > + > +{ + typedef range_detail::any_iterator< + Value + , Traversal + , Reference + , Difference + , Buffer + > any_iterator_type; + + typedef iterator_range<any_iterator_type> base_type; + + struct enabler {}; + struct disabler {}; +public: + typedef any_iterator_type iterator; + typedef any_iterator_type const_iterator; + + any_range() + { + } + + any_range(const any_range& other) + : base_type(other) + { + } + + template<class WrappedRange> + any_range(WrappedRange& wrapped_range) + : base_type(boost::begin(wrapped_range), + boost::end(wrapped_range)) + { + } + + template<class WrappedRange> + any_range(const WrappedRange& wrapped_range) + : base_type(boost::begin(wrapped_range), + boost::end(wrapped_range)) + { + } + + template< + class OtherValue + , class OtherTraversal + , class OtherReference + , class OtherDifference + > + any_range(const any_range< + OtherValue + , OtherTraversal + , OtherReference + , OtherDifference + , Buffer + >& other) + : base_type(boost::begin(other), boost::end(other)) + { + } + + template<class Iterator> + any_range(Iterator first, Iterator last) + : base_type(first, last) + { + } +}; +`` + +[heading Definition] + +Defined in header file `boost/range/any_range.hpp` + +[endsect] diff --git a/libs/range/doc/reference/ranges/counting_range.qbk b/libs/range/doc/reference/ranges/counting_range.qbk new file mode 100644 index 0000000000..31037a95e2 --- /dev/null +++ b/libs/range/doc/reference/ranges/counting_range.qbk @@ -0,0 +1,36 @@ +[/ + 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:counting_range counting_range] + +[heading Prototype] + +`` +template< class Incrementable > inline +iterator_range< counting_iterator<Incrementable> > +counting_range(Incrementable first, Incrementable last); + +template< class SinglePassRange > inline +iterator_range< counting_iterator<typename range_iterator<SinglePassRange>::type > +counting_range(const SinglePassRange& rng); + +template< class SinglePassRange > inline +iterator_range< counting_iterator<typename range_iterator<SinglePassRange>::type > +counting_range(SinglePassRange& rng); +`` + +[heading Description] + +`counting_range` is a function to generator that generates an `iterator_range` wrapping a `counting_iterator` (from Boost.Iterator). + +[heading Definition] + +Defined in header file `boost/range/counting_range.hpp` + +[heading Requirements] + +# `Incrementable` is a model of the `Incrementable` Concept. + +[endsect] diff --git a/libs/range/doc/reference/ranges/irange.qbk b/libs/range/doc/reference/ranges/irange.qbk new file mode 100644 index 0000000000..6e59cb1b9a --- /dev/null +++ b/libs/range/doc/reference/ranges/irange.qbk @@ -0,0 +1,40 @@ +[/ + 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:irange irange] + +[heading Prototype] + +`` +template<class Integer> +iterator_range< range_detail::integer_iterator<Integer> > +irange(Integer first, Integer last); + +template<class Integer, class StepSize> +iterator_range< range_detail::integer_iterator_with_step<Integer, StepSize> > +irange(Integer first, Integer last, StepSize step_size); +`` + +[heading Description] + +`irange` is a function to generate an Integer Range. + +`irange` allows treating integers as a model of the __random_access_range__ Concept. It should be noted that the `first` and `last` parameters denoted a half-open range. + +[heading Definition] + +Defined in the header file `boost/range/irange.hpp` + +[heading Requirements] + +# `Integer` is a model of the `Integer` Concept. +# `StepSize` is a model of the `SignedInteger` Concept. + +[heading Complexity] + +Constant. Since this function generates a new range the most significant performance cost is incurred through the iteration of the generated range. + +[endsect] + diff --git a/libs/range/doc/reference/ranges/istream_range.qbk b/libs/range/doc/reference/ranges/istream_range.qbk new file mode 100644 index 0000000000..66a1e84489 --- /dev/null +++ b/libs/range/doc/reference/ranges/istream_range.qbk @@ -0,0 +1,24 @@ +[/ + 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:istream_range istream_range] + +[heading Prototype] + +`` +template< class Type, class Elem, class Traits > inline +iterator_range< std::istream_iterator<Type, Elem, Traits> > +istream_range(std::basic_istream<Elem, Traits>& in); +`` + +[heading Description] + +`istream_range` is a function to generator that generates an `iterator_range` wrapping a `std::istream_iterator`. + +[heading Definition] + +Defined in header file `boost/range/istream_range.hpp` + +[endsect] diff --git a/libs/range/doc/reference/semantics.qbk b/libs/range/doc/reference/semantics.qbk new file mode 100644 index 0000000000..335ab90d6f --- /dev/null +++ b/libs/range/doc/reference/semantics.qbk @@ -0,0 +1,200 @@ +[/ + 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:semantics Semantics] + +[heading notation] + +[table + [[Type ] [Object] [Describes ]] + [[`X` ] [`x` ] [any type ]] + [[`T` ] [`t` ] [denotes behavior of the primary templates]] + [[`P` ] [`p` ] [denotes `std::pair<iterator,iterator>` ]] + [[`A[sz]`] [`a` ] [denotes an array of type `A` of size `sz`]] + [[`Char*`] [`s` ] [denotes either `char*` or `wchar_t*` ]] +] + +[section Metafunctions] + +[table + [[Expression] [Return type] [Complexity]] + [ + [`range_iterator<X>::type`] + [`` + T::iterator + P::first_type + A* + ``] + [compile time] + ] + [ + [`range_iterator<const X>::type`] + [`` + T::const_iterator + P::first_type + const A* + ``] + [compile time] + ] + [ + [`range_value<X>::type`] + [`boost::iterator_value<range_iterator<X>::type>::type`] + [compile time] + ] + [ + [`range_reference<X>::type`] + [`boost::iterator_reference<range_iterator<X>::type>::type`] + [compile time] + ] + [ + [`range_pointer<X>::type`] + [`boost::iterator_pointer<range_iterator<X>::type>::type`] + [compile time] + ] + [ + [`range_category<X>::type`] + [`boost::iterator_category<range_iterator<X>::type>::type`] + [compile time] + ] + [ + [`range_difference<X>::type`] + [`boost::iterator_category<range_iterator<X>::type>::type`] + [compile time] + ] + [ + [`range_reverse_iterator<X>::type`] + [`boost::reverse_iterator<range_iterator<X>::type>`] + [compile time] + ] + [ + [`range_reverse_iterator<const X>::type`] + [`boost::reverse_iterator<range_iterator<const X>::type`] + [compile time] + ] + [ + [`has_range_iterator<X>::type`] + [`mpl::true_` if `range_mutable_iterator<X>::type` is a valid expression, `mpl::false_` otherwise] + [compile time] + ] + [ + [`has_range_const_iterator<X>::type`] + [`mpl::true_` if `range_const_iterator<X>::type` is a valid expression, `mpl::false_` otherwise] + [compile time] + ] +] + +[endsect] + +[section Functions] + +[table + [[Expression] [Return type] [Returns] [Complexity]] + + [ + [`begin(x)`] + [`range_iterator<X>::type`] + [ + `p.first` if `p` is of type `std::pair<T>` + `a` if `a` is an array + `range_begin(x)` if that expression would invoke a function found by ADL + `t.begin()` otherwise + ] + [constant time] + ] + [ + [`end(x)`] + [`range_iterator<X>::type`] + [ + `p.second` if `p` is of type `std::pair<T>` + `a + sz` if `a` is an array of size `sz` + `range_end(x)` if that expression would invoke a function found by ADL + `t.end()` otherwise + ] + [constant time] + ] + [ + [`empty(x)`] + [`bool`] + [`boost::begin(x) == boost::end(x)`] + [constant time] + ] + [ + [`distance(x)`] + [`range_difference<X>::type`] + [`std::distance(boost::begin(x),boost::end(x))`] + [-] + ] + [ + [`size(x)`] + [`range_difference<X>::type`] + [`range_calculate_size(x)` which by default is `boost::end(x) - boost::begin(x)`. Users may supply alternative implementations by implementing `range_calculate_size(x)` so that it will be found via ADL] + [constant time] + ] + [ + [`rbegin(x)`] + [`range_reverse_iterator<X>::type`] + [`range_reverse_iterator<X>::type(boost::end(x))`] + [constant time] + ] + [ + [`rend(x)`] + [`range_reverse_iterator<X>::type`] + [`range_reverse_iterator<X>::type(boost::begin(x))`] + [constant time] + ] + [ + [`const_begin(x)`] + [`range_iterator<const X>::type`] + [`range_iterator<const X>::type(boost::begin(x))`] + [constant time] + ] + [ + [`const_end(x)`] + [`range_iterator<const X>::type`] + [`range_iterator<const X>::type(boost::end(x))`] + [constant time] + ] + [ + [`const_rbegin(x)`] + [`range_reverse_iterator<const X>::type`] + [`range_reverse_iterator<const X>::type(boost::rbegin(x))`] + [constant time] + ] + [ + [`const_rend(x)`] + [`range_reverse_iterator<const X>::type`] + [`range_reverse_iterator<const X>::type(boost::rend(x))`] + [constant time] + ] + [ + [`as_literal(x)`] + [`iterator_range<U>` where `U` is `Char*` if `x` is a pointer to a string and `U` is `range_iterator<X>::type` otherwise] + [ + `[s,s + std::char_traits<X>::length(s))` if `s` is a `Char*` or an array of `Char` `[boost::begin(x),boost::end(x))` otherwise + ] + [ + linear time for pointers to a string or arrays of `Char`, constant time otherwise + ] + ] + [ + [`as_array(x)`] + [`iterator_range<X>`] + [`[boost::begin(x),boost::end(x))`] + ] +] + +The special `const_`-named functions are useful when you want to document clearly that your code is read-only. + +`as_literal()` can be used ['*internally*] in string algorithm libraries such that arrays of characters are handled correctly. + +`as_array()` can be used with string algorithm libraries to make it clear that arrays of characters are handled like an array and not like a string. + +Notice that the above functions should always be called with qualification (`boost::`) to prevent ['*unintended*] Argument Dependent Lookup (ADL). + +[endsect] + +[endsect] + + diff --git a/libs/range/doc/reference/synopsis.qbk b/libs/range/doc/reference/synopsis.qbk new file mode 100644 index 0000000000..381d77b5bb --- /dev/null +++ b/libs/range/doc/reference/synopsis.qbk @@ -0,0 +1,148 @@ +[/ + 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:synopsis Synopsis] + +`` +namespace boost +{ + // + // Single Pass Range metafunctions + // + + template< class T > + struct range_iterator; + + template< class T > + struct range_value; + + template< class T > + struct range_reference; + + template< class T > + struct range_pointer; + + template< class T > + struct range_category; + + // + // Forward Range metafunctions + // + + template< class T > + struct range_difference; + + // + // Bidirectional Range metafunctions + // + + template< class T > + struct range_reverse_iterator; + + // + // Single Pass Range functions + // + + template< class T > + typename range_iterator<T>::type + begin( T& r ); + + template< class T > + typename range_iterator<const T>::type + begin( const T& r ); + + template< class T > + typename range_iterator<T>::type + end( T& r ); + + template< class T > + typename range_iterator<const T>::type + end( const T& r ); + + template< class T > + bool + empty( const T& r ); + + // + // Forward Range functions + // + + template< class T > + typename range_difference<T>::type + distance( const T& r ); + + // + // Bidirectional Range functions + // + + template< class T > + typename range_reverse_iterator<T>::type + rbegin( T& r ); + + template< class T > + typename range_reverse_iterator<const T>::type + rbegin( const T& r ); + + template< class T > + typename range_reverse_iterator<T>::type + rend( T& r ); + + template< class T > + typename range_reverse_iterator<const T>::type + rend( const T& r ); + + // + // Random Access Range functions + // + + template< class T > + typename range_difference<T>::type + size( const T& r ); + + // + // Special const Range functions + // + + template< class T > + typename range_iterator<const T>::type + const_begin( const T& r ); + + template< class T > + typename range_iterator<const T>::type + const_end( const T& r ); + + template< class T > + typename range_reverse_iterator<const T>::type + const_rbegin( const T& r ); + + template< class T > + typename range_reverse_iterator<const T>::type + const_rend( const T& r ); + + // + // String utilities + // + + template< class T > + iterator_range< ... see below ... > + as_literal( T& r ); + + template< class T > + iterator_range< ... see below ... > + as_literal( const T& r ); + + template< class T > + iterator_range< typename range_iterator<T>::type > + as_array( T& r ); + + template< class T > + iterator_range< typename range_iterator<const T>::type > + as_array( const T& r ); + +} // namespace 'boost' +`` + +[endsect] + diff --git a/libs/range/doc/reference/utilities.qbk b/libs/range/doc/reference/utilities.qbk new file mode 100644 index 0000000000..94d46994a7 --- /dev/null +++ b/libs/range/doc/reference/utilities.qbk @@ -0,0 +1,307 @@ +[/ + 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:utilities Utilities] + +Having an abstraction that encapsulates a pair of iterators is very useful. The standard library uses `std::pair` in some circumstances, but that class is cumbersome to use because we need to specify two template arguments, and for all range algorithm purposes we must enforce the two template arguments to be the same. Moreover, `std::pair<iterator,iterator>` is hardly self-documenting whereas more domain specific class names are. Therefore these two classes are provided: + +* Class `iterator_range` +* Class `sub_range` +* Function `join` + +The `iterator_range` class is templated on an __forward_traversal_iterator__ and should be used whenever fairly general code is needed. The `sub_range` class is templated on an __forward_range__ and it is less general, but a bit easier to use since its template argument is easier to specify. The biggest difference is, however, that a `sub_range` can propagate constness because it knows what a corresponding `const_iterator` is. + +Both classes can be used as ranges since they implement the __minimal_interface__ required for this to work automatically. + +[section:iterator_range Class `iterator_range`] + +The intention of the `iterator_range` class is to encapsulate two iterators so they fulfill the __forward_range__ concept. A few other functions are also provided for convenience. + +If the template argument is not a model of __forward_traversal_iterator__, one can still use a subset of the interface. In particular, `size()` requires Random Access Traversal Iterators whereas `empty()` only requires Single Pass Iterators. + +Recall that many default constructed iterators are [*/singular/] and hence can only be assigned, but not compared or incremented or anything. However, if one creates a default constructed `iterator_range`, then one can still call all its member functions. This design decision avoids the `iterator_range` imposing limitations upon ranges of iterators that are not singular. Any singularity limitation is simply propogated from the underlying iterator type. + + +[h4 Synopsis] + +`` +namespace boost +{ + template< class ForwardTraversalIterator > + class iterator_range + { + public: // Forward Range types + typedef ForwardTraversalIterator iterator; + typedef ForwardTraversalIterator const_iterator; + typedef iterator_difference<iterator>::type difference_type; + + public: // construction, assignment + template< class ForwardTraversalIterator2 > + iterator_range( ForwardTraversalIterator2 Begin, ForwardTraversalIterator2 End ); + + template< class ForwardRange > + iterator_range( ForwardRange& r ); + + template< class ForwardRange > + iterator_range( const ForwardRange& r ); + + template< class ForwardRange > + iterator_range& operator=( ForwardRange& r ); + + template< class ForwardRange > + iterator_range& operator=( const ForwardRange& r ); + + public: // Forward Range functions + iterator begin() const; + iterator end() const; + + public: // convenience + operator unspecified_bool_type() const; + bool equal( const iterator_range& ) const; + value_type& front() const; + value_type& back() const; + iterator_range& advance_begin(difference_type n); + iterator_range& advance_end(difference_type n); + bool empty() const; + // for Random Access Range only: + reference operator[]( difference_type at ) const; + value_type operator()( difference_type at ) const; + size_type size() const; + }; + + // stream output + template< class ForwardTraversalIterator, class T, class Traits > + std::basic_ostream<T,Traits>& + operator<<( std::basic_ostream<T,Traits>& Os, + const iterator_range<ForwardTraversalIterator>& r ); + + // comparison + template< class ForwardTraversalIterator, class ForwardTraversalIterator2 > + bool operator==( const iterator_range<ForwardTraversalIterator>& l, + const iterator_range<ForwardTraversalIterator2>& r ); + + template< class ForwardTraversalIterator, class ForwardRange > + bool operator==( const iterator_range<ForwardTraversalIterator>& l, + const ForwardRange& r ); + + template< class ForwardTraversalIterator, class ForwardRange > + bool operator==( const ForwardRange& l, + const iterator_range<ForwardTraversalIterator>& r ); + + template< class ForwardTraversalIterator, class ForwardTraversalIterator2 > + bool operator!=( const iterator_range<ForwardTraversalIterator>& l, + const iterator_range<ForwardTraversalIterator2>& r ); + + template< class ForwardTraversalIterator, class ForwardRange > + bool operator!=( const iterator_range<ForwardTraversalIterator>& l, + const ForwardRange& r ); + + template< class ForwardTraversalIterator, class ForwardRange > + bool operator!=( const ForwardRange& l, + const iterator_range<ForwardTraversalIterator>& r ); + + template< class ForwardTraversalIterator, class ForwardTraversalIterator2 > + bool operator<( const iterator_range<ForwardTraversalIterator>& l, + const iterator_range<ForwardTraversalIterator2>& r ); + + template< class ForwardTraversalIterator, class ForwardRange > + bool operator<( const iterator_range<ForwardTraversalIterator>& l, + const ForwardRange& r ); + + template< class ForwardTraversalIterator, class ForwardRange > + bool operator<( const ForwardRange& l, + const iterator_range<ForwardTraversalIterator>& r ); + + // external construction + template< class ForwardTraversalIterator > + iterator_range< ForwardTraversalIterator > + make_iterator_range( ForwardTraversalIterator Begin, + ForwardTraversalIterator End ); + + template< class ForwardRange > + iterator_range< typename range_iterator<ForwardRange>::type > + make_iterator_range( ForwardRange& r ); + + template< class ForwardRange > + iterator_range< typename range_iterator<const ForwardRange>::type > + make_iterator_range( const ForwardRange& r ); + + template< class Range > + iterator_range< typename range_iterator<Range>::type > + make_iterator_range( Range& r, + typename range_difference<Range>::type advance_begin, + typename range_difference<Range>::type advance_end ); + + template< class Range > + iterator_range< typename range_iterator<const Range>::type > + make_iterator_range( const Range& r, + typename range_difference<const Range>::type advance_begin, + typename range_difference<const Range>::type advance_end ); + + // convenience + template< class Sequence, class ForwardRange > + Sequence copy_range( const ForwardRange& r ); + +} // namespace 'boost' +`` + +If an instance of `iterator_range` is constructed by a client with two iterators, the client must ensure that the two iterators delimit a valid closed-open range [begin,end). + +It is worth noticing that the templated constructors and assignment operators allow conversion from `iterator_range<iterator>` to `iterator_range<const_iterator>`. Similarly, since the comparison operators have two template arguments, we can compare ranges whenever the iterators are comparable; for example when we are dealing with const and non-const iterators from the same container. + +[h4 Details member functions] + +`operator unspecified_bool_type() const;` + +[:['[*Returns]] `!empty();`] + +`bool equal( iterator_range& r ) const;` + +[:['[*Returns]] `begin() == r.begin() && end() == r.end();`] + +[h4 Details functions] + +`bool operator==( const ForwardRange1& l, const ForwardRange2& r );` + +[:['[*Returns]] `size(l) != size(r) ? false : std::equal( begin(l), end(l), begin(r) );`] + +`bool operator!=( const ForwardRange1& l, const ForwardRange2& r );` + +[:['[*Returns]] `!( l == r );`] + +`bool operator<( const ForwardRange1& l, const ForwardRange2& r );` + +[:['[*Returns]] `std::lexicographical_compare( begin(l), end(l), begin(r), end(r) );`] + +`` +iterator_range make_iterator_range( Range& r, + typename range_difference<Range>::type advance_begin, + typename range_difference<Range>::type advance_end ); +`` + +[:['[*Effects:]]] + +`` + iterator new_begin = begin( r ), + iterator new_end = end( r ); + std::advance( new_begin, advance_begin ); + std::advance( new_end, advance_end ); + return make_iterator_range( new_begin, new_end ); +`` + +`Sequence copy_range( const ForwardRange& r );` + +[:['[*Returns]] `Sequence( begin(r), end(r) );`] + +[endsect] + +[section:sub_range Class `sub_range`] + +The `sub_range` class inherits all its functionality from the __iterator_range__ class. The `sub_range` class is often easier to use because one must specify the __forward_range__ template argument instead of an iterator. Moreover, the `sub_range` class can propagate constness since it knows what a corresponding `const_iterator` is. + +[h4 Synopsis] + +`` +namespace boost +{ + template< class ForwardRange > + class sub_range : public iterator_range< typename range_iterator<ForwardRange>::type > + { + public: + typedef typename range_iterator<ForwardRange>::type iterator; + typedef typename range_iterator<const ForwardRange>::type const_iterator; + typedef typename iterator_difference<iterator>::type difference_type; + + public: // construction, assignment + template< class ForwardTraversalIterator > + sub_range( ForwardTraversalIterator Begin, ForwardTraversalIterator End ); + + template< class ForwardRange2 > + sub_range( ForwardRange2& r ); + + template< class ForwardRange2 > + sub_range( const Range2& r ); + + template< class ForwardRange2 > + sub_range& operator=( ForwardRange2& r ); + + template< class ForwardRange2 > + sub_range& operator=( const ForwardRange2& r ); + + public: // Forward Range functions + iterator begin(); + const_iterator begin() const; + iterator end(); + const_iterator end() const; + + public: // convenience + value_type& front(); + const value_type& front() const; + value_type& back(); + const value_type& back() const; + // for Random Access Range only: + value_type& operator[]( size_type at ); + const value_type& operator[]( size_type at ) const; + + public: + // rest of interface inherited from iterator_range + }; + +} // namespace 'boost' +`` + +The class should be trivial to use as seen below. Imagine that we have an algorithm that searches for a sub-string in a string. The result is an iterator_range, that delimits the match. We need to store the result from this algorithm. Here is an example of how we can do it with and without `sub_range` + +`` +std::string str("hello"); +iterator_range<std::string::iterator> ir = find_first( str, "ll" ); +sub_range<std::string> sub = find_first( str, "ll" ); +`` + +[endsect] + +[section:join Function join] + +The intention of the `join` function is to join two ranges into one longer range. + +The resultant range will have the lowest common traversal of the two ranges supplied as parameters. + +Note that the joined range incurs a performance cost due to the need to check if the end of a range has been reached internally during traversal. + +[h4 Synposis] + +`` +template<typename SinglePassRange1, typename SinglePassRange2> +joined_range<const SinglePassRange1, const SinglePassRange2> +join(const SinglePassRange1& rng1, const SinglePassRange2& rng2) + +template<typename SinglePassRange1, typename SinglePassRange2> +joined_range<SinglePassRange1, SinglePassRange2> +join(SinglePassRange1& rng1, SinglePassRange2& rng2); +`` + +For the const version: + +* [*Precondition:] The `range_value<SinglePassRange2>::type` must be convertible to `range_value<SinglePassRange1>::type`. The `range_reference<const SinglePassRange2>::type` must be convertible to `range_reference<const SinglePassRange1>::type`. +* [*Range Category:] Both `rng1` and `rng2` must be a model of __single_pass_range__ or better. +* [*Range Return Type:] `joined_range<const SinglePassRange1, const SinglePassRange2>` which is a model of the lesser of the two range concepts passed. +* [*Returned Range Category:] The minimum of the range category of `rng1` and `rng2`. + +For the mutable version: + +* [*Precondition:] The `range_value<SinglePassRange2>::type` must be convertible to `range_value<SinglePassRange1>::type`. The `range_reference<SinglePassRange2>::type` must be convertible to `range_reference<SinglePassRange1>::type`. +* [*Range Category:] Both `rng1` and `rng2` must be a model of __single_pass_range__ or better. +* [*Range Return Type:] `joined_range<SinglePassRange1, SinglePassRange2>` which is a model of the lesser of the two range concepts passed. +* [*Returned Range Category:] The minimum of the range category of `rng1` and `rng2`. + +[h4 Example] + +The expression `join(irange(0,5), irange(5,10))` would evaluate to a range representing an integer range `[0,10)` + + +[endsect] + +[endsect] + diff --git a/libs/range/doc/style.qbk b/libs/range/doc/style.qbk new file mode 100644 index 0000000000..c6e5e34c28 --- /dev/null +++ b/libs/range/doc/style.qbk @@ -0,0 +1,50 @@ +[/ + 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:style_guide Terminology and style guidelines] + +The use of a consistent terminology is as important for __ranges__ and range-based algorithms as it is for iterators and iterator-based algorithms. If a conventional set of names are adopted, we can avoid misunderstandings and write generic function prototypes that are [*/self-documenting/]. + +Since ranges are characterized by a specific underlying iterator type, we get a type of range for each type of iterator. Hence we can speak of the following types of ranges: + +* [*/Value access/] category: + * Readable Range + * Writeable Range + * Swappable Range + * Lvalue Range +* [*/Traversal/] category: + * __single_pass_range__ + * __forward_range__ + * __bidirectional_range__ + * __random_access_range__ + +Notice how we have used the categories from the __new_style_iterators__. + +Notice that an iterator (and therefore an range) has one [*/traversal/] property and one or more properties from the [*/value access/] category. So in reality we will mostly talk about mixtures such as + +* Random Access Readable Writeable Range +* Forward Lvalue Range + +By convention, we should always specify the [*/traversal/] property first as done above. This seems reasonable since there will only be one [*/traversal/] property, but perhaps many [*/value access/] properties. + +It might, however, be reasonable to specify only one category if the other category does not matter. For example, the __iterator_range__ can be constructed from a Forward Range. This means that we do not care about what [*/value access/] properties the Range has. Similarly, a Readable Range will be one that has the lowest possible [*/traversal/] property (Single Pass). + +As another example, consider how we specify the interface of `std::sort()`. Algorithms are usually more cumbersome to specify the interface of since both [*/traversal/] and [*/value access/] properties must be exactly defined. The iterator-based version looks like this: + +`` + template< class RandomAccessTraversalReadableWritableIterator > + void sort( RandomAccessTraversalReadableWritableIterator first, + RandomAccessTraversalReadableWritableIterator last ); +`` + +For ranges the interface becomes + +`` + template< class RandomAccessReadableWritableRange > + void sort( RandomAccessReadableWritableRange& r ); +`` + +[endsect] + diff --git a/libs/range/doc/upgrade.qbk b/libs/range/doc/upgrade.qbk new file mode 100644 index 0000000000..516ed118cf --- /dev/null +++ b/libs/range/doc/upgrade.qbk @@ -0,0 +1,43 @@ +[/ + 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:upgrade Upgrade version of Boost.Range] + +[section:upgrade_from_1_45 Upgrade from version 1.45] + +# __size__ in addition to supporting __random_access_range__ now also supports extensibility via calls to the unqualified `range_calculate_size(rng)` function. +# __range_adaptors_strided__ now in addition to working with any RandomAccessRange additionally works for any SinglePassRange for which `boost::size(rng)` is valid. +# __range_adaptors_strided__ no longer requires `distance(rng) % stride_size == 0` or `stride_size < distance(rng)` + +[endsect] + +[section:upgrade_from_1_42 Upgrade from version 1.42] + +New features: + +# __range_adaptors__ +# __range_algorithms__ + +Removed: + +# `iterator_range` no longer has a `is_singular` member function. The singularity restrictions have been removed from the `iterator_range` class since this added restrictions to ranges of iterators whose default constructors were not singular. Previously the `is_singular` member function always returned `false` in release build configurations, hence it is not anticipated that this interface change will produce difficulty in upgrading. + + +[endsect] + +[section:upgrade_from_1_34 Upgrade from version 1.34] + +Boost version 1.35 introduced some larger refactorings of the library: + +# Direct support for character arrays was abandoned in favor of uniform treatment of all arrays. Instead string algorithms can use the new function __as_literal__`()`. +# __size__ now requires a __random_access_range__. The old behavior is provided as __distance__`()`. +# `range_size<T>::type` has been completely removed in favor of `range_difference<T>::type` +# `boost_range_begin()` and `boost_range_end()` have been renamed `range_begin()` and `range_end()` respectively. +# `range_result_iterator<T>::type` and `range_reverse_result_iterator<T>::type` have been renamed `range_iterator<T>::type` and `range_reverse_iterator<T>::type`. +# The procedure that makes a custom type work with the library has been greatly simplified. See __extending_for_udts__ for details. + +[endsect] + +[endsect] |