xref: /freebsd/lib/msun/man/fmax.3 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2004 David Schultz <das@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd June 29, 2004
28.Dt FMAX 3
29.Os
30.Sh NAME
31.Nm fmax ,
32.Nm fmaxf ,
33.Nm fmaxl ,
34.Nm fmin ,
35.Nm fminf ,
36.Nm fminl
37.Nd floating-point maximum and minimum functions
38.Sh LIBRARY
39.Lb libm
40.Sh SYNOPSIS
41.In math.h
42.Ft double
43.Fn fmax "double x" "double y"
44.Ft float
45.Fn fmaxf "float x" "float y"
46.Ft "long double"
47.Fn fmaxl "long double x" "long double y"
48.Ft double
49.Fn fmin "double x" "double y"
50.Ft float
51.Fn fminf "float x" "float y"
52.Ft "long double"
53.Fn fminl "long double x" "long double y"
54.Sh DESCRIPTION
55The
56.Fn fmax ,
57.Fn fmaxf ,
58and
59.Fn fmaxl
60functions return the larger of
61.Fa x
62and
63.Fa y ,
64and likewise, the
65.Fn fmin ,
66.Fn fminf ,
67and
68.Fn fminl
69functions return the smaller of
70.Fa x
71and
72.Fa y .
73They treat
74.Li +0.0
75as being larger than
76.Li -0.0 .
77If one argument is an \*(Na, then the other argument is returned.
78If both arguments are \*(Nas, then the result is an \*(Na.
79These routines do not raise any floating-point exceptions.
80.Sh SEE ALSO
81.Xr fabs 3 ,
82.Xr fdim 3 ,
83.Xr math 3
84.Sh STANDARDS
85The
86.Fn fmax ,
87.Fn fmaxf ,
88.Fn fmaxl ,
89.Fn fmin ,
90.Fn fminf ,
91and
92.Fn fminl
93functions conform to
94.St -isoC-99 .
95.Sh HISTORY
96These routines first appeared in
97.Fx 5.3 .
98