C++ 参考手册

位置：首页 > C++ 参考手册 >数值库 >常用数学函数 > std::fma, std::fmaf, std::fmal

std::fma, std::fmaf, std::fmal

定义于头文件 <cmath>
float       fma ( float x, float y, float z );
float       fmaf( float x, float y, float z );
 (1) (C++11 起)
double      fma ( double x, double y, double z );
 (2) (C++11 起)
long double fma ( long double x, long double y, long double z );
long double fmal( long double x, long double y, long double z );
 (3) (C++11 起)
Promoted    fma ( Arithmetic1 x, Arithmetic2 y, Arithmetic3 z );
 (4) (C++11 起)
#define FP_FAST_FMA  /* implementation-defined */
 (5) (C++11 起)
#define FP_FAST_FMAF /* implementation-defined */
 (6) (C++11 起)
#define FP_FAST_FMAL /* implementation-defined */
 (7) (C++11 起)
1-3) 计算 (x*y) + z ，如同用无限精度，而仅舍入一次到结果类型。
4) 所有 1-3) 所不覆盖的算术类型参数组合的重载集或函数模板。若任何参数拥有整数类型，则将它转型为 double 。若任何其他参数为 long double ，则返回类型为 long double ，否则为 double 。
5-7) 若定义宏常量 FP_FAST_FMAF 、 FP_FAST_FMA 或 FP_FAST_FMAL ，则函数 std::fma 分别求值快于（并且精度高于） float 、 double 和 long double 参数的表达式 x*y+z 。若定义，则这些宏求值为整数 1 。

参数

x, y, z - 浮点或整数类型值

返回值

若成功，则返回 (x*y) + z 的值，如同计算为无限精度再舍入一次以适合目标类型（或者说是作为单次三元浮点运算计算）。

若出现上溢所致的值域错误，则返回 ±HUGE_VAL 、 ±HUGE_VALF 或 ±HUGE_VALL 。

若出现下溢所致的值域错误，则返回（舍入后的）正确结果。

错误处理

报告 math_errhandling 中指定的错误。

若实现支持 IEEE 浮点算术（ IEC 60559 ），则

  • 若 x 为零而 y 为无穷大或 x 为无穷大而 y 为零，且 z 非 NaN ，则返回 NaN 并引发 FE_INVALID
  • 若 x 为零而 y 为无穷大或 x 为无穷大而 y 为零，且 z 为 NaN ，则返回 NaN 并可能引发 FE_INVALID
  • 若 x*y 为准确的无穷大且 z 为带相反符号的无穷大，则返回 NaN 并引发 FE_INVALID
  • 若 x 或 y 为 NaN ，则返回 NaN
  • 若 z 为 NaN ，且 x*y 不是 0*Inf 或 Inf*0 ，则返回 NaN （而无 FE_INVALID ）

注意

此运算经常在硬件中实现为融合乘加 CPU 指令。若硬件支持，则期待定义相应的 FP_FAST_FMA* 宏，但多数实现即使在不定义这些宏时也利用该 CPU 指令。

POSIX 另外指定被指定为返回 FE_INVALID 的情形是定义域错误。

由于其无限的中间精度， fma 是其他正确舍入数学运算，如 std::sqrt 或甚至除法（在 CPU 不支持的平台上，例如 Itanium ）的常用构建块。

同所有浮点表达式，表达式 (x*y) + z 可编译为融合乘加，除非 #pragma STDC FP_CONTRACT 为关闭。

示例

运行此代码
#include <iostream>
#include <iomanip>
#include <cmath>
#include <cfenv>
#pragma STDC FENV_ACCESS ON
int main()
{
    // 演示 fma 与内建运算符间的差别
    double in = 0.1;
    std::cout << "0.1 double is " << std::setprecision(23) << in
              << " (" << std::hexfloat << in << std::defaultfloat << ")\n"
              << "0.1*10 is 1.0000000000000000555112 (0x8.0000000000002p-3), "
              << "or 1.0 if rounded to double\n";
    double expr_result = 0.1 * 10 - 1;
    double fma_result = fma(0.1, 10, -1);
    std::cout << "0.1 * 10 - 1 = " << expr_result
              << " : 1 subtracted after intermediate rounding\n"
              << "fma(0.1, 10, -1) = " << std::setprecision(6) << fma_result << " ("
              << std::hexfloat << fma_result << std::defaultfloat << ")\n\n";
 
    // fma 用于 double-double 算术
    double high = 0.1 * 10;
    double low = fma(0.1, 10, -high);
    std::cout << "in double-double arithmetic, 0.1 * 10 is representable as "
              << high << " + " << low << "\n\n";
 
    // 错误处理
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "fma(+Inf, 10, -Inf) = " << std::fma(INFINITY, 10, -INFINITY) << '\n';
    if(std::fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

可能的输出： 

0.1 double is 0.10000000000000000555112 (0x1.999999999999ap-4)
0.1*10 is 1.0000000000000000555112 (0x8.0000000000002p-3), or 1.0 if rounded to double
0.1 * 10 - 1 = 0 : 1 subtracted after intermediate rounding
fma(0.1, 10, -1) = 5.55112e-17 (0x1p-54)
 
in double-double arithmetic, 0.1 * 10 is representable as 1 + 5.55112e-17
 
fma(+Inf, 10, -Inf) = -nan
    FE_INVALID raised

参阅

(C++11)(C++11)(C++11)
 除法运算的有符号余数
(函数)
(C++11)(C++11)(C++11)
 除法运算的有符号余数和最后三个二进制位
(函数)