share/man/man3m/isnan.3m

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