Edit

Share via


fmin, fminf, fminl

Determines the smaller of the two specified values.

Syntax

double fmin(
   double x,
   double y
);

float fmin(
   float x,
   float y
); //C++ only

long double fmin(
   long double x,
   long double y
); //C++ only

float fminf(
   float x,
   float y
);

long double fminl(
   long double x,
   long double y
);

#define fmin(x) // Requires C11 or higher

Parameters

x
The first value to compare.

y
The second value to compare.

Return value

If successful, returns the smaller of x or y.

Input Result
x is NaN y
y is NaN x
x and y are NaN NaN

The function doesn't cause _matherr to be invoked, cause any floating-point exceptions, or change the value of errno.

Remarks

Because C++ allows overloading, you can call overloads of fmin that take and return float and long double types. In a C program, unless you're using the <tgmath.h> macro to call this function, fmin always takes and returns a double.

If you use the <tgmath.h> fmin() macro, the type of the argument determines which version of the function is selected. See Type-generic math for details.

Requirements

Routine Required header
fmin, fminf, fminl C: <math.h>
C++: <math.h> or <cmath>
fmin macro <tgmath.h>

For more compatibility information, see Compatibility.

See also

Alphabetical function reference
fmax, fmaxf, fmaxl