lib/libc/gen/isnan.3

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