xref: /freebsd/lib/msun/man/fdim.3 (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
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 FDIM 3
29.Os
30.Sh NAME
31.Nm fdim ,
32.Nm fdimf ,
33.Nm fdiml
34.Nd positive difference functions
35.Sh LIBRARY
36.Lb libm
37.Sh SYNOPSIS
38.In math.h
39.Ft double
40.Fn fdim "double x" "double y"
41.Ft float
42.Fn fdimf "float x" "float y"
43.Ft long double
44.Fn fdiml "long double x" "long double y"
45.Sh DESCRIPTION
46The
47.Fn fdim ,
48.Fn fdimf ,
49and
50.Fn fdiml
51functions return the positive difference between
52.Fa x
53and
54.Fa y .
55That is, if
56.Fa x\- Ns Fa y
57is positive, then
58.Fa x\- Ns Fa y
59is returned.
60If either
61.Fa x
62or
63.Fa y
64is an \*(Na, then an \*(Na is returned.
65Otherwise, the result is
66.Li +0.0 .
67.Pp
68Overflow or underflow may occur iff the exact result is not
69representable in the return type.
70No other exceptions are raised.
71.Sh SEE ALSO
72.Xr fabs 3 ,
73.Xr fmax 3 ,
74.Xr fmin 3 ,
75.Xr math 3
76.Sh STANDARDS
77The
78.Fn fdim ,
79.Fn fdimf ,
80and
81.Fn fdiml
82functions conform to
83.St -isoC-99 .
84.Sh HISTORY
85These routines first appeared in
86.Fx 5.3 .
87