usr/src/man/man3c/isnand.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH ISNAND 3C "Jun 15, 2004"
   7 .SH NAME
   8 isnand, isnanf, finite, fpclass, unordered \- determine type of floating-point
   9 number
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <ieeefp.h>
  14
  15 \fBint\fR \fBisnand\fR(\fBdouble\fR \fIdsrc\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBisnanf\fR(\fBfloat\fR \fIfsrc\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBfinite\fR(\fBdouble\fR \fIdsrc\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBfpclass_t\fR \fBfpclass\fR(\fBdouble\fR \fIdsrc\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBunordered\fR(\fBdouble\fR \fIdsrc1\fR, \fBdouble\fR \fIdsrc2\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBisnand()\fR and \fBisnanf()\fR functions return \fBTRUE\fR (\fB1\fR) if
  42 the argument \fIdsrc\fR or \fIfsrc\fR is a NaN;  otherwise they return
  43 \fBFALSE\fR (\fB0\fR).
  44 .sp
  45 .LP
  46 The \fBfpclass()\fR function returns one of the following classes to which
  47 \fIdsrc\fR belongs:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBFP_SNAN\fR\fR
  52 .ad
  53 .RS 14n
  54 signaling NaN
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBFP_QNAN\fR\fR
  61 .ad
  62 .RS 14n
  63 quiet NaN
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBFP_NINF\fR\fR
  70 .ad
  71 .RS 14n
  72 negative infinity
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBFP_PINF\fR\fR
  79 .ad
  80 .RS 14n
  81 positive infinity
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBFP_NDENORM\fR\fR
  88 .ad
  89 .RS 14n
  90 negative denormalized non-zero
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBFP_PDENORM\fR\fR
  97 .ad
  98 .RS 14n
  99 positive denormalized non-zero
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBFP_NZERO\fR\fR
 106 .ad
 107 .RS 14n
 108 negative zero
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBFP_PZERO\fR\fR
 115 .ad
 116 .RS 14n
 117 positive zero
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBFP_NNORM\fR\fR
 124 .ad
 125 .RS 14n
 126 negative normalized non-zero
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBFP_PNORM\fR\fR
 133 .ad
 134 .RS 14n
 135 positive normalized non-zero
 136 .RE
 137
 138 .sp
 139 .LP
 140 The \fBfinite()\fR function returns \fBTRUE\fR (\fB1\fR) if the argument
 141 \fIdsrc\fR is neither infinity nor NaN; otherwise it returns  \fBFALSE\fR
 142 (\fB0\fR).
 143 .sp
 144 .LP
 145 The \fBunordered()\fR function returns \fBTRUE\fR (\fB1\fR) if one of its two
 146 arguments is unordered with respect to the other argument.  This is equivalent
 147 to reporting whether either argument is NaN.  If neither argument is NaN,
 148 \fBFALSE\fR (\fB0\fR) is returned.
 149 .sp
 150 .LP
 151 None of these functions generates an exception, even for signaling NaNs.
 152 .SH RETURN VALUES
 153 .sp
 154 .LP
 155 See DESCRIPTION.
 156 .SH ATTRIBUTES
 157 .sp
 158 .LP
 159 See \fBattributes\fR(5) for descriptions of the following attributes:
 160 .sp
 161
 162 .sp
 163 .TS
 164 box;
 165 c | c
 166 l | l .
 167 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 168 _
 169 MT-Level        MT-Safe
 170 .TE
 171
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBfpgetround\fR(3C), \fBisnan\fR(3M), \fBattributes\fR(5)