contrib/openbsd_libm/man/fmax.3

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