std::min_element
Defined in header
<algorithm>
|
||
(1) | ||
template< class ForwardIt >
ForwardIt min_element( ForwardIt first, ForwardIt last ); |
(until C++17) | |
template< class ForwardIt >
constexpr ForwardIt min_element( ForwardIt first, ForwardIt last ); |
(since C++17) | |
template< class ExecutionPolicy, class ForwardIt >
constexpr ForwardIt min_element( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last ); |
(2) | (since C++17) |
(3) | ||
template< class ForwardIt, class Compare >
ForwardIt min_element( ForwardIt first, ForwardIt last, Compare comp ); |
(until C++17) | |
template< class ForwardIt, class Compare >
constexpr ForwardIt min_element( ForwardIt first, ForwardIt last, Compare comp ); |
(since C++17) | |
template< class ExecutionPolicy, class ForwardIt, class Compare >
constexpr ForwardIt min_element( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last, Compare comp ); |
(4) | (since C++17) |
Finds the smallest element in the range [first, last)
.
operator<
.comp
.policy
. These overloads do not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true
Contents |
[edit] Parameters
first, last | - | forward iterators defining the range to examine |
policy | - | the execution policy to use. See execution policy for details. |
cmp | - | comparison function object (i.e. an object that satisfies the requirements of Compare ) which returns true if a is less than b . The signature of the comparison function should be equivalent to the following: bool cmp(const Type1 &a, const Type2 &b); The signature does not need to have const &, but the function object must not modify the objects passed to it. |
Type requirements | ||
-
ForwardIt must meet the requirements of ForwardIterator .
|
[edit] Return value
Iterator to the smallest element in the range [first, last)
. If several elements in the range are equivalent to the smallest element, returns the iterator to the first such element. Returns last
if the range is empty.
[edit] Complexity
Exactly max(N-1,0) comparisons, where N = std::distance(first, last).
[edit] Exceptions
The overloads with a template parameter named ExecutionPolicy
report errors as follows:
- If execution of a function invoked as part of the algorithm throws an exception,
-
- if
policy
is std::parallel_vector_execution_policy, std::terminate is called - if
policy
is std::sequential_execution_policy or std::parallel_execution_policy, the algorithm exits with an std::exception_list containing all uncaught exceptions. If there was only one uncaught exception, the algorithm may rethrow it without wrapping in std::exception_list. It is unspecified how much work the algorithm will perform before returning after the first exception was encountered. - if
policy
is some other type, the behavior is implementation-defined
- if
- If the algorithm fails to allocate memory (either for itself or to construct an std::exception_list when handling a user exception), std::bad_alloc is thrown.
[edit] Possible implementation
First version |
---|
template<class ForwardIt> ForwardIt min_element(ForwardIt first, ForwardIt last) { if (first == last) return last; ForwardIt smallest = first; ++first; for (; first != last; ++first) { if (*first < *smallest) { smallest = first; } } return smallest; } |
Second version |
template<class ForwardIt, class Compare> ForwardIt min_element(ForwardIt first, ForwardIt last, Compare comp) { if (first == last) return last; ForwardIt smallest = first; ++first; for (; first != last; ++first) { if (comp(*first, *smallest)) { smallest = first; } } return smallest; } |
[edit] Example
#include <algorithm> #include <iostream> #include <vector> int main() { std::vector<int> v{3, 1, 4, 1, 5, 9}; std::vector<int>::iterator result = std::min_element(std::begin(v), std::end(v)); std::cout << "min element at: " << std::distance(std::begin(v), result); }
Output:
min element at: 1
[edit] See also
returns the largest element in a range (function template) |
|
(C++11)
|
returns the smallest and the largest elements in a range (function template) |
returns the smaller of the given values (function template) |
|
(parallelism TS)
|
parallelized version of std::min_element (function template) |