Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/minmax"

From cppreference.com
< cpp‎ | algorithm
m (→‎Notes)
m
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header | algorithm}}
 
{{dcl header | algorithm}}
−
{{dcl rev begin|num=1}}
+
{{dcl rev multi|num=1
−
{{dcl | since=c++11 | until=c++14 |
+
| since1=c++11 | dcl1=
 
template< class T >  
 
template< class T >  
 
std::pair<const T&,const T&> minmax( const T& a, const T& b );
 
std::pair<const T&,const T&> minmax( const T& a, const T& b );
−
}}
+
| since2=c++14 | dcl2=
−
{{dcl | since=c++14 |
+
 
template< class T >  
 
template< class T >  
 
constexpr std::pair<const T&,const T&> minmax( const T& a, const T& b );
 
constexpr std::pair<const T&,const T&> minmax( const T& a, const T& b );
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl rev multi|num=2
−
{{dcl rev begin|num=2}}
+
| since1=c++11 | dcl1=
−
{{dcl | since=c++11 | until=c++14 |
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
std::pair<const T&,const T&> minmax( const T& a, const T& b,
 
std::pair<const T&,const T&> minmax( const T& a, const T& b,
 
                                     Compare comp );
 
                                     Compare comp );
−
}}
+
| since2=c++14 | dcl2=
−
{{dcl | since=c++14 |
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
constexpr std::pair<const T&,const T&> minmax( const T& a, const T& b,
 
constexpr std::pair<const T&,const T&> minmax( const T& a, const T& b,
 
                                               Compare comp );
 
                                               Compare comp );
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl rev multi|num=3
−
{{dcl rev begin|num=3}}
+
| since1=c++11 | dcl1=
−
{{dcl | since=c++11 | until=c++14 |
+
 
template< class T >
 
template< class T >
 
std::pair<T,T> minmax( std::initializer_list<T> ilist);
 
std::pair<T,T> minmax( std::initializer_list<T> ilist);
−
}}
+
| since2=c++14 | dcl2=
−
{{dcl | since=c++14 |
+
 
template< class T >
 
template< class T >
 
constexpr std::pair<T,T> minmax( std::initializer_list<T> ilist);
 
constexpr std::pair<T,T> minmax( std::initializer_list<T> ilist);
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl rev multi|num=4
−
{{dcl rev begin|num=4}}
+
| since1=c++11 | dcl1=
−
{{dcl | since=c++11 | until=c++14 |
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
 
std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
−
}}
+
| since2=c++14 | dcl2=
−
{{dcl | since=c++14 |
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
constexpr std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
 
constexpr std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
 
}}
 
}}
−
{{dcl rev end}}
 
 
{{dcl end}}
 
{{dcl end}}
  
Line 150: Line 142:
 
{{dsc end}}
 
{{dsc end}}
  
−
[[de:cpp/algorithm/minmax]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
[[es:cpp/algorithm/minmax]]
+
−
[[fr:cpp/algorithm/minmax]]
+
−
[[it:cpp/algorithm/minmax]]
+
−
[[ja:cpp/algorithm/minmax]]
+
−
[[pt:cpp/algorithm/minmax]]
+
−
[[ru:cpp/algorithm/minmax]]
+
−
[[zh:cpp/algorithm/minmax]]
+

Revision as of 08:03, 5 August 2020

 
C++
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
(C++11)
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
(C++20)(C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
minmax
(C++11)
(C++17)
Lexicographical comparison operations
(C++20)
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 
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 references to 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

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);

While the signature does not need to have const&, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) Type1 and Type2 regardless of value category (thus, Type1& is not allowed, nor is Type1 unless for Type1 a move is equivalent to a copy(since C++11)).
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 in order to use overloads (1,3).
-
T must meet the requirements of CopyConstructible in order to use overloads (3,4).

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.

Complexity

1-2) Exactly one comparison
3-4) At most ilist.size() * 3 / 2 comparisons

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);
}

Notes

For overloads (1,2), if one of the parameters is a temporary object or subobject of that, the reference returned becomes a dangling reference at the end of the full expression that contains the call to minmax: 

int n = 1;
auto p = std::minmax(n, n+1);
int m = p.first; // ok
int x = p.second; // undefined behavior

Example

Run this code
#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

See also

 returns the smaller of the given values
(function template) [edit]
returns the greater of the given values
(function template) [edit]
(C++11)
 returns the smallest and the largest elements in a range
(function template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/minmax&oldid=121551"