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

Определено в заголовке `<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 /* floating-point-type / fdim ( / floating-point-type / x, / floating-point-type */ y );		(с C++23)
float fdimf( float x, float y );	(2)	(с C++11) (constexpr с C++23)
long double fdiml( long double x, long double y );	(3)	(с C++11) (constexpr с C++23)
Дополнительные перегрузки (с C++11)
Определено в заголовке `<cmath>`
template< class Integer > double fdim ( Integer x, Integer y );	(A)	(constexpr с C++23)

1-3) Возвращает положительную разницу между x и y, то есть, если x > y, возвращает x - y, в противном случае (т. е. если x <= y) возвращает +0. Библиотека предоставляет перегрузки std::fdim для всех типов с плавающей точкой без cv-квалификаторов в качестве типа параметров.(с C++23)

A) Дополнительные перегрузки предоставляются для всех целочисленных типов, которые обрабатываются как double.

(с C++11)

Параметры

x, y

значения с плавающей точкой или целые значения

Возвращаемое значение

При успешном выполнении возвращает положительную разницу между x и y.

Если происходит ошибка диапазона из-за переполнения, возвращается +HUGE_VAL, +HUGE_VALF, или +HUGE_VALL.

Если происходит ошибка диапазона из-за потери значимости, возвращается правильное значение (после округления).

Обработка ошибок

Ошибки сообщаются в соответствии со спецификацией math_errhandling.

Если реализация поддерживает арифметику с плавающей точкой IEEE (IEC 60559),

Если любой из аргументов является NaN, возвращается NaN.

Примечания

Эквивалентно std::fmax(x - y, 0), за исключением требований к обработке NaN.

Дополнительные перегрузки не обязаны предоставляться точно как (A). Они должны быть достаточны для того, чтобы для их первого аргумента num1 и второго аргумента 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</* common-floating-point-type */>(num1), static_cast</* common-floating-point-type */>(num2)), где /* common-floating-point-type */ — тип с плавающей точкой с наибольшим рангом преобразования с плавающей точкой и наибольшим подрангом преобразования с плавающей точкой между типами num1 и num2, аргументы целочисленного типа считаются имеющими тот же ранг преобразования с плавающей точкой, что и double.

Если такого типа с плавающей точкой с наибольшим рангом и подрангом не существует, тогда разрешение перегрузок не приводит к пригодной кандидатуре из предоставленных перегрузок.

(с C++23)

Пример

#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

См. также

abs(int)labsllabs (C++11)	вычисляет абсолютное значение целочисленного значения (\(\small{\|x\|}\)\|x\|) (функция)
fmaxfmaxffmaxl (C++11)(C++11)(C++11)	большее из двух значений с плавающей точкой (функция)
C документация для `fdim`

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/numeric/math/fdim