Namensräume
Varianten
Aktionen

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

Von cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
 
Definiert in der Header-Datei <cmath>
(1)
float       fmax ( float x, float y );

double      fmax ( double x, double y );

long double fmax ( long double x, long double y );
(bis C++23)
constexpr /*Gleitkommazahl-Typ*/

            fmax ( /*Gleitkommazahl-Typ*/ x,

                   /* Gleitkommazahl-Typ */ y );
(seit C++23)
float       fmaxf( float x, float y );
(2) (seit C++11)
(constexpr seit C++23)
long double fmaxl( long double x, long double y );
(3) (seit C++11)
(constexpr seit C++23)
SIMD-Überladung (seit C++26)
Definiert im Header <simd>
template< class V0, class V1 >

constexpr /*math-common-simd-t*/<V0, V1>

            fmax ( const V0& v_x, const V1& v_y );
(S) (seit C++26)
Definiert in der Header-Datei <cmath>
template< class Integer >
double      fmax ( Integer x, Integer y );
(A) (constexpr seit C++23)
1-3) Gibt das größere von zwei Gleitkommazahlen-Argumenten zurück, wobei NaNs als fehlende Daten behandelt werden (zwischen einem NaN und einem numerischen Wert wird der numerische Wert gewählt). Die Bibliothek stellt Überladungen von std::fmax für alle cv-unqualifizierten Gleitkommazahlen-Typen als Parametertypen bereit.(seit C++23)
S) Die SIMD-Überladung führt ein elementweises std::fmax auf v_x und v_y durch.
(Siehe math-common-simd-t für dessen Definition.)
(seit C++26)
A) Zusätzliche Überladungen werden für alle ganzzahligen Typen bereitgestellt, die als double behandelt werden.
(seit C++11)

Inhalt

[edit] Parameter

x, y - Gleitkomma- oder Ganzzahlwerte

[edit] Rückgabewert

Bei Erfolg wird der größere der beiden Gleitkommazahlen-Werte zurückgegeben. Der zurückgegebene Wert ist exakt und hängt von keinen Rundungsmodi ab.

[edit] Fehlerbehandlung

Diese Funktion unterliegt keinen der in math_errhandling spezifizierten Fehlerbedingungen.

Wenn die Implementierung IEEE-Gleitkomma-Arithmetik (IEC 60559) unterstützt,

  • Wenn eines der beiden Argumente NaN ist, wird der Wert des anderen Arguments zurückgegeben.
  • Nur wenn beide Argumente NaN sind, wird NaN zurückgegeben.

[edit] Anmerkungen

Diese Funktion muss nicht empfindlich auf das Vorzeichen von Null reagieren, obwohl einige Implementierungen zusätzlich sicherstellen, dass, wenn ein Argument +0 und das andere -0 ist, +0 zurückgegeben wird.

Die zusätzlichen Überladungen müssen nicht exakt wie (A) angegeben werden. Sie müssen nur ausreichen, um sicherzustellen, dass für ihr erstes Argument num1 und ihr zweites Argument num2

  • Wenn num1 oder num2 vom Typ long double ist, hat std::fmax(num1, num2) den gleichen Effekt wie std::fmax(static_cast<long double>(num1),
              static_cast<long double>(num2))
    .
  • Andernfalls, wenn num1 und/oder num2 vom Typ double oder einem Ganzzahltyp ist, hat std::fmax(num1, num2) den gleichen Effekt wie std::fmax(static_cast<double>(num1),
              static_cast<double>(num2))
    .
  • Andernfalls, wenn num1 oder num2 vom Typ float ist, hat std::fmax(num1, num2) den gleichen Effekt wie std::fmax(static_cast<float>(num1),
              static_cast<float>(num2))
    .
(bis C++23)

Wenn num1 und num2 arithmetische Typen haben, hat std::fmax(num1, num2) den gleichen Effekt wie std::fmax(static_cast</*gemeinsamer-Gleitkommazahl-Typ*/>(num1),
          static_cast</*gemeinsamer-Gleitkommazahl-Typ*/>(num2))
, wobei /*gemeinsamer-Gleitkommazahl-Typ*/ der Gleitkommazahl-Typ mit dem höchsten Gleitkommazahl-Konversionsrang und dem höchsten Gleitkommazahl-Konversions-Subrang zwischen den Typen von num1 und num2 ist. Argumente vom Ganzzahltyp werden so betrachtet, als hätten sie den gleichen Gleitkommazahl-Konversionsrang wie double.

Wenn kein solcher Gleitkommazahltyp mit dem höchsten Rang und Subrang existiert, dann führt die Überladungsauflösung nicht zu einem nutzbaren Kandidaten aus den bereitgestellten Überladungen.

(seit C++23)

[edit] Beispiel

#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';
}

Ausgabe

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

[edit] Siehe auch

(C++11)
prüft, ob das erste Gleitkommaargument größer ist als das zweite
(Funktion) [bearbeiten]
(C++11)(C++11)(C++11)
kleinerer von zwei Gleitkommawerten
(Funktion) [bearbeiten]
Gibt den größeren der beiden Werte zurück
(Funktionstemplate) [edit]
Gibt das größte Element in einem Bereich zurück
(Funktionstemplate) [edit]
(C++11)
gibt die kleinere und größere von zwei Elementen zurück
(Funktionsvorlage) [editieren]
gibt das kleinste und das größte Element in einem Bereich zurück
(Funktionsvorlage) [editieren]
C-Dokumentation für fmax