std::modf, std::modff, std::modfl
From cppreference.com
| ヘッダー <cmath> で定義 |
||
| (1) | ||
float modf ( float num, float* iptr ); double modf ( double num, double* iptr ); |
(C++23まで) | |
| constexpr /* floating-point-type */ modf ( /* 浮動小数点型 */ num, |
(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 が指すオブジェクトに格納されます。ライブラリは、パラメータ num および iptr が指す型のすべての cv 修飾されていない浮動小数点型に対する
std::modf のオーバーロードを提供します。(since C++23)|
A) すべての整数型に対する追加のオーバーロードが提供されます。これらは double として扱われます。
|
(C++11以降) |
目次 |
[編集] Parameters
| num | - | 浮動小数点数または整数値 |
| iptr | - | 整数部を格納する浮動小数点値へのポインタ |
[編集] Return value
エラーが発生しない場合、num と同じ符号を持つ num の小数部を返します。整数部は *iptr が指す値に格納されます。
返された値と *iptr に格納された値の合計は num になります(丸め誤差を許容)。
[編集] Error handling
この関数は、math_errhandlingで指定されているエラーの対象とはならない。
実装がIEEE浮動小数点算術 (IEC 60559) をサポートしている場合、
- num が ±0 の場合、±0 を返し、*iptr に ±0 を格納します。
- num が ±∞ の場合、±0 を返し、*iptr に ±∞ を格納します。
- num が NaN の場合、NaN を返し、*iptr に NaN を格納します。
- 返される値は正確であり、現在の丸めモードは無視されます。
[編集] Notes
この関数は、以下のように実装されたかのように動作します。
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 : num - (*iptr), num); }
追加のオーバーロードは (A) とまったく同じように提供される必要はありません。整数型の引数 num に対して、 std::modf(num, iptr) が std::modf(static_cast<double>(num), iptr) と同じ効果を持つことを保証するだけで十分です。
[編集] Example
異なる浮動小数点分解関数を比較します。
このコードを実行
#include <cmath> #include <iostream> #include <limits> int main() { double f = 123.45; std::cout << "Given the number " << f << " or " << std::hexfloat << f << std::defaultfloat << " in hex,\n"; double f3; double f2 = std::modf(f, &f3); std::cout << "modf() makes " << f3 << " + " << f2 << '\n'; int i; f2 = std::frexp(f, &i); std::cout << "frexp() makes " << f2 << " * 2^" << i << '\n'; i = std::ilogb(f); std::cout << "logb()/ilogb() make " << f / std::scalbn(1.0, i) << " * " << std::numeric_limits<double>::radix << "^" << std::ilogb(f) << '\n'; // special values f2 = std::modf(-0.0, &f3); std::cout << "modf(-0) makes " << f3 << " + " << f2 << '\n'; f2 = std::modf(-INFINITY, &f3); std::cout << "modf(-Inf) makes " << f3 << " + " << f2 << '\n'; }
実行結果の例
Given the number 123.45 or 0x1.edccccccccccdp+6 in hex, modf() makes 123 + 0.45 frexp() makes 0.964453 * 2^7 logb()/ilogb() make 1.92891 * 2^6 modf(-0) makes -0 + -0 modf(-Inf) makes -INF + -0
[編集] See also
| (C++11)(C++11)(C++11) |
与えられた値の絶対値以下の最大の整数 (関数) |
| C documentation for modf
| |