4. frexp

最終更新日時(UTC):
が更新

履歴 編集

function
<cmath>

std::frexp

namespace std {
  float frexp(float value, int* exp);             // (1) C++03からC++20まで
  double frexp(double value, int* exp);           // (2) C++03からC++20まで
  long double frexp(long double value, int* exp); // (3) C++03からC++20まで

  constexpr floating-point-type
    frexp(floating-point-type value, int* exp);   // (4) C++23

  double
    frexp(Integral value, int* exp);              // (5) C++11
  constexpr double
    frexp(Integral value, int* exp);              // (5) C++23

  float
    frexpf(float value, int* exp);                // (6) C++17
  constexpr float
    frexpf(float value, int* exp);                // (6) C++23

  long double
    frexpl(long double value, int* exp);          // (7) C++17
  constexpr long double
    frexpl(long double value, int* exp);          // (7) C++23
}

概要

frexp関数 (fraction and exponent) は、浮動小数点数valueを、正規化された仮数部と 2 の累乗へ分解する。

この関数は、与えられた浮動小数点数valueを仮数部と指数部に分解し、仮数部を戻り値で返し、指数を*expに書き込んで返す。

この関数と反対に、std::ldexp()関数を使用することで、仮数部と指数部の値から浮動小数点数を作り出せる。

  • (1) : floatに対するオーバーロード
  • (2) : doubleに対するオーバーロード
  • (3) : long doubleに対するオーバーロード
  • (4) : 浮動小数点数型に対するオーバーロード
  • (5) : 整数型に対するオーバーロード (doubleにキャストして計算される)
  • (6) : float型規定
  • (7) : long double型規定

戻り値

引数 value が浮動小数点数ではない、もしくは2の乗数が int の範囲外である場合、戻り値は未規定。

そうでない場合、戻り値を x とすると x の絶対値は [1/2, 1) の範囲もしくはゼロとなり、*exp は value = x * 2*exp となるように設定される。

value がゼロの場合は、戻り値と *exp に書き込む値はどちらもゼロとなる。

備考

C++11 以降では、処理系が IEC 60559 に準拠している場合（std::numeric_limits<T>::is_iec559() != false）、以下の規定が追加される。（複号同順）

  • value = ±0 の場合、戻り値は ±0 となり、*exp にはゼロが設定される。
  • value = ±∞ の場合、戻り値は ±∞ となり、*exp には未規定の値が設定される。
  • value が NaN の場合、戻り値は NaN となり、*exp には未規定の値が設定される。
  • この関数は浮動小数点例外を発生させない。
  • C++23では、(1)、(2)、(3)が(4)に統合され、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

例

#include <iostream>
#include <cmath>

int main()
{
  double value = 48.0;

  int exp = 0;
  double x = std::frexp(value, &exp);

  std::cout << value << " = " << x << " * 2^" << exp << std::endl;
}

出力例

48 = 0.75 * 2^6

参照