lib/libm/gen/nan.3

   1 .\"
   2 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to The NetBSD Foundation
   6 .\" by Klaus Klein.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"        This product includes software developed by the NetBSD
  19 .\"        Foundation, Inc. and its contributors.
  20 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  21 .\"    contributors may be used to endorse or promote products derived
  22 .\"    from this software without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  25 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  26 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  28 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34 .\" POSSIBILITY OF SUCH DAMAGE.
  35 .\"
  36 .\" $NetBSD: nan.3,v 1.1 2006/03/15 22:07:09 kleink Exp $
  37 .\" $DragonFly: src/lib/libm/gen/nan.3,v 1.1 2007/06/17 17:46:01 pavalos Exp $
  38 .\"
  39 .Dd March 15, 2006
  40 .Dt NAN 3
  41 .Os
  42 .Sh NAME
  43 .Nm nan ,
  44 .Nm nanf ,
  45 .Nm nanl
  46 .Nd return quiet NaN
  47 .Sh LIBRARY
  48 .Lb libm
  49 .Sh SYNOPSIS
  50 .In math.h
  51 .Ft double
  52 .Fn nan "const char *tagp"
  53 .Ft float
  54 .Fn nanf "const char *tagp"
  55 .Ft long double
  56 .Fn nanl "const char *tagp"
  57 .Sh DESCRIPTION
  58 The call
  59 .Fn nan "\*qn-char-sequence\*q"
  60 is equivalent to the call
  61 .Fn strtod "\*qNAN(n-char-sequence)\*q" "NULL" .
  62 The call
  63 .Fn nan "\*q\*q"
  64 is equivalent to the call
  65 .Fn strtod "\*qNAN()\*q" "NULL" .
  66 .Pp
  67 The
  68 .Fn nanf
  69 and
  70 .Fn nanl
  71 functions are equivalent to
  72 .Fn nan
  73 but substituting
  74 .Fn strtod .
  75 .Sh RETURN VALUES
  76 .Ss IEEE 754
  77 The
  78 .Fn nan ,
  79 .Fn nanf ,
  80 and
  81 .Fn nanl
  82 functions return a quiet NaN as specified by
  83 .Fa tagp .
  84 .Ss VAX
  85 The
  86 .Fn nan ,
  87 .Fn nanf ,
  88 and
  89 .Fn nanl
  90 functions return zero.
  91 .Sh SEE ALSO
  92 .Xr math 3 ,
  93 .Xr strtod 3
  94 .Sh STANDARDS
  95 The
  96 .Fn nan ,
  97 .Fn nanf ,
  98 and
  99 .Fn nanl
 100 functions conform to
 101 .St -isoC-99 .