Namespaces
Variants

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

From cppreference.net
Common mathematical functions
Nearest integer floating point operations
(C++11)
(C++11)
(C++11) (C++11) (C++11)
Floating point manipulation functions
(C++11) (C++11)
(C++11)
(C++11)
modf
(C++11) (C++11)
(C++11)
Classification and comparison
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Types
(C++11)
(C++11)
(C++11)
Macro constants
ヘッダー <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 /* floating-point-type */

modf ( /* floating-point-type */ num,

/* floating-point-type */ * 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)
ヘッダー <cmath> で定義
template < class Integer >
double modf ( Integer num, double * iptr ) ;
(A) (C++23以降constexpr)
1-3) 与えられた浮動小数点値 num を整数部と小数部に分解し、各部分は num と同じ型と符号を持ちます。整数部(浮動小数点形式)は iptr が指すオブジェクトに格納されます。 ライブラリは、パラメータ num の型および iptr の指す型として、すべてのcv修飾されていない浮動小数点型に対する std::modf のオーバーロードを提供します。 (C++23以降)
A) すべての整数型に対して追加のオーバーロードが提供されており、これらは double として扱われます。
(C++11以降)

目次

パラメータ

num - 浮動小数点または整数値
iptr - 整数部分を格納する浮動小数点値へのポインタ

戻り値

エラーが発生しない場合、 num と同じ符号を持つ小数部を返します。整数部は iptr が指す値に格納されます。

返される値と * iptr に格納された値の和は num となります(丸め誤差を考慮)。

エラーハンドリング

この関数は math_errhandling で指定されているいかなるエラーにも影響されません。

IEEE浮動小数点演算(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 : num - (*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 << "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

関連項目

(C++11) (C++11) (C++11)
指定された値の絶対値以下の最も近い整数
(関数)