std::fdim, std::fdimf, std::fdiml

来自cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基本运算
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
fdim
(C++11)
(C++11)(C++11)(C++11)
指数函数
(C++11)
(C++11)
(C++11)
(C++11)
幂函数
(C++11)
(C++11)
三角与双曲函数
(C++11)
(C++11)
(C++11)
误差与伽马函数
(C++11)
(C++11)
(C++11)
(C++11)
临近整数的浮点运算
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
浮点操作函数
(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)
分类/比较
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
宏常量
(C++11)(C++11)(C++11)(C++11)(C++11)
 
在标头 <cmath> 定义
(1)
float       fdim ( float x, float y );

double      fdim ( double x, double y );

long double fdim ( long double x, long double y );
(C++11 起)
(C++23 前)
constexpr /* 浮点类型 */ fdim ( /* 浮点类型 */ x, /* 浮点类型 */ y );
(C++23 起)
float       fdimf( float x, float y );
(2) (C++11 起)
(C++23 起 constexpr)
long double fdiml( long double x, long double y );
(3) (C++11 起)
(C++23 起 constexpr)
在标头 <cmath> 定义
template< class Arithmetic1, class Arithmetic2 >
/* 浮点类型 */ fdim( Arithmetic1 x, Arithmetic2 y );
(A) (C++11 起)
(C++23 起 constexpr)
1-3) 返回 xy 间的正差,即在 x > y 时返回 x - y,否则(即在 x <= y 时)返回 +0标准库提供所有以无 cv 限定的浮点类型作为参数 xy 的类型的 std::fdim 重载。 (C++23 起)
A) 为算术类型的所有其他组合提供额外重载。

参数

x, y - 浮点或整数值

返回值

在成功时返回 xy 间的正差。

如果出现上溢导致的值域错误,那么返回 +HUGE_VAL+HUGE_VALF+HUGE_VALL

如果出现下溢导致的值域错误,那么返回(舍入后的)正确结果。

错误处理

报告 math_errhandling 中指定的错误。

如果实现支持 IEEE 浮点算术(IEC 60559),那么

  • 如果任一参数是 NaN ,那么返回 NaN

注意

等价于 std::fmax(x - y, 0),除了 NaN 处理要求。

额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的第一个实参 num1 和第二个实参 num2 满足以下要求:

  • 如果 num1num2 具有 long double 类型,那么 std::fdim(num1, num2)std::fdim(static_cast<long double>(num1),
              static_cast<long double>(num2))
    的效果相同。
  • 否则,如果 num1 和/或 num2 具有 double 或整数类型,那么 std::fdim(num1, num2)std::fdim(static_cast<double>(num1),
              static_cast<double>(num2))
    的效果相同。
  • 否则,如果 num1num2 具有 float 类型,那么 std::fdim(num1, num2)std::fdim(static_cast<float>(num1),
              static_cast<float>(num2))
    的效果相同。
(C++23 前)

如果 num1num2 具有算术类型,那么 std::fdim(num1, num2)std::fdim(static_cast</* 公共浮点类型 */>(num1),
          static_cast</* 公共浮点类型 */>(num2))
的效果相同,其中 /* 公共浮点类型 */num1num2 的类型中浮点转换等级浮点转换子等级最高的浮点类型,整数类型的实参被视为具有与 double 相等的浮点转换等级。

如果不存在等级和子等级最高的浮点类型,那么在重载决议时不会从提供的重载中产生可用的候选。

(C++23 起)

示例

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
#ifndef __GNUC__
#pragma STDC FENV_ACCESS ON
#endif
 
int main()
{
    std::cout << "fdim(4, 1) = " << std::fdim(4, 1)
              << " fdim(1, 4) = " << std::fdim(1, 4) << '\n'
              << "fdim(4,-1) = " << std::fdim(4, -1)
              << " fdim(1,-4) = " << std::fdim(1, -4) << '\n';
 
    // 错误处理
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "fdim(1e308, -1e308) = " << std::fdim(1e308, -1e308) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_OVERFLOW))
        std::cout << "    发生 FE_OVERFLOW\n";
}

输出:

fdim(4, 1) = 3 fdim(1, 4) = 0
fdim(4,-1) = 5 fdim(1,-4) = 5
fdim(1e308, -1e308) = inf
    errno == ERANGE: Numerical result out of range
    发生 FE_OVERFLOW

参阅

计算整数值的绝对值(|x|
(函数)
(C++11)(C++11)(C++11)
两个浮点值的较大者
(函数)