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

来自cppreference.com
< cpp‎ | numeric‎ | math
 
C++
 
数值库
 
常用数学函数
函数
基础运算
(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)
(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++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)
SIMD 重载 (C++26 起)
在标头 <simd> 定义
template< class V0, class V1 >

constexpr /*math-common-simd-t*/<V0, V1>

            fdim ( const V0& v_x, const V1& v_y );
 (S) (C++26 起)
额外重载 (C++11 起)
在标头 <cmath> 定义
template< class Integer >
double      fdim ( Integer x, Integer y );
 (A) (C++23 起为 constexpr)
1-3) 返回 x 与 y 间的正差，即在 x > y 时返回 x - y，否则（即在 x <= y 时）返回 +0。标准库提供所有以无 cv 限定的浮点数类型作为各形参的类型的 std::fdim 重载。(C++23 起)
S) SIMD 重载对 v_x和 v_y 实施逐元素 std::fdim。
（参见 math-common-simd-t 的定义。）
(C++26 起)
A) 为所有整数类型提供额外重载，将它们当做 double。
 (C++11 起)

目录

[编辑] 参数

x, y - 浮点数或整数

[编辑] 返回值

在成功时返回 x 与 y 间的正差。

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

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

[编辑] 错误处理

报告 math_errhandling 中指定的错误。

如果实现支持 IEEE 浮点数算术（IEC 60559），那么

  • 如果任一实参是 NaN，那么返回 NaN

[编辑] 注解

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

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

  • 如果 num1 或 num2 具有 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))     的效果相同。
  • 否则，如果 num1 或 num2 具有 float 类型，那么 std::fdim(num1, num2) 和 std::fdim(static_cast<float>(num1),
              static_cast<float>(num2))     的效果相同。
(C++23 前)

如果 num1 和 num2 具有算术类型，那么 std::fdim(num1, num2) 和 std::fdim(static_cast</*公共浮点数类型*/>(num1),
          static_cast</*公共浮点数类型*/>(num2)) 的效果相同，其中 /*公共浮点数类型*/ 是 num1 和 num2 的类型中浮点数转换等级和浮点数转换子等级最高的浮点数类型，整数类型的实参被视为具有与 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) << '\n'
              << "fdim(1, 4) = " << std::fdim(1, 4) << '\n'
              << "fdim(4,-1) = " << std::fdim(4, -1) << '\n'
              << "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

[编辑] 参阅

(C++11)
 计算整数的绝对值（|x|）
(函数) [编辑]
(C++11)
 两个浮点数的较大者
(函数) [编辑]
fdim 的 C 文档
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/numeric/math/fdim&oldid=95853”