xref: /openbsd-src/lib/libm/man/fdim.3 (revision 9f1be2b6be65d2ab47863ae5d56ddbe2b8094a6e)
1*9f1be2b6Stb.\"	$OpenBSD: fdim.3,v 1.3 2016/04/26 19:49:22 tb Exp $
28e30f2f1Skettenis.\"
38e30f2f1Skettenis.\" Copyright (c) 2004 David Schultz <das@FreeBSD.org>
48e30f2f1Skettenis.\" All rights reserved.
58e30f2f1Skettenis.\"
68e30f2f1Skettenis.\" Redistribution and use in source and binary forms, with or without
78e30f2f1Skettenis.\" modification, are permitted provided that the following conditions
88e30f2f1Skettenis.\" are met:
98e30f2f1Skettenis.\" 1. Redistributions of source code must retain the above copyright
108e30f2f1Skettenis.\"    notice, this list of conditions and the following disclaimer.
118e30f2f1Skettenis.\" 2. Redistributions in binary form must reproduce the above copyright
128e30f2f1Skettenis.\"    notice, this list of conditions and the following disclaimer in the
138e30f2f1Skettenis.\"    documentation and/or other materials provided with the distribution.
148e30f2f1Skettenis.\"
158e30f2f1Skettenis.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
168e30f2f1Skettenis.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
178e30f2f1Skettenis.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
188e30f2f1Skettenis.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
198e30f2f1Skettenis.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
208e30f2f1Skettenis.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
218e30f2f1Skettenis.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
228e30f2f1Skettenis.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
238e30f2f1Skettenis.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
248e30f2f1Skettenis.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
258e30f2f1Skettenis.\" SUCH DAMAGE.
268e30f2f1Skettenis.\"
278e30f2f1Skettenis.\" $FreeBSD: src/lib/msun/man/fdim.3,v 1.1 2004/06/30 07:04:01 das Exp $
288e30f2f1Skettenis.\"
29*9f1be2b6Stb.Dd $Mdocdate: April 26 2016 $
308e30f2f1Skettenis.Dt FDIM 3
318e30f2f1Skettenis.Os
328e30f2f1Skettenis.Sh NAME
338e30f2f1Skettenis.Nm fdim ,
348e30f2f1Skettenis.Nm fdimf ,
358e30f2f1Skettenis.Nm fdiml
368e30f2f1Skettenis.Nd positive difference functions
378e30f2f1Skettenis.Sh SYNOPSIS
388e30f2f1Skettenis.In math.h
398e30f2f1Skettenis.Ft double
408e30f2f1Skettenis.Fn fdim "double x" "double y"
418e30f2f1Skettenis.Ft float
428e30f2f1Skettenis.Fn fdimf "float x" "float y"
438e30f2f1Skettenis.Ft long double
448e30f2f1Skettenis.Fn fdiml "long double x" "long double y"
458e30f2f1Skettenis.Sh DESCRIPTION
468e30f2f1SkettenisThe
478e30f2f1Skettenis.Fn fdim ,
488e30f2f1Skettenis.Fn fdimf ,
498e30f2f1Skettenisand
508e30f2f1Skettenis.Fn fdiml
518e30f2f1Skettenisfunctions return the positive difference between
528e30f2f1Skettenis.Fa x
538e30f2f1Skettenisand
548e30f2f1Skettenis.Fa y .
558e30f2f1SkettenisThat is, if
568e30f2f1Skettenis.Fa x\- Ns Fa y
578e30f2f1Skettenisis positive, then
588e30f2f1Skettenis.Fa x\- Ns Fa y
598e30f2f1Skettenisis returned.
608e30f2f1SkettenisIf either
618e30f2f1Skettenis.Fa x
628e30f2f1Skettenisor
638e30f2f1Skettenis.Fa y
64*9f1be2b6Stbis an NaN, then an NaN is returned.
658e30f2f1SkettenisOtherwise, the result is
668e30f2f1Skettenis.Li +0.0 .
678e30f2f1Skettenis.Pp
688e30f2f1SkettenisOverflow or underflow may occur if the exact result is not
698e30f2f1Skettenisrepresentable in the return type.
708e30f2f1SkettenisNo other exceptions are raised.
718e30f2f1Skettenis.Sh SEE ALSO
728e30f2f1Skettenis.Xr fabs 3 ,
738e30f2f1Skettenis.Xr fmax 3 ,
740714f1f8Smartynas.Xr fmin 3
758e30f2f1Skettenis.Sh STANDARDS
768e30f2f1SkettenisThe
778e30f2f1Skettenis.Fn fdim ,
788e30f2f1Skettenis.Fn fdimf ,
798e30f2f1Skettenisand
808e30f2f1Skettenis.Fn fdiml
818e30f2f1Skettenisfunctions conform to
828e30f2f1Skettenis.St -isoC-99 .
838e30f2f1Skettenis.Sh HISTORY
848e30f2f1SkettenisThese routines first appeared in
858e30f2f1Skettenis.Ox 4.5 .
86