std::fmin,std::fminf,std::fminl (3) - Linux Manuals

std::fmin,std::fminf,std::fminl: std::fmin,std::fminf,std::fminl

NAME

std::fmin,std::fminf,std::fminl - std::fmin,std::fminf,std::fminl

Synopsis

Defined in header <cmath>
float fmin ( float x, float y ); (1) (since C++11)
float fminf( float x, float y );
double fmin ( double x, double y ); (2) (since C++11)
long double fmin ( long double x, long double y ); (3) (since C++11)
long double fminl( long double x, long double y );
Promoted fmin ( Arithmetic x, Arithmetic y ); (4) (since C++11)

1-3) Returns the smaller of two floating point arguments, treating NaNs as missing data (between a NaN and a numeric value, the numeric value is chosen)
4) A set of overloads or a function template for all combinations of arguments of arithmetic_type not covered by 1-3). If any argument has integral_type, it is cast to double. If any other argument is long double, then the return type is long double, otherwise it is double.

Parameters

x, y - values of floating-point or integral_types

Return value

If successful, returns the smaller of two floating point values. The value returned is exact and does not depend on any rounding modes.

Error handling

This function is not subject to any of the error conditions specified in math_errhandling.
If the implementation supports IEEE floating-point arithmetic (IEC 60559),

* If one of the two arguments is NaN, the value of the other argument is returned
* Only if both arguments are NaN, NaN is returned

Notes

This function is not required to be sensitive to the sign of zero, although some implementations additionally enforce that if one argument is +0 and the other is -0, then -0 is returned.

Example

// Run this code

  #include <iostream>
  #include <cmath>

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

Possible output:

  fmin(2,1) = 1
  fmin(-Inf,0) = -inf
  fmin(NaN,-1) = -1