xref: /freebsd/lib/msun/man/fmaximum_num.3 (revision 4e30c12973c73539bef01be3870a90b6346141e8)
1*4e30c129SJesús Blázquez.\" Copyright (c) 2004 David Schultz <das@FreeBSD.org>
2*4e30c129SJesús Blázquez.\" Copyright (c) 2026 Jesús Blázquez <jesuscblazquez@gmail.com>
3*4e30c129SJesús Blázquez.\" All rights reserved.
4*4e30c129SJesús Blázquez.\"
5*4e30c129SJesús Blázquez.\" Redistribution and use in source and binary forms, with or without
6*4e30c129SJesús Blázquez.\" modification, are permitted provided that the following conditions
7*4e30c129SJesús Blázquez.\" are met:
8*4e30c129SJesús Blázquez.\" 1. Redistributions of source code must retain the above copyright
9*4e30c129SJesús Blázquez.\"    notice, this list of conditions and the following disclaimer.
10*4e30c129SJesús Blázquez.\" 2. Redistributions in binary form must reproduce the above copyright
11*4e30c129SJesús Blázquez.\"    notice, this list of conditions and the following disclaimer in the
12*4e30c129SJesús Blázquez.\"    documentation and/or other materials provided with the distribution.
13*4e30c129SJesús Blázquez.\"
14*4e30c129SJesús Blázquez.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*4e30c129SJesús Blázquez.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*4e30c129SJesús Blázquez.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*4e30c129SJesús Blázquez.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*4e30c129SJesús Blázquez.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*4e30c129SJesús Blázquez.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*4e30c129SJesús Blázquez.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*4e30c129SJesús Blázquez.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*4e30c129SJesús Blázquez.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*4e30c129SJesús Blázquez.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*4e30c129SJesús Blázquez.\" SUCH DAMAGE.
25*4e30c129SJesús Blázquez.\"
26*4e30c129SJesús Blázquez.Dd April 3, 2026
27*4e30c129SJesús Blázquez.Dt FMAXIMUM_NUM 3
28*4e30c129SJesús Blázquez.Os
29*4e30c129SJesús Blázquez.Sh NAME
30*4e30c129SJesús Blázquez.Nm fmaximum_num ,
31*4e30c129SJesús Blázquez.Nm fmaximum_numf ,
32*4e30c129SJesús Blázquez.Nm fmaximum_numl ,
33*4e30c129SJesús Blázquez.Nm fminimum_num ,
34*4e30c129SJesús Blázquez.Nm fminimum_numf ,
35*4e30c129SJesús Blázquez.Nm fminimum_numl
36*4e30c129SJesús Blázquez.Nd floating-point maximum and minimum number functions
37*4e30c129SJesús Blázquez.Sh LIBRARY
38*4e30c129SJesús Blázquez.Lb libm
39*4e30c129SJesús Blázquez.Sh SYNOPSIS
40*4e30c129SJesús Blázquez.In math.h
41*4e30c129SJesús Blázquez.Ft double
42*4e30c129SJesús Blázquez.Fn fmaximum_num "double x" "double y"
43*4e30c129SJesús Blázquez.Ft float
44*4e30c129SJesús Blázquez.Fn fmaximum_numf "float x" "float y"
45*4e30c129SJesús Blázquez.Ft "long double"
46*4e30c129SJesús Blázquez.Fn fmaximum_numl "long double x" "long double y"
47*4e30c129SJesús Blázquez.Ft double
48*4e30c129SJesús Blázquez.Fn fminimum_num "double x" "double y"
49*4e30c129SJesús Blázquez.Ft float
50*4e30c129SJesús Blázquez.Fn fminimum_numf "float x" "float y"
51*4e30c129SJesús Blázquez.Ft "long double"
52*4e30c129SJesús Blázquez.Fn fminimum_numl "long double x" "long double y"
53*4e30c129SJesús Blázquez.Sh DESCRIPTION
54*4e30c129SJesús BlázquezThe
55*4e30c129SJesús Blázquez.Fn fmaximum_num ,
56*4e30c129SJesús Blázquez.Fn fmaximum_numf ,
57*4e30c129SJesús Blázquezand
58*4e30c129SJesús Blázquez.Fn fmaximum_numl
59*4e30c129SJesús Blázquezfunctions determine the larger of
60*4e30c129SJesús Blázquez.Fa x
61*4e30c129SJesús Blázquezand
62*4e30c129SJesús Blázquez.Fa y ,
63*4e30c129SJesús Blázquezpreferring a numeric value over an \*(Na.
64*4e30c129SJesús BlázquezIf one argument is a numeric value and the other is an \*(Na,
65*4e30c129SJesús Blázquezthe numeric value is returned.
66*4e30c129SJesús BlázquezIf both arguments are numeric, the larger value is returned.
67*4e30c129SJesús BlázquezIf both arguments are \*(Nas, a quiet \*(Na is returned.
68*4e30c129SJesús BlázquezFor the purpose of these functions, positive zero is considered
69*4e30c129SJesús Blázquezgreater than negative zero.
70*4e30c129SJesús Blázquez.Pp
71*4e30c129SJesús BlázquezLikewise, the
72*4e30c129SJesús Blázquez.Fn fminimum_num ,
73*4e30c129SJesús Blázquez.Fn fminimum_numf ,
74*4e30c129SJesús Blázquezand
75*4e30c129SJesús Blázquez.Fn fminimum_numl
76*4e30c129SJesús Blázquezfunctions determine the smaller of
77*4e30c129SJesús Blázquez.Fa x
78*4e30c129SJesús Blázquezand
79*4e30c129SJesús Blázquez.Fa y ,
80*4e30c129SJesús Blázquezpreferring a numeric value over an \*(Na.
81*4e30c129SJesús BlázquezIf one argument is a numeric value and the other is an \*(Na,
82*4e30c129SJesús Blázquezthe numeric value is returned.
83*4e30c129SJesús BlázquezIf both arguments are numeric, the smaller value is returned.
84*4e30c129SJesús BlázquezIf both arguments are \*(Nas, a quiet \*(Na is returned.
85*4e30c129SJesús BlázquezFor the purpose of these functions, negative zero is considered
86*4e30c129SJesús Blázquezless than positive zero.
87*4e30c129SJesús Blázquez.Pp
88*4e30c129SJesús BlázquezUnlike with the
89*4e30c129SJesús Blázquez.Xr fmaximum 3
90*4e30c129SJesús Blázquezand
91*4e30c129SJesús Blázquez.Xr fmaximum_mag 3
92*4e30c129SJesús Blázquezfamilies of functions, if either argument is a signaling \*(Na,
93*4e30c129SJesús Blázquezan invalid exception is raised.
94*4e30c129SJesús BlázquezOtherwise, these routines do not raise any floating-point exceptions.
95*4e30c129SJesús Blázquez.Sh SEE ALSO
96*4e30c129SJesús Blázquez.Xr fmax 3 ,
97*4e30c129SJesús Blázquez.Xr fmaximum 3 ,
98*4e30c129SJesús Blázquez.Xr fmaximum_mag 3 ,
99*4e30c129SJesús Blázquez.Xr math 3
100*4e30c129SJesús Blázquez.Sh STANDARDS
101*4e30c129SJesús BlázquezThe
102*4e30c129SJesús Blázquez.Fn fmaximum_num ,
103*4e30c129SJesús Blázquez.Fn fmaximum_numf ,
104*4e30c129SJesús Blázquez.Fn fmaximum_numl ,
105*4e30c129SJesús Blázquez.Fn fminimum_num ,
106*4e30c129SJesús Blázquez.Fn fminimum_numf ,
107*4e30c129SJesús Blázquezand
108*4e30c129SJesús Blázquez.Fn fminimum_numl
109*4e30c129SJesús Blázquezfunctions conform to
110*4e30c129SJesús Blázquez.St -isoC-2023 .
111*4e30c129SJesús Blázquez.Sh HISTORY
112*4e30c129SJesús BlázquezThese routines first appeared in
113*4e30c129SJesús Blázquez.Fx 16.0 .
114