lib/libc/gen/isfinite.3

   1 .\"     $NetBSD: isfinite.3,v 1.2 2004/01/15 19:43:45 kleink Exp $
   2 .\"     $DragonFly: src/lib/libc/gen/isfinite.3,v 1.1 2005/07/26 21:15:19 joerg Exp $
   3 .\"
   4 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   5 .\" All rights reserved.
   6 .\"
   7 .\" This code is derived from software contributed to The NetBSD Foundation
   8 .\" by Klaus Klein.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. All advertising materials mentioning features or use of this software
  19 .\"    must display the following acknowledgement:
  20 .\"        This product includes software developed by the NetBSD
  21 .\"        Foundation, Inc. and its contributors.
  22 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  23 .\"    contributors may be used to endorse or promote products derived
  24 .\"    from this software without specific prior written permission.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  27 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  28 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  29 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  30 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  33 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  34 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36 .\" POSSIBILITY OF SUCH DAMAGE.
  37 .\"
  38 .Dd October 29, 2003
  39 .Dt ISFINITE 3
  40 .Os
  41 .Sh NAME
  42 .Nm isfinite
  43 .Nd test for finite value
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In math.h
  48 .Ft int
  49 .Fn isfinite "real-floating x"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn isfinite
  53 determines whether its argument
  54 .Fa x
  55 has a finite value.
  56 An argument represented in a format wider than its semantic type is
  57 converted to its semantic type first.
  58 The determination is then based on the type of the argument.
  59 .Sh RETURN VALUES
  60 The
  61 .Fn isfinite
  62 macro returns a non-zero value if the value of
  63 .Fa x
  64 is finite.
  65 Otherwise 0 is returned.
  66 .Sh ERRORS
  67 No errors are defined.
  68 .Sh SEE ALSO
  69 .Xr fpclassify 3 ,
  70 .Xr isnormal 3 ,
  71 .Xr math 3 ,
  72 .Xr signbit 3
  73 .Sh STANDARDS
  74 The
  75 .Fn isfinite
  76 macro conforms to
  77 .St -isoC-99 .