mirror of
https://github.com/bolero-MURAKAMI/Sprout.git
synced 2024-11-25 00:43:44 +00:00
49 lines
1.7 KiB
ReStructuredText
49 lines
1.7 KiB
ReStructuredText
.. _sprout-algorithm-max_element:
|
|
###############################################################################
|
|
max_element
|
|
###############################################################################
|
|
|
|
Interface
|
|
========================================
|
|
.. sourcecode:: c++
|
|
|
|
template<typename ForwardIterator>
|
|
inline SPROUT_CONSTEXPR ForwardIterator
|
|
max_element(ForwardIterator first, ForwardIterator last);
|
|
|
|
template<typename ForwardIterator, typename Compare>
|
|
inline SPROUT_CONSTEXPR ForwardIterator
|
|
max_element(ForwardIterator first, ForwardIterator last, Compare comp);
|
|
|
|
Returns
|
|
========================================
|
|
|
|
| The first iterator i in the range [first,last) such that for any iterator j in the range [first,last) the following corresponding conditions hold: ``!(*i < *j)`` or ``!comp(*i, *j)``.
|
|
| Returns last if ``first == last``.
|
|
|
|
Examples
|
|
========================================
|
|
.. sourcecode:: c++
|
|
|
|
#include <sprout/algorithm/max_element.hpp>
|
|
#include <sprout/array.hpp>
|
|
#include <sprout/container.hpp>
|
|
using namespace sprout;
|
|
|
|
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}};
|
|
SPROUT_STATIC_CONSTEXPR auto result = sprout::max_element(begin(input), end(input));
|
|
static_assert(*result == 10, "a min element is 10.");
|
|
static_assert(result - begin(input) == 9, "a min element position is 9.");
|
|
|
|
Complexity
|
|
========================================
|
|
|
|
| Exactly ``max((last - first) - 1, 0)`` applications of the corresponding comparisons.
|
|
| Recursive function invocations in *O(logN)* (logarithmic) depth.
|
|
|
|
Header
|
|
========================================
|
|
|
|
| ``sprout/algorithm/max_element.hpp``
|
|
| Convenience header: ``sprout/algorithm.hpp``
|
|
|