Changes: Ready for 5.13
[man-pages.git] / man3 / fmin.3
blob75ed1281c36ed7efb62ef19d3c8efab7016a7c77
1 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
3 .\"     <mtk.manpages@gmail.com>
4 .\"
5 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
6 .\" Distributed under GPL
7 .\" %%%LICENSE_END
8 .\"
9 .TH FMIN 3 2021-03-22 "" "Linux Programmer's Manual"
10 .SH NAME
11 fmin, fminf, fminl \- determine minimum of two floating-point numbers
12 .SH SYNOPSIS
13 .nf
14 .B #include <math.h>
15 .PP
16 .BI "double fmin(double " x ", double " y );
17 .BI "float fminf(float " x ", float " y );
18 .BI "long double fminl(long double " x ", long double " y );
19 .fi
20 .PP
21 Link with \fI\-lm\fP.
22 .PP
23 .RS -4
24 Feature Test Macro Requirements for glibc (see
25 .BR feature_test_macros (7)):
26 .RE
27 .PP
28 .BR fmin (),
29 .BR fminf (),
30 .BR fminl ():
31 .nf
32     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
33 .fi
34 .SH DESCRIPTION
35 These functions return the lesser value of
36 .I x
37 and
38 .IR y .
39 .SH RETURN VALUE
40 These functions return the minimum of
41 .I x
42 and
43 .IR y .
44 .PP
45 If one argument is a NaN, the other argument is returned.
46 .PP
47 If both arguments are NaN, a NaN is returned.
48 .SH ERRORS
49 No errors occur.
50 .SH VERSIONS
51 These functions first appeared in glibc in version 2.1.
52 .SH ATTRIBUTES
53 For an explanation of the terms used in this section, see
54 .BR attributes (7).
55 .ad l
56 .nh
57 .TS
58 allbox;
59 lbx lb lb
60 l l l.
61 Interface       Attribute       Value
63 .BR fmin (),
64 .BR fminf (),
65 .BR fminl ()
66 T}      Thread safety   MT-Safe
67 .TE
68 .hy
69 .ad
70 .sp 1
71 .SH CONFORMING TO
72 C99, POSIX.1-2001, POSIX.1-2008.
73 .SH SEE ALSO
74 .BR fdim (3),
75 .BR fmax (3)