4. signbit

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

履歴 編集

function
<cmath>

std::signbit(C++11)

namespace std {
  bool signbit(float x);            // (1) C++11からC++20まで
  bool signbit(double x);           // (2) C++11からC++20まで
  bool signbit(long double x);      // (3) C++11からC++20まで

  constexpr bool
    signbit(floating-point-type x); // (4) C++23

  bool
    signbit(Integral x);            // (5) C++11
  constexpr bool
    signbit(Integral x);            // (5) C++23
}

概要

数値の符号が負であるか判定する。

戻り値

パラメータxが負数である場合、trueを返す。そうでない場合、falseを返す。

この関数はその名前の通り、浮動小数点数の符号ビットを検出する。そのため、NaNの符号を検出することができる。
他にはstd::copysignでも検出でき、この2つのみがNaNの符号を検出できる移植性のある方法となる。

備考

  • C標準ライブラリではsignbitは関数マクロとして定義されるが、C++標準ライブラリでは関数として定義される
  • C++23では、(1), (2), (3)が(4)に統合され、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

例

#include <iostream>
#include <cmath>
#include <limits>

int main()
{
  // 通常の数値
  std::cout << std::boolalpha;
  std::cout << "-1.0f : " << std::signbit(-1.0f) << std::endl;
  std::cout << "-0.0f : " << std::signbit(-0.0f) << std::endl;

  std::cout << "1.0f  : " << std::signbit(1.0f) << std::endl;
  std::cout << "0.0f  : " << std::signbit(0.0f) << std::endl;

  // 無限大
  const double inf = std::numeric_limits<double>::infinity();
  std::cout << "inf   : " << std::signbit(inf) << std::endl;
  std::cout << "-inf  : " << std::signbit(-inf) << std::endl;

  // NaN (Not a Number)
  // NaNの符号ビットも検出できる
  const double nan = std::numeric_limits<double>::quiet_NaN();
  std::cout << "nan   : " << std::signbit(nan) << std::endl;
  std::cout << "-nan  : " << std::signbit(-nan) << std::endl;
}

出力

-1.0f : true
-0.0f : true
1.0f  : false
0.0f  : false
inf   : false
-inf  : true
nan   : false
-nan  : true

備考

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

  • GCC 4.6.1 以上

バージョン

言語

  • C++11

処理系

参照