lib/libc/gen/isgreater.3

   1 .\" $NetBSD: isgreater.3,v 1.1 2007/02/22 22:08:20 drochner Exp $
   2 .\"
   3 .\" Copyright (c) 2003 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: /repoman/r/ncvs/src/lib/libc/gen/isgreater.3,v 1.3 2005/02/06 03:23:31 das Exp
  28 .\"
  29 .Dd February 12, 2003
  30 .Dt ISGREATER 3
  31 .Os
  32 .Sh NAME
  33 .Nm isgreater , isgreaterequal , isless , islessequal ,
  34 .Nm islessgreater , isunordered
  35 .Nd "compare two floating-point numbers"
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In math.h
  40 .Ft int
  41 .Fn isgreater "real-floating x" "real-floating y"
  42 .Ft int
  43 .Fn isgreaterequal "real-floating x" "real-floating y"
  44 .Ft int
  45 .Fn isless "real-floating x" "real-floating y"
  46 .Ft int
  47 .Fn islessequal "real-floating x" "real-floating y"
  48 .Ft int
  49 .Fn islessgreater "real-floating x" "real-floating y"
  50 .Ft int
  51 .Fn isunordered "real-floating x" "real-floating y"
  52 .Sh DESCRIPTION
  53 Each of the macros
  54 .Fn isgreater ,
  55 .Fn isgreaterequal ,
  56 .Fn isless ,
  57 .Fn islessequal ,
  58 and
  59 .Fn islessgreater
  60 take arguments
  61 .Fa x
  62 and
  63 .Fa y
  64 and return a non-zero value if and only if its nominal
  65 relation on
  66 .Fa x
  67 and
  68 .Fa y
  69 is true.
  70 These macros always return zero if either
  71 argument is not a number (NaN), but unlike the corresponding C
  72 operators, they never raise a floating point exception.
  73 .Pp
  74 The
  75 .Fn isunordered
  76 macro takes arguments
  77 .Fa x
  78 and
  79 .Fa y
  80 and returns non-zero if and only if neither
  81 .Fa x
  82 nor
  83 .Fa y
  84 are NaNs.
  85 For any pair of floating-point values, one
  86 of the relationships (less, greater, equal, unordered) holds.
  87 .Sh SEE ALSO
  88 .Xr fpclassify 3 ,
  89 .Xr math 3 ,
  90 .Xr signbit 3
  91 .Sh STANDARDS
  92 The
  93 .Fn isgreater ,
  94 .Fn isgreaterequal ,
  95 .Fn isless ,
  96 .Fn islessequal ,
  97 .Fn islessgreater ,
  98 and
  99 .Fn isunordered
 100 macros conform to
 101 .St -isoC-99 .
 102 .Sh HISTORY
 103 The relational macros described above first appeared in
 104 .Nx 5.0 .