xref: /minix3/lib/libm/man/fdim.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\" Copyright (c) 2004 David Schultz <das@FreeBSD.org>
2*2fe8fb19SBen Gras.\" All rights reserved.
3*2fe8fb19SBen Gras.\"
4*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
5*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
6*2fe8fb19SBen Gras.\" are met:
7*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
8*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
9*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
10*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
11*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
12*2fe8fb19SBen Gras.\"
13*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*2fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*2fe8fb19SBen Gras.\" SUCH DAMAGE.
24*2fe8fb19SBen Gras.\"
25*2fe8fb19SBen Gras.\" $FreeBSD: src/lib/msun/man/fdim.3,v 1.1 2004/06/30 07:04:01 das Exp $
26*2fe8fb19SBen Gras.\" $NetBSD$
27*2fe8fb19SBen Gras.\"
28*2fe8fb19SBen Gras.Dd June 29, 2004
29*2fe8fb19SBen Gras.Dt FDIM 3
30*2fe8fb19SBen Gras.Os
31*2fe8fb19SBen Gras.Sh NAME
32*2fe8fb19SBen Gras.Nm fdim ,
33*2fe8fb19SBen Gras.Nm fdimf ,
34*2fe8fb19SBen Gras.Nm fdiml
35*2fe8fb19SBen Gras.Nd positive difference functions
36*2fe8fb19SBen Gras.Sh LIBRARY
37*2fe8fb19SBen Gras.Lb libm
38*2fe8fb19SBen Gras.Sh SYNOPSIS
39*2fe8fb19SBen Gras.In math.h
40*2fe8fb19SBen Gras.Ft double
41*2fe8fb19SBen Gras.Fn fdim "double x" "double y"
42*2fe8fb19SBen Gras.Ft float
43*2fe8fb19SBen Gras.Fn fdimf "float x" "float y"
44*2fe8fb19SBen Gras.Ft long double
45*2fe8fb19SBen Gras.Fn fdiml "long double x" "long double y"
46*2fe8fb19SBen Gras.Sh DESCRIPTION
47*2fe8fb19SBen GrasThe
48*2fe8fb19SBen Gras.Fn fdim ,
49*2fe8fb19SBen Gras.Fn fdimf ,
50*2fe8fb19SBen Grasand
51*2fe8fb19SBen Gras.Fn fdiml
52*2fe8fb19SBen Grasfunctions return the positive difference between
53*2fe8fb19SBen Gras.Fa x
54*2fe8fb19SBen Grasand
55*2fe8fb19SBen Gras.Fa y .
56*2fe8fb19SBen GrasThat is, if
57*2fe8fb19SBen Gras.Fa x\- Ns Fa y
58*2fe8fb19SBen Grasis positive, then
59*2fe8fb19SBen Gras.Fa x\- Ns Fa y
60*2fe8fb19SBen Grasis returned.
61*2fe8fb19SBen GrasIf either
62*2fe8fb19SBen Gras.Fa x
63*2fe8fb19SBen Grasor
64*2fe8fb19SBen Gras.Fa y
65*2fe8fb19SBen Grasis an \*(Na, then an \*(Na is returned.
66*2fe8fb19SBen GrasOtherwise, the result is
67*2fe8fb19SBen Gras.Li +0.0 .
68*2fe8fb19SBen Gras.Pp
69*2fe8fb19SBen GrasOverflow or underflow may occur iff the exact result is not
70*2fe8fb19SBen Grasrepresentable in the return type.
71*2fe8fb19SBen GrasNo other exceptions are raised.
72*2fe8fb19SBen Gras.Sh SEE ALSO
73*2fe8fb19SBen Gras.Xr fabs 3 ,
74*2fe8fb19SBen Gras.Xr fmax 3 ,
75*2fe8fb19SBen Gras.Xr fmin 3 ,
76*2fe8fb19SBen Gras.Xr math 3
77*2fe8fb19SBen Gras.Sh STANDARDS
78*2fe8fb19SBen GrasThe
79*2fe8fb19SBen Gras.Fn fdim ,
80*2fe8fb19SBen Gras.Fn fdimf ,
81*2fe8fb19SBen Grasand
82*2fe8fb19SBen Gras.Fn fdiml
83*2fe8fb19SBen Grasfunctions conform to
84*2fe8fb19SBen Gras.St -isoC-99 .
85*2fe8fb19SBen Gras.Sh HISTORY
86*2fe8fb19SBen GrasThese routines first appeared in
87*2fe8fb19SBen Gras.Fx 5.3
88*2fe8fb19SBen Grasand
89*2fe8fb19SBen Gras.Nx 5.1 .
90