Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/minmax"

From cppreference.com
< cpp‎ | algorithm
m (r2.7.3) (Robot: Adding de, es, fr, it, ja, pt, ru, zh)
m (Shorten template names. Use {{lc}} where appropriate.)
Line 1: Line 1:
 
{{cpp/title|minmax}}
 
{{cpp/title|minmax}}
 
{{cpp/algorithm/navbar}}
 
{{cpp/algorithm/navbar}}
−
{{ddcl list begin}}
+
{{dcl begin}}
−
{{ddcl list header | algorithm}}
+
{{dcl header | algorithm}}
−
{{ddcl list item | 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 );
 
}}
 
}}
−
{{ddcl list item | 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 );
 
}}
 
}}
−
{{ddcl list item | 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);
 
}}
 
}}
−
{{ddcl list item | 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 );
 
}}
 
}}
−
{{ddcl list end}}
+
{{dcl end}}
  
 
@1-2@ Returns the smaller and the greater of the two values.  
 
@1-2@ Returns the smaller and the greater of the two values.  
Line 28: Line 28:
  
 
===Parameters===
 
===Parameters===
−
{{param list begin}}
+
{{par begin}}
−
{{param list item | a, b | the values to compare}}
+
{{par | a, b | the values to compare}}
−
{{param list item | ilist | initializer list with the values to compare}}
+
{{par | ilist | initializer list with the values to compare}}
−
{{param list cmp | comp | t1=T | if {{tt|a}} is ''less'' than {{tt|b}}}}  
+
{{par cmp | comp | t1=T | if {{tt|a}} is ''less'' than {{tt|b}}}}  
−
{{param list hreq}}
+
{{par hreq}}
−
{{param list req concept | T | LessThanComparable | notes=for the overloads (1) and (3)}}
+
{{par req concept | T | LessThanComparable | notes=for the overloads (1) and (3)}}
−
{{param list req concept | T | CopyConstructible | notes=for the overloads (3) and (4)}}
+
{{par req concept | T | CopyConstructible | notes=for the overloads (3) and (4)}}
−
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
Line 107: Line 107:
  
 
===See also===
 
===See also===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/algorithm/dcl list min}}
+
{{dsc inc | cpp/algorithm/dcl list min}}
−
{{dcl list template | cpp/algorithm/dcl list max}}
+
{{dsc inc | cpp/algorithm/dcl list max}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
[[de:cpp/algorithm/minmax]]
 
[[de:cpp/algorithm/minmax]]

Revision as of 17:47, 31 May 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)
1-2) Returns the smaller and the greater of the two values.
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 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 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

Template:cpp/algorithm/dcl list minTemplate:cpp/algorithm/dcl list max
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/minmax&oldid=49264"