|
| 1 | +# fmaximum_num |
| 2 | +* cmath[meta header] |
| 3 | +* std[meta namespace] |
| 4 | +* function[meta id-type] |
| 5 | +* cpp26[meta cpp] |
| 6 | + |
| 7 | +```cpp |
| 8 | +namespace std { |
| 9 | + constexpr floating-point-type |
| 10 | + fmaximum_num(floating-point-type x, |
| 11 | + floating-point-type y); // (1) C++26 |
| 12 | + |
| 13 | + constexpr Promoted |
| 14 | + fmaximum_num(Arithmetic1 x, |
| 15 | + Arithmetic2 y); // (2) C++26 |
| 16 | +} |
| 17 | +``` |
| 18 | +* Promoted[italic] |
| 19 | +* Arithmetic1[italic] |
| 20 | +* Arithmetic2[italic] |
| 21 | +
|
| 22 | +## 概要 |
| 23 | +浮動小数点数型の最大値を求める。 |
| 24 | +
|
| 25 | +- (1) : 浮動小数点数型に対するオーバーロード |
| 26 | +- (2) : 算術型に対するオーバーロード (大きい精度にキャストして計算される。整数は`double`で計算される) |
| 27 | +
|
| 28 | +
|
| 29 | +同じ目的のほかの関数との比較は以下。 |
| 30 | +
|
| 31 | +| 関数名 | -0.0 と +0.0 の比較 | NaN を含む場合の挙動 | 備考 | |
| 32 | +|---|---|---|---| |
| 33 | +| [`fmax`](fmax.md) | 未規定 | NaN でない方を返す | | |
| 34 | +| [`fmaximum`](fmaximum.md) | +0.0 を返す | NaN を返す | エラー伝播を優先 | |
| 35 | +| [`fmaximum_num`](fmaximum_num.md) | +0.0 を返す | NaN でない方を返す | 数値を優先 | |
| 36 | +
|
| 37 | +
|
| 38 | +## 戻り値 |
| 39 | +引数の最大値を返す。 |
| 40 | +
|
| 41 | +
|
| 42 | +## 備考 |
| 43 | +- 戻り値は正確で、現在の丸めモードに依存しない。 |
| 44 | +- 処理系が IEC 60559 に準拠している場合([`std::numeric_limits`](../limits/numeric_limits.md)`<T>::`[`is_iec559`](../limits/numeric_limits/is_iec559.md)`() != false`)、以下の規定が追加される。 |
| 45 | + - 引数の1つが NaN の場合 NaN でない方を返す。 |
| 46 | + - 引数が2つとも NaN の場合 NaN を返す。 |
| 47 | +- `-0.0`と`+0.0`の比較では、`+0.0`を返す。 |
| 48 | +- IEEE 754 の `maximumNum` に対応する。 |
| 49 | +
|
| 50 | +
|
| 51 | +## 例 |
| 52 | +```cpp example |
| 53 | +#include <print> |
| 54 | +#include <cmath> |
| 55 | +
|
| 56 | +int main() { |
| 57 | + std::println("fmaximum_num( 0.0, -1.0) = {:+}", std::fmaximum_num(0.0, -1.0)); |
| 58 | + std::println("fmaximum_num(-0.0, +0.0) = {:+}", std::fmaximum_num(-0.0, +0.0)); |
| 59 | + std::println("fmaximum_num( 0.0, +1.0) = {:+}", std::fmaximum_num(0.0, +1.0)); |
| 60 | + std::println("fmaximum_num( 0.0, nan) = {:+}", std::fmaximum_num(0.0, std::nan(""))); |
| 61 | + std::println("fmaximum_num( nan, nan) = {:+}", std::fmaximum_num(std::nan(""), std::nan(""))); |
| 62 | +} |
| 63 | +``` |
| 64 | +* std::fmaximum_num[color ff0000] |
| 65 | +* std::nan[link nanf.md] |
| 66 | + |
| 67 | +### 出力例 |
| 68 | +``` |
| 69 | +fmaximum_num( 0.0, -1.0) = +0 |
| 70 | +fmaximum_num(-0.0, +0.0) = +0 |
| 71 | +fmaximum_num( 0.0, +1.0) = +1 |
| 72 | +fmaximum_num( 0.0, nan) = +0 |
| 73 | +fmaximum_num( nan, nan) = +nan |
| 74 | +``` |
| 75 | + |
| 76 | +## バージョン |
| 77 | +### 言語 |
| 78 | +- C++26 |
| 79 | + |
| 80 | +### 処理系 |
| 81 | +- [Clang](/implementation.md#clang): 21.0 [mark noimpl] |
| 82 | +- [GCC](/implementation.md#gcc): 15 [mark noimpl] |
| 83 | +- [Visual C++](/implementation.md#visual_cpp): 2022 Update 14 [mark noimpl] |
| 84 | + |
| 85 | + |
| 86 | +## 関連項目 |
| 87 | +- [`fmax`](fmax.md) |
| 88 | +- [`fmaximum`](fmaximum.md) |
| 89 | + |
| 90 | + |
| 91 | +## 参照 |
| 92 | +- [P3008R6 Atomic floating-point min/max](https://open-std.org/jtc1/sc22/wg21/docs/papers/2025/p3008r6.html) |
0 commit comments