std::modf, std::modff, std::modfl

来自cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基本运算
(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)
modf
(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       modf ( float num, float* iptr );

double      modf ( double num, double* iptr );

long double modf ( long double num, long double* iptr );
(C++23 前)
constexpr /* 浮点类型 */ modf( /* 浮点类型 */ num, /* 浮点类型 */* iptr );
(C++23 起)
float       modff( float num, float* iptr );
(2) (C++11 起)
(C++23 起 constexpr)
long double modfl( long double num, long double* iptr );
(3) (C++11 起)
(C++23 起 constexpr)
额外重载 (C++11 起)
在标头 <cmath> 定义
template< class Integer >
double      modf ( Integer num, double* iptr );
(A) (C++23 起 constexpr)
1-3) 分解给定的浮点值 num 为整数和分数部分,每个都拥有与 num 相同的类型和符号。(以浮点格式)存储整数部分于 iptr 所指向的对象。标准库提供所有以无 cv 限定的浮点类型作为参数 num 的类型的 std::modf 重载。 (C++23 起)
A) 为所有整数类型提供额外重载,将它们当做 double
(C++11 起)

参数

num - 浮点或整数值
iptr - 指向要存储整数部分的目标的浮点值的指针

返回值

如果没有发生错误,那么返回与 num 相同符号的 num 小数部分。将整数部分放进 iptr 所指向的值。

将返回值与存储到 *iptr 的值相加会得到 num(允许舍入)。

错误处理

此函数不受制于任何指定于 math_errhandling 的错误。

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

  • 如果 num 是 ±0,那么返回 ±0,并将 ±0 存储到 *iptr
  • 如果 num 是 ±∞,那么返回 ±0,并将 ±∞ 存储到 *iptr
  • 如果 num 是 NaN,那么返回 NaN,并将 NaN 存储到 *iptr
  • 返回值是准确的,忽略当前舍入模式

注解

此函数表现为如同实现如下:

double modf(double num, double* iptr)
{
#pragma STDC FENV_ACCESS ON
    int save_round = std::fegetround();
    std::fesetround(FE_TOWARDZERO);
    *iptr = std::nearbyint(num);
    std::fesetround(save_round);
    return std::copysign(std::isinf(num) ? 0.0 : x - (*iptr), num);
}

额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的整数类型实参 num 确保 std::modf(num, iptr)std::modf(static_cast<double>(num), iptr) 的效果相同。

示例

比较不同的浮点分解函数:

#include <cmath>
#include <iostream>
#include <limits>
 
int main()
{
    double f = 123.45;
    std::cout << "给定数字 " << f << "(十六进制表示为 " << std::hexfloat
              << f << std::defaultfloat << "),\n";
 
    double f3;
    double f2 = std::modf(f, &f3);
    std::cout << "modf() 会把它拆分成 " << f3 << " + " << f2 << '\n';
 
    int i;
    f2 = std::frexp(f, &i);
    std::cout << "frexp() 会把它拆分成 " << f2 << " * 2^" << i << '\n';
 
    i = std::ilogb(f);
    std::cout << "logb()/ilogb() 会把它拆分成 " << f / std::scalbn(1.0, i) << " * "
              << std::numeric_limits<double>::radix
              << "^" << std::ilogb(f) << '\n';
 
    // 特殊值
    f2 = std::modf(-0.0, &f3);
    std::cout << "modf(-0) 会拆分成 " << f3 << " + " << f2 << '\n';
    f2 = std::modf(-INFINITY, &f3);
    std::cout << "modf(-Inf) 会拆分成 " << f3 << " + " << f2 << '\n';
 
}

可能的输出:

给定数字 123.45(十六进制表示为 0x1.edccccccccccdp+6),
modf() 会把它拆分成 123 + 0.45
frexp() 会把它拆分成 0.964453 * 2^7
logb()/ilogb() 会把它拆分成 1.92891 * 2^6
modf(-0) 会拆分成 -0 + -0
modf(-Inf) 会拆分成 -INF + -0

参阅

(C++11)(C++11)(C++11)
绝对值不大于给定值的最接近整数
(函数)