4. ldexp

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

履歴 編集

function
<cmath>

std::ldexp

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

  constexpr floating-point-type
    ldexp(floating-point-type x, int exp);      // (4) C++23

  double
    ldexp(Integral x, int exp);                 // (5) C++11
  constexpr double
    ldexp(Integral x, int exp);                 // (5) C++23

  float
    ldexpf(float x, int exp);                   // (6) C++17
  constexpr float
    ldexpf(float x, int exp);                   // (6) C++23

  long double
    ldexpl(long double x, int exp);             // (7) C++17
  constexpr long double
    ldexpl(long double x, int exp);             // (7) C++23
}

概要

ldexp関数 (load exponent)は、xに2のexp乗を掛けた値を計算する。

この関数は、ビット操作をすることなく、仮数部と指数部を指定して浮動小数点の値を作り出すために使用できる。第1引数xに仮数部、第2引数expに指数部の値をそれぞれ設定することで、それらの要素を持つ浮動小数点数が返される。

この関数と反対に、std::frexp()関数を使用することで、浮動小数点数を仮数部と指数部に分解できる。

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

戻り値

x * 2exp

オーバーフローエラー、アンダーフローエラーが発生する可能性がある。

備考

  • オーバーフローエラー、アンダーフローエラーが発生した場合の挙動については、<cmath> を参照。
  • C++11 以降では、処理系が IEC 60559 に準拠している場合（std::numeric_limits<T>::is_iec559() != false）、かつ、基数が 2 の場合（std::numeric_limits<T>::radix() == 2）、scalbn(x, exp) と等価である。
  • C++23では、(1)、(2)、(3)が(4)に統合され、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

例

#include <iostream>
#include <iomanip>
#include <cmath>

int main()
{
  // 3.0 * (2^4)
  double result = std::ldexp(3.0, 4);
  std::cout << result << std::endl;

  // 円周率
  double pi = std::ldexp(std::acos(0.0), 1);
  std::cout << std::setprecision(8) << pi << std::endl;
}

出力

48
3.1415927

備考

特定の環境では、早期に constexpr 対応されている場合がある：

  • GCC 4.6.1 以上

実装例

namespace std {
  double ldexp(double x, int exp)
  {
    return x * std::pow(2.0, exp);
  }

  float ldexp(float x, int exp)
  {
    return x * std::pow(2.0f, exp);
  }

  long double ldexp(long double x, int exp)
  {
    return x * std::pow(2.0L, exp);
  }
}

参照