lib/libc/gen/isinf.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)isinf.3     8.2 (Berkeley) 1/29/94
  29 .\"     $NetBSD: isinf.3,v 1.12 2004/03/04 23:47:56 wiz Exp $
  30 .\"     $DragonFly: src/lib/libc/gen/isinf.3,v 1.4 2006/05/17 14:06:37 swildner Exp $
  31 .\"
  32 .Dd March 5, 2004
  33 .Dt ISINF 3
  34 .Os
  35 .Sh NAME
  36 .Nm isinf
  37 .Nd test for infinity
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In math.h
  42 .Ft int
  43 .Fn isinf "real-floating x"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn isinf
  47 macro determines whether its argument
  48 .Fa x
  49 is an infinity (positive or negative).
  50 An argument represented in a format wider than its semantic type is
  51 converted to its semantic type first.
  52 The determination is then based on the type of the argument.
  53 .Ss IEEE 754
  54 It is determined whether the value of
  55 .Fa x
  56 is an infinity.
  57 .Ss VAX
  58 Infinities are not supported.
  59 .Sh RETURN VALUES
  60 The
  61 .Fn isinf
  62 macro returns a non-zero value if the value of
  63 .Fa x
  64 is an infinity.
  65 Otherwise 0 is returned.
  66 .Sh SEE ALSO
  67 .Xr fpclassify 3 ,
  68 .Xr isfinite 3 ,
  69 .Xr isnan 3 ,
  70 .Xr isnormal 3 ,
  71 .Xr math 3 ,
  72 .Xr signbit 3
  73 .Rs
  74 .%T "IEEE Standard for Binary Floating-Point Arithmetic"
  75 .%Q ANSI
  76 .%R Std 754-1985
  77 .Re
  78 .Sh STANDARDS
  79 The
  80 .Fn isinf
  81 macro conforms to
  82 .St -isoC-99 .