std::fmax, std::fmaxf, std::fmaxl

Определено в заголовочном файле `<cmath>`
float fmax ( float x, float y ); double fmax ( double x, double y ); long double fmax ( long double x, long double y );	(1)	(до C++23)
constexpr /floating-point-type/ fmax ( /floating-point-type/ x, /floating-point-type/ y );	(1)		(начиная с C++23)
float fmaxf( float x, float y );	(2)	(начиная с C++11) (constexpr начиная с C++23)
long double fmaxl( long double x, long double y );	(3)	(начиная с C++11) (constexpr начиная с C++23)
Перегрузка SIMD (начиная с C++26)
Определено в заголовочном файле `<simd>`
template< class V0, class V1 > constexpr /math-common-simd-t/<V0, V1> fmax ( const V0& v_x, const V1& v_y );	(S)	(начиная с C++26)
Дополнительные перегрузки (начиная с C++11)
Определено в заголовочном файле `<cmath>`
template< class Integer > double fmax ( Integer x, Integer y );	(A)	(constexpr начиная с C++23)

1-3) Возвращает большее из двух аргументов с плавающей точкой, считая NaN отсутствующими данными (если один аргумент — NaN, а другой — числовое значение, выбирается числовое значение). Библиотека предоставляет перегрузки std::fmax для всех типов с плавающей точкой без cv-квалификаторов в качестве типов параметров.(начиная с C++23)

S) Перегрузка SIMD выполняет поэлементное std::fmax над v_xи v_y. (Определение см. в разделе math-common-simd-t.) (начиная с C++26)

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

(начиная с C++11)

Параметры

x, y

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

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

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

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

На эту функцию не распространяются какие-либо условия ошибок, указанные в math_errhandling.

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

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

Примечания

Эта функция не обязана учитывать знак нуля, хотя некоторые реализации дополнительно гарантируют, что если один аргумент — +0, а другой — -0, то возвращается +0.

Не требуется, чтобы дополнительные перегрузки были предоставлены в точности в виде (A). Достаточно, чтобы они обеспечивали для первого аргумента num1 и второго аргумента num2 следующее:

Если num1 или num2 имеет тип longdouble, то std::fmax(num1, num2) действует так же, как std::fmax(static_cast<long double>(num1),static_cast<long double>(num2)).
В противном случае, если num1 и/или num2 имеет тип double или целочисленный тип, то std::fmax(num1, num2) действует так же, как std::fmax(static_cast<double>(num1),static_cast<double>(num2)).
В противном случае, если num1 или num2 имеет тип float, то std::fmax(num1, num2) действует так же, как std::fmax(static_cast<float>(num1),static_cast<float>(num2)).

(до C++23)

Если num1 и num2 имеют арифметические типы, то std::fmax(num1, num2) действует так же, как std::fmax(static_cast</*common-floating-point-type*/>(num1),static_cast</*common-floating-point-type*/>(num2)), где /*common-floating-point-type*/ — тип с плавающей точкой с наибольшим рангом преобразования с плавающей точкой и наибольшим подрангом преобразования с плавающей точкой среди типов num1 и num2; считается, что аргументы целочисленного типа имеют тот же ранг преобразования с плавающей точкой, что и double.

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

(начиная с C++23)

Пример

#include <cmath>
#include <iostream>

int main()
{
    std::cout << "fmax(2,1)    = " << std::fmax(2, 1) << '\n'
              << "fmax(-Inf,0) = " << std::fmax(-INFINITY, 0) << '\n'
              << "fmax(NaN,-1) = " << std::fmax(NAN, -1) << '\n';
}

Вывод:

fmax(2,1)    = 2
fmax(-Inf,0) = 0
fmax(NaN,-1) = -1

См. также

isgreater (C++11)	проверяет, больше ли первый аргумент с плавающей точкой второго (функция)
fminfminffminl (C++11)(C++11)(C++11)	меньшее из двух значений с плавающей точкой (функция)
max	возвращает большее из заданных значений (шаблон функции и функциональный объект алгоритма)
ranges::max (C++20)
max_element	возвращает наибольший элемент в диапазоне (шаблон функции и функциональный объект алгоритма)
ranges::max_element (C++20)
minmax (C++11)	возвращает меньший и больший из двух элементов (шаблон функции и функциональный объект алгоритма)
ranges::minmax (C++20)
minmax_element (C++11)	возвращает наименьший и наибольший элементы в диапазоне (шаблон функции и функциональный объект алгоритма)
ranges::minmax_element (C++20)
Документация C для `fmax`

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