summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c/isnand.3c
blob: 2d5730e2f681693eb3456d2e73668e50df4e0fc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
'\" te
.\" Copyright 1989 AT&T.  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
.TH isnand 3C "15 Jun 2004" "SunOS 5.11" "Standard C Library Functions"
.SH NAME
isnand, isnanf, finite, fpclass, unordered \- determine type of floating-point
number
.SH SYNOPSIS
.LP
.nf
#include <ieeefp.h>

\fBint\fR \fBisnand\fR(\fBdouble\fR \fIdsrc\fR);
.fi

.LP
.nf
\fBint\fR \fBisnanf\fR(\fBfloat\fR \fIfsrc\fR);
.fi

.LP
.nf
\fBint\fR \fBfinite\fR(\fBdouble\fR \fIdsrc\fR);
.fi

.LP
.nf
\fBfpclass_t\fR \fBfpclass\fR(\fBdouble\fR \fIdsrc\fR);
.fi

.LP
.nf
\fBint\fR \fBunordered\fR(\fBdouble\fR \fIdsrc1\fR, \fBdouble\fR \fIdsrc2\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBisnand()\fR and \fBisnanf()\fR functions return \fBTRUE\fR (\fB1\fR) if
the argument \fIdsrc\fR or \fIfsrc\fR is a NaN;  otherwise they return
\fBFALSE\fR (\fB0\fR).
.sp
.LP
The \fBfpclass()\fR function returns one of the following classes to which
\fIdsrc\fR belongs:
.sp
.ne 2
.mk
.na
\fB\fBFP_SNAN\fR\fR
.ad
.RS 14n
.rt  
signaling NaN
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_QNAN\fR\fR
.ad
.RS 14n
.rt  
quiet NaN
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_NINF\fR\fR
.ad
.RS 14n
.rt  
negative infinity
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_PINF\fR\fR
.ad
.RS 14n
.rt  
positive infinity
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_NDENORM\fR\fR
.ad
.RS 14n
.rt  
negative denormalized non-zero
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_PDENORM\fR\fR
.ad
.RS 14n
.rt  
positive denormalized non-zero
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_NZERO\fR\fR
.ad
.RS 14n
.rt  
negative zero
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_PZERO\fR\fR
.ad
.RS 14n
.rt  
positive zero
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_NNORM\fR\fR
.ad
.RS 14n
.rt  
negative normalized non-zero
.RE

.sp
.ne 2
.mk
.na
\fB\fBFP_PNORM\fR\fR
.ad
.RS 14n
.rt  
positive normalized non-zero
.RE

.sp
.LP
The \fBfinite()\fR function returns \fBTRUE\fR (\fB1\fR) if the argument
\fIdsrc\fR is neither infinity nor NaN; otherwise it returns  \fBFALSE\fR
(\fB0\fR).
.sp
.LP
The \fBunordered()\fR function returns \fBTRUE\fR (\fB1\fR) if one of its two
arguments is unordered with respect to the other argument.  This is equivalent
to reporting whether either argument is NaN.  If neither argument is NaN,
\fBFALSE\fR (\fB0\fR) is returned.
.sp
.LP
None of these functions generates an exception, even for signaling NaNs.
.SH RETURN VALUES
.sp
.LP
See DESCRIPTION.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBfpgetround\fR(3C), \fBisnan\fR(3M), \fBattributes\fR(5)