isnormal.md

isnormal

• cmath[meta header]
• std[meta namespace]
• function[meta id-type]
• cpp11[meta cpp]

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

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

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

• Integral[italic]

概要

数値が正規化数(normalized value)であるか判定する。

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

戻り値

パラメータxがゼロ、非正規化数、無限大、NaNのいずれでもない場合に正規化数であると見なし、trueを返す。そうでない場合、falseを返す。

備考

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

例

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

int main()
{
  // 正規化数
  bool result_normal = std::isnormal(3.0f);
  assert(result_normal);

  // ゼロは正規化数ではない
  bool result_zero = std::isnormal(0.0f);
  assert(!result_zero);

  // 無限大は正規化数ではない
  bool result_infinity = std::isnormal(std::numeric_limits<float>::infinity());
  assert(!result_infinity);

  // NaNは正規化数ではない
  bool result_nan = std::isnormal(std::numeric_limits<float>::quiet_NaN());
  assert(!result_nan);

  if (std::numeric_limits<float>::has_denorm) {
    // 非正規化数は正規化数ではない
    bool result_denorm = std::isnormal(std::numeric_limits<float>::denorm_min());
    assert(!result_denorm);
  }
  else {
    std::cout << "非正規化数を持たない環境です" << std::endl;
  }
}

• std::isnormal[color ff0000]
• infinity()[link /reference/limits/numeric_limits/infinity.md]
• quiet_NaN()[link /reference/limits/numeric_limits/quiet_nan.md]
• has_denorm[link /reference/limits/numeric_limits/has_denorm.md]
• denorm_min()[link /reference/limits/numeric_limits/denorm_min.md]

出力

備考

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

• GCC 4.6.1 以上

バージョン

言語

• C++11

処理系

• Clang: 3.0 [mark verified]
• GCC: 4.3 [mark verified]
• ICC: ??
• Visual C++: ??

参照

• P0533R9 constexpr for <cmath> and <cstdlib>
  • C++23での、一部関数のconstexpr対応
• P1467R9 Extended floating-point types and standard names
  • C++23で導入された拡張浮動小数点数型への対応として、float、double、long doubleのオーバーロードをfloating-point-typeのオーバーロードに統合し、拡張浮動小数点数型も扱えるようにした