std::min

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
Partitioning operations
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
(C++11)
(C++17)

排列
数值运算
未初始化存储上的操作
(C++17)
(C++17)
(C++17)
C 库
 
在标头 <algorithm> 定义
(1)
template< class T >
const T& min( const T& a, const T& b );
(C++14 前)
template< class T >
constexpr const T& min( const T& a, const T& b );
(C++14 起)
(2)
template< class T, class Compare >
const T& min( const T& a, const T& b, Compare comp );
(C++14 前)
template< class T, class Compare >
constexpr const T& min( const T& a, const T& b, Compare comp );
(C++14 起)
(3)
template< class T >
T min( std::initializer_list<T> ilist );
(C++11 起)
(C++14 前)
template< class T >
constexpr T min( std::initializer_list<T> ilist );
(C++14 起)
(4)
template< class T, class Compare >
T min( std::initializer_list<T> ilist, Compare comp );
(C++11 起)
(C++14 前)
template< class T, class Compare >
constexpr T min( std::initializer_list<T> ilist, Compare comp );
(C++14 起)

返回给定值中的较小者。

1-2) 返回 ab 的较小者。
3-4) 返回 initializer_list ilist 中值的最小者。

重载 (1,3)operator< 比较元素,重载 (2,4) 用给定的比较函数 comp

参数

a, b - 要比较的值
ilist - 拥有要比较的值的 initializer_list
cmp - 比较函数对象(即满足比较 (Compare) 要求的对象),如果a 小于 b,那么返回 ​true

比较函数的签名应等价于如下:

 bool cmp(const Type1 &a, const Type2 &b);

虽然签名不必有 const &,函数也不能修改传递给它的对象,而且必须接受(可有 const 限定的)类型 Type1Type2 的值,与值类别无关(从而不允许 Type1 &,也不允许 Type1,除非 Type1 的移动等价于复制 (C++11 起))。
类型 Type1Type2 必须使得 T 类型的对象能隐式转换到这两个类型。 ​

类型要求
-
为使用重载 (1,3), T 必须符合可小于比较 (LessThanComparable) 的要求。
-
为使用重载 (3,4), T 必须符合可复制构造 (CopyConstructible) 的要求。

返回值

1-2) ab 的较小者。如果它们等价,那么返回 a
3-4) ilist 中的最小值。如果有多个等价于最小者的值,那么返回最左侧的这种值。

复杂度

1-2) 一次比较
3-4) ilist.size() - 1 次比较

可能的实现

版本一
template<class T> 
const T& min(const T& a, const T& b)
{
    return (b < a) ? b : a;
}
版本二
template<class T, class Compare> 
const T& min(const T& a, const T& b, Compare comp)
{
    return (comp(b, a)) ? b : a;
}
版本三
template<class T>
T min(std::initializer_list<T> ilist)
{
    return *std::min_element(ilist.begin(), ilist.end());
}
版本四
template<class T, class Compare>
T min(std::initializer_list<T> ilist, Compare comp)
{
    return *std::min_element(ilist.begin(), ilist.end(), comp);
}

警告

如果参数之一是临时量,而该参数被返回,那么以引用捕获 std::min 的结果会产生一个悬垂引用:

int n = 1;
const int& r = std::min(n - 1, n + 1); // r 悬垂

示例

#include <algorithm>
#include <iostream>
#include <string_view>
 
int main()
{
    std::cout << "1 和 9999 之间 " << std::min(1, 9999) << " 更小\n"
              << "'a' 和 'b' 之间 '" << std::min('a', 'b') << "' 更小\n"
              << "\"foo\"\"bar\"\"hello\" 之间 \""
              << std::min({"foo", "bar", "hello"},
                          [](const std::string_view s1, const std::string_view s2)
                          {
                              return s1.size() < s2.size();
                          }) << "\" 最短\n";
}

输出:

1 和 9999 之间 1 更小
'a' 和 'b' 之间 'a' 更小
"foo","bar" 和 "hello" 之间 "foo" 最短

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 281 C++98 重载 (1,2)T 需要 可复制构造 (CopyConstructible) 不需要

参阅

返回各给定值中的较大者
(函数模板)
(C++11)
返回两个元素的较小和较大者
(函数模板)
返回范围内的最小元素
(函数模板)
(C++17)
在一对边界值间夹逼一个值
(函数模板)