lib/libm/man/finite.3

   1 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   2 .\" 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 .\"     from: @(#)ieee.3        6.4 (Berkeley) 5/6/91
  29 .\"     $NetBSD: finite.3,v 1.2 2011/08/06 11:09:22 wiz Exp $
  30 .\"
  31 .Dd July 28, 2011
  32 .Dt FINITE 3
  33 .Os
  34 .Sh NAME
  35 .Nm finite ,
  36 .Nm finitef
  37 .Nd tests for finite values
  38 .Sh LIBRARY
  39 .Lb libm
  40 .Sh SYNOPSIS
  41 .In math.h
  42 .Ft int
  43 .Fn finite "double x"
  44 .Ft int
  45 .Fn finitef "float x"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn finite
  49 function returns the value 1 when
  50 .Bd -ragged -offset indent
  51 \-\*(If \*(Lt
  52 .Fa x
  53 \*(Lt +\*(If.
  54 .Ed
  55 .Pp
  56 Otherwise a zero is returned
  57 (that is,
  58 .Pf \*(Ba Ns Fa x Ns \*(Ba
  59 = \*(If or
  60 .Fa x
  61 is \*(Na).
  62 .Sh SEE ALSO
  63 .Xr isfinite 3 ,
  64 .Xr math 3
  65 .Sh STANDARDS
  66 The described functions conform to
  67 .St -ieee754 .
  68 Note that unlike
  69 .Xr isfinite 3 ,
  70 neither function is present in the
  71 .Dv ISO
  72 C-language standards or in the
  73 .Dv IEEE
  74 .Dv POSIX
  75 standards.
  76 .Sh HISTORY
  77 The
  78 .Nm finite
  79 and
  80 .Fn finitef
  81 functions first appeared in
  82 .Bx 4.3 .