std::minmax

From cppreference.com
< cpp‎ | algorithm
 
 
 

Defined in header <algorithm>
(1)
template< class T >
std::pair<const T&,const T&> minmax( const T& a, const T& b );
(since C++11)
(until C++14)
template< class T >
constexpr std::pair<const T&,const T&> minmax( const T& a, const T& b );
(since C++14)
(2)
template< class T, class Compare >

std::pair<const T&,const T&> minmax( const T& a, const T& b,

                                     Compare comp );
(since C++11)
(until C++14)
template< class T, class Compare >

constexpr std::pair<const T&,const T&> minmax( const T& a, const T& b,

                                               Compare comp );
(since C++14)
(3)
template< class T >
std::pair<T,T> minmax( std::initializer_list<T> ilist);
(since C++11)
(until C++14)
template< class T >
constexpr std::pair<T,T> minmax( std::initializer_list<T> ilist);
(since C++14)
(4)
template< class T, class Compare >
std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
(since C++11)
(until C++14)
template< class T, class Compare >
constexpr std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
(since C++14)

Returns the lowest and the greatest of the given values.

1-2) Returns the smaller and the greater of a and b.
3-4) Returns the smallest and the greatest of the values in initializer list ilist.

The (1,3) versions use operator< to compare the values, whereas the (2,4) versions use the given comparison function comp.

Contents

[edit] Parameters

a, b - the values to compare
ilist - initializer list with the values to compare
comp - comparison function object (i.e. an object that satisfies the requirements of Compare) which returns ​true if the first argument is less than the second.

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.
The types Type1 and Type2 must be such that an object of type T can be implicitly converted to both of them. ​

Type requirements
-
T must meet the requirements of LessThanComparable.
-
T must meet the requirements of CopyConstructible in order to use overloads (3,4).

[edit] Return value

1-2) Returns the result of std::pair<const T&, const T&>(a, b) if a<b or if a is equivalent to b. Returns the result of std::pair<const T&, const T&>(b, a) if b<a.
3-4) A pair with the smallest value in ilist as the first element and the greatest as the second. If several elements are equivalent to the smallest, the leftmost such element is returned. If several elements are equivalent to the largest, the rightmost such element is returned.

[edit] Complexity

1-2) Constant
3-4) Linear in ilist.size()

[edit] Possible implementation

First version
template<class T> 
std::pair<const T&, const T&> minmax( const T& a, const T& b )
{
    return (b < a) ? std::pair<const T&, const T&>(b, a)
                   : std::pair<const T&, const T&>(a, b);
}
Second version
template<class T, class Compare> 
std::pair<const T&, const T&> minmax( const T& a, const T& b, Compare comp )
{
    return comp(b, a) ? std::pair<const T&, const T&>(b, a)
                      : std::pair<const T&, const T&>(a, b);
}
Third version
template< class T >
std::pair<T, T> minmax( std::initializer_list<T> ilist )
{
    auto p = std::minmax_element(ilist.begin(), ilist.end());
    return std::make_pair(*p.first, *p.second);
}
Fourth version
template< class T, class Compare >
std::pair<T, T> minmax( std::initializer_list<T> ilist, Compare comp )
{
    auto p = std::minmax_element(ilist.begin(), ilist.end(), comp);
    return std::make_pair(*p.first, *p.second);
}

[edit] Example

#include <algorithm>
#include <iostream>
#include <vector>
#include <cstdlib>
#include <ctime>
 
int main()
{
    std::vector<int> v {3, 1, 4, 1, 5, 9, 2, 6}; 
    std::srand(std::time(0));
    std::pair<int, int> bounds = std::minmax(std::rand() % v.size(),
                                             std::rand() % v.size());
 
    std::cout << "v[" << bounds.first << "," << bounds.second << "]: ";
    for (int i = bounds.first; i < bounds.second; ++i) {
        std::cout << v[i] << ' ';
    }
    std::cout << '\n';
}

Possible output:

v[2,7]: 4 1 5 9 2

[edit] See also

returns the smaller of two elements
(function template)
returns the larger of two elements
(function template)