share/man/man3m/isnan.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH ISNAN 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 isnan \- test for NaN
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBint\fR \fBisnan\fR(\fBdouble\fR \fIx\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  62 #include <math.h>
  63
  64 \fBint\fR \fBisnan\fR(\fBreal\(emfloating\fR \fIx\fR);
  65 .fi
  66
  67 .SH DESCRIPTION
  68 .sp
  69 .LP
  70 In C90 mode, the \fBisnan()\fR function tests whether \fIx\fR is NaN.
  71 .sp
  72 .LP
  73 In C99 mode, the \fBisnan()\fR macro determines whether its argument value is
  74 NaN. First, an argument represented in a format wider than its semantic type is
  75 converted to its semantic type. The determination is then based on the type of
  76 the argument.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 Both the \fBisnan()\fR function and macro return non-zero if and only if
  81 \fIx\fR is NaN.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 No errors are defined.
  86 .SH WARNINGS
  87 .sp
  88 .LP
  89 In C99 mode, the practice of explicitly supplying a prototype for \fBisnan()\fR
  90 after the line
  91 .sp
  92 .in +2
  93 .nf
  94 #include <math.h>
  95 .fi
  96 .in -2
  97
  98 .sp
  99 .LP
 100 is obsolete and will no longer work.
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 tab(    ) box;
 110 cw(2.75i) |cw(2.75i)
 111 lw(2.75i) |lw(2.75i)
 112 .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Standard
 116 _
 117 MT-Level        MT-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBfpclassify\fR(3M), \fBisfinite\fR(3M), \fBisinf\fR(3M), \fBisnormal\fR(3M),
 124 \fBmath.h\fR(3HEAD), \fBsignbit\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)