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)
6 [section:min_element min_element]
11 template<class ForwardRange>
12 typename range_iterator<ForwardRange>::type
13 min_element(ForwardRange& rng);
15 template<class ForwardRange>
16 typename range_iterator<const ForwardRange>::type
17 min_element(const ForwardRange& rng);
19 template<class ForwardRange, class BinaryPredicate>
20 typename range_iterator<ForwardRange>::type
21 min_element(ForwardRange& rng, BinaryPredicate pred);
23 template<class ForwardRange, class BinaryPredicate>
24 typename range_iterator<const ForwardRange>::type
25 min_element(const ForwardRange& rng, BinaryPredicate pred);
29 range_return_value re,
32 typename range_return<ForwardRange, re>::type
33 min_element(ForwardRange& rng);
36 range_return_value_re,
39 typename range_return<const ForwardRange, re>::type
40 min_element(const ForwardRange& rng);
43 range_return_value re,
47 typename range_return<ForwardRange, re>::type
48 min_element(ForwardRange& rng, BinaryPredicate pred);
51 range_return_value re,
55 typename range_return<const ForwardRange, re>::type
56 min_element(const ForwardRange& rng, BinaryPredicate pred);
61 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.
65 Defined in the header file `boost/range/algorithm/min_element.hpp`
67 [heading Requirements]
69 [*For the non-predicate versions:]
71 * `ForwardRange` is a model of the __forward_range__ Concept.
72 * `ForwardRange`'s value type is a model of the `LessThanComparableConcept`.
74 [*For the predicate versions:]
76 * `ForwardRange` is a model of the __forward_range__ Concept.
77 * `BinaryPredicate` is a model of the `BinaryPredicateConcept`.
78 * `ForwardRange`'s value type is convertible to both of `BinaryPredicate`'s argument types.
82 Linear. Zero comparisons if `empty(rng)`, otherwise `distance(rng) - 1` comparisons.