| Brian Silverman | 598d029 | 2018-08-04 23:56:47 -0700 | [diff] [blame^] | 1 | [/ |
| 2 | Copyright 2010 Neil Groves |
| 3 | Distributed under the Boost Software License, Version 1.0. |
| 4 | (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) |
| 5 | /] |
| 6 | [section:find_end find_end] |
| 7 | |
| 8 | [heading Prototype] |
| 9 | |
| 10 | `` |
| 11 | template<class ForwardRange1, class ForwardRange2> |
| 12 | typename range_iterator<ForwardRange1>::type |
| 13 | find_end(ForwardRange1& rng1, const ForwardRange2& rng2); |
| 14 | |
| 15 | template< |
| 16 | class ForwardRange1, |
| 17 | class ForwardRange2, |
| 18 | class BinaryPredicate |
| 19 | > |
| 20 | typename range_iterator<ForwardRange1>::type |
| 21 | find_end(ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); |
| 22 | |
| 23 | template< |
| 24 | range_return_value re, |
| 25 | class ForwardRange1, |
| 26 | class ForwardRange2 |
| 27 | > |
| 28 | typename range_return<ForwardRange1, re>::type |
| 29 | find_end(ForwardRange1& rng1, const ForwardRange2& rng2); |
| 30 | |
| 31 | template< |
| 32 | range_return_value re, |
| 33 | class ForwardRange1, |
| 34 | class ForwardRange2, |
| 35 | class BinaryPredicate |
| 36 | > |
| 37 | typename range_return<ForwardRange1, re>::type |
| 38 | find_end(ForwardRange1& rng1, const ForwardRange2& rng2, BinaryPredicate pred); |
| 39 | `` |
| 40 | |
| 41 | [heading Description] |
| 42 | |
| 43 | 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`. |
| 44 | 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. |
| 45 | |
| 46 | [heading Definition] |
| 47 | |
| 48 | Defined in the header file `boost/range/algorithm/find_end.hpp` |
| 49 | |
| 50 | [heading Requirements] |
| 51 | |
| 52 | [*For the non-predicate versions:] |
| 53 | |
| 54 | * `ForwardRange1` is a model of the __forward_range__ Concept. |
| 55 | * `ForwardRange2` is a model of the __forward_range__ Concept. |
| 56 | * `ForwardRange1`'s value type is a model of the `EqualityComparableConcept`. |
| 57 | * `ForwardRange2`'s value type is a model of the `EqualityComparableConcept`. |
| 58 | * Objects of `ForwardRange1`'s value type can be compared for equality with objects of `ForwardRange2`'s value type. |
| 59 | |
| 60 | [*For the predicate versions:] |
| 61 | |
| 62 | * `ForwardRange1` is a model of the __forward_range__ Concept. |
| 63 | * `ForwardRange2` is a model of the __forward_range__ Concept. |
| 64 | * `BinaryPredicate` is a model of the `BinaryPredicateConcept`. |
| 65 | * `ForwardRange1`'s value type is convertible to `BinaryPredicate`'s first argument type. |
| 66 | * `ForwardRange2`'s value type is convertible to `BinaryPredicate`'s second argument type. |
| 67 | |
| 68 | [heading Complexity] |
| 69 | |
| 70 | 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)`. |
| 71 | |
| 72 | [endsect] |
| 73 | |
| 74 | |