std::fdim, std::fdimf, std::fdiml

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

数値ライブラリ

共通の数学関数
数学特殊関数 (C++17)
数学定数 (C++20)
基本的な線形代数アルゴリズム (C++26)
データ並列型 (SIMD) (C++26)
浮動小数点環境 (C++11)
複素数
数値配列 (valarray)
擬似乱数生成
ビット操作 (C++20)
因数操作
gcd (C++17)	lcm (C++17)
補間
midpoint (C++20)	lerp (C++20)
飽和演算
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
汎用数値演算
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference    partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)

 

共通の数学関数

関数
基本的な数学関数
abs(int)labsllabsimaxabs (C++11)   abs(float)fabs divldivlldivimaxdiv (C++11)	fmod remainder (C++11)   remquo (C++11) fma (C++11) fmax (C++11) fmin (C++11) fdim (C++11) nannanfnanl (C++11)(C++11)(C++11)
指数関数
exp exp2 (C++11) expm1 (C++11)	log log10 log1p (C++11) log2 (C++11)
べき乗関数
sqrt cbrt (C++11)	hypot (C++11) pow
三角関数と 双曲線関数
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)
誤差関数とガンマ関数
erf (C++11) erfc (C++11)	lgamma (C++11) tgamma (C++11)

最近接整数への浮動小数点数操作
ceil floor roundlroundllround (C++11)(C++11)(C++11)	trunc (C++11) nearbyint (C++11) rintlrintllrint (C++11)(C++11)(C++11)
浮動小数点数の操作関数
ldexp scalbnscalbln (C++11)(C++11) ilogb (C++11) logb (C++11)	frexp modf nextafternexttoward (C++11)(C++11) copysign (C++11)
分類と比較
fpclassify (C++11) isfinite (C++11) isinf (C++11) isnan (C++11) isnormal (C++11) signbit (C++11)	isgreater (C++11) isgreaterequal (C++11) isless (C++11) islessequal (C++11) islessgreater (C++11) isunordered (C++11)
型
div_t ldiv_t lldiv_t (C++11)	imaxdiv_t (C++11) float_t (C++11) double_t (C++11)
マクロ定数
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)   INFINITY (C++11) NAN (C++11)	分類 FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

ヘッダー <cmath> で定義
	(1)
float       fdim ( float x, float y ); double      fdim ( double x, double y ); long double fdim ( long double x, long double y );			(C++23まで)
constexpr /*浮動小数点数型*/             fdim ( /*浮動小数点型*/ x,                    /*浮動小数点型*/ y );			(C++23から)
float       fdimf( float x, float y );		(2)	(C++11以降) (C++23 以降 constexpr)
long double fdiml( long double x, long double y );		(3)	(C++11以降) (C++23 以降 constexpr)
SIMDオーバーロード (C++26以降)
ヘッダー <simd> で定義
template< class V0, class V1 > constexpr /*math-common-simd-t*/<V0, V1>             fdim ( const V0& v_x, const V1& v_y );		(S)	(C++26以降)
追加のオーバーロード (C++11以降)
ヘッダー <cmath> で定義
template< class Integer > double      fdim ( Integer x, Integer y );		(A)	(C++23 以降 constexpr)

1-3) xとyの正の差を返します。つまり、x > yの場合はx - yを返し、それ以外の場合（x <= yの場合）は+0を返します。ライブラリは、パラメータの型として、すべての cv-unqualified 浮動小数点型に対する std::fdim のオーバーロードを提供します。(C++23以降)

S) SIMDオーバーロードは、v_xとv_yに対して要素ごとのstd::fdimを実行します。 (定義についてはmath-common-simd-tを参照のこと)

(C++26以降)

A) すべての整数型に対する追加のオーバーロードが提供されます。これらは double として扱われます。

(C++11以降)

Parameters

x, y

-

浮動小数点または整数値

Return value

成功した場合、xとyの正の差を返します。

オーバーフローによる範囲エラーが発生した場合、+HUGE_VAL、+HUGE_VALF、または +HUGE_VALL が返されます。

アンダーフローによる範囲エラーが発生した場合、（丸め後の）正しい値を返します。

Error handling

エラーは math_errhandling で指定された通りに報告される。

実装がIEEE浮動小数点算術 (IEC 60559) をサポートしている場合、

• いずれかの引数が NaN の場合、NaN が返されます。

Notes

NaNの処理要件を除いて、std::fmax(x - y, 0) と同等です。

追加のオーバーロードは (A) とまったく同じように提供される必要はない。それらは、最初の引数 num1 と2番目の引数 num2 に対して以下を保証するのに十分である必要がある。

num1またはnum2の型がlong doubleの場合、std::fdim(num1, num2)はstd::fdim(static_cast<long double>(num1),           static_cast<long double>(num2))と同じ効果を持ちます。 それ以外の場合、num1および/またはnum2の型がdoubleまたは整数型の場合、std::fdim(num1, num2)はstd::fdim(static_cast<double>(num1),           static_cast<double>(num2))と同じ効果を持ちます。 それ以外の場合、num1またはnum2の型がfloatの場合、std::fdim(num1, num2)はstd::fdim(static_cast<float>(num1),           static_cast<float>(num2))と同じ効果を持ちます。

(C++23まで)

num1とnum2が算術型の場合、std::fdim(num1, num2)はstd::fdim(static_cast</*共通浮動小数点型*/>(num1),           static_cast</*共通浮動小数点型*/>(num2))と同じ効果を持ちます。ここで、/*共通浮動小数点型*/は、num1とnum2の型の間で、最も高い浮動小数点変換ランクと最も高い浮動小数点変換サブランクを持つ浮動小数点型です。整数型の引数は、doubleと同じ浮動小数点変換ランクを持つとみなされます。 そのような最高のランクとサブランクセを持つ浮動小数点型が存在しない場合、オーバーロード解決は提供されたオーバーロードから使用可能な候補を導出しません。

(C++23から)

Example

このコードを実行

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
#ifndef __GNUC__
#pragma STDC FENV_ACCESS ON
#endif
 
int main()
{
    std::cout << "fdim(4, 1) = " << std::fdim(4, 1) << '\n'
              << "fdim(1, 4) = " << std::fdim(1, 4) << '\n'
              << "fdim(4,-1) = " << std::fdim(4, -1) << '\n'
              << "fdim(1,-4) = " << std::fdim(1, -4) << '\n';
 
    // error handling 
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "fdim(1e308, -1e308) = " << std::fdim(1e308, -1e308) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_OVERFLOW))
        std::cout << "    FE_OVERFLOW raised\n";
}

出力

fdim(4, 1) = 3
fdim(1, 4) = 0
fdim(4,-1) = 5
fdim(1,-4) = 5
fdim(1e308, -1e308) = inf
    errno == ERANGE: Numerical result out of range
    FE_OVERFLOW raised

See also

abs(int)labsllabs (C++11)	整数値の絶対値を計算する (\(\small{|x|}\)|x|) (関数)
fmaxfmaxffmaxl (C++11)(C++11)(C++11)	2つの浮動小数点数値のうち大きい方 (関数)
Cドキュメント fdim