Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/minmax"

From cppreference.com
< cpp‎ | algorithm
(I saw the declaration in my compiler, and std::initializer_list was declared with the template arguments.)
(I think we can should the space in template arguments in dcl entries, because that makes them easier to parse visually)
Line 5: Line 5:
 
{{dcl | num=1 | notes={{mark since c++11}} |
 
{{dcl | num=1 | notes={{mark since c++11}} |
 
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 );
 
}}
 
}}
 
{{dcl | num=2 | notes={{mark since c++11}} |
 
{{dcl | num=2 | notes={{mark since c++11}} |
 
template< class T, class Compare >
 
template< class T, class Compare >
−
std::pair<const T&, const T&> minmax( const T& a, const T& b, Compare comp );
+
std::pair<const T&,const T&> minmax( const T& a, const T& b, Compare comp );
 
}}
 
}}
 
{{dcl | num=3 | notes={{mark since c++11}} |
 
{{dcl | num=3 | notes={{mark since c++11}} |
 
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);
 
}}
 
}}
 
{{dcl | num=4 | notes={{mark since c++11}} |
 
{{dcl | num=4 | notes={{mark since c++11}} |
 
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 );
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}

Revision as of 09:19, 1 July 2013

 
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>
template< class T >
std::pair<const T&,const T&> minmax( const T& a, const T& b );
 (1) (since C++11)
template< class T, class Compare >
std::pair<const T&,const T&> minmax( const T& a, const T& b, Compare comp );
 (2) (since C++11)
template< class T >
std::pair<T,T> minmax( std::initializer_list<T> ilist);
 (3) (since C++11)
template< class T, class Compare >
std::pair<T,T> minmax( std::initializer_list<T> ilist, Compare comp );
 (4) (since C++11)

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

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

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

Template:par req concept Template:par req concept

Return value

1-2) Returns the result of std::make_pair(a, b) if a<b or if a is equivalent to b. Returns the result of std::make_pair(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) Constant
3-4) Linear in ilist.size()

Possible implementation

First version 
template<class T> 
std::pair<const T&, const T&> minmax(const T& a, const T& b)
{
    return (b < a) ? std::make_pair(b, a)
                   : std::make_pair(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::make_pair(b, a)
                      : std::make_pair(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);
}

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]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/minmax&oldid=62477"