Merge from vendor branch BZIP:
[dragonfly.git] / lib / libc / gen / fpclassify.3
1 .\"     $NetBSD: fpclassify.3,v 1.2 2004/01/15 19:43:45 kleink Exp $
2 .\"     $DragonFly: src/lib/libc/gen/fpclassify.3,v 1.1 2005/07/26 21:15:19 joerg Exp $
3 .\"
4 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
5 .\" All rights reserved.
6 .\"
7 .\" This code is derived from software contributed to The NetBSD Foundation
8 .\" by Klaus Klein.
9 .\"
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
12 .\" are met:
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\"    notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
18 .\" 3. All advertising materials mentioning features or use of this software
19 .\"    must display the following acknowledgement:
20 .\"        This product includes software developed by the NetBSD
21 .\"        Foundation, Inc. and its contributors.
22 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
23 .\"    contributors may be used to endorse or promote products derived
24 .\"    from this software without specific prior written permission.
25 .\"
26 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 .\" POSSIBILITY OF SUCH DAMAGE.
37 .\"
38 .Dd January 14, 2004
39 .Dt FPCLASSIFY 3
40 .Os
41 .Sh NAME
42 .Nm fpclassify
43 .Nd classify real floating type
44 .Sh LIBRARY
45 .Lb libc
46 .Sh SYNOPSIS
47 .In math.h
48 .Ft int
49 .Fn fpclassify "real-floating x"
50 .Sh DESCRIPTION
51 The
52 .Fn fpclassify
53 macro performs classification of its argument
54 .Fa x .
55 An argument represented in a format wider than its semantic type is
56 converted to its semantic type first.
57 The classification is then based on the type of the argument.
58 .Ss IEEE 754
59 .Bl -tag -width "FP_SUBNORMALXXX" -compact -offset indent
60 .It Dv FP_INFINITE
61 infinity, either positive or negative
62 .It Dv FP_NAN
63 not-a-number
64 .Pq Dq NaN
65 .It Dv FP_NORMAL
66 normal
67 .It Dv FP_SUBNORMAL
68 subnormal
69 .It Dv FP_ZERO
70 zero
71 .El
72 .Sh RETURN VALUES
73 The
74 .Fn fpclassify
75 macro returns the value of the number classification macro appropriate
76 to its argument
77 .Fa x
78 as described above.
79 .Sh ERRORS
80 No errors are defined.
81 .Sh SEE ALSO
82 .Xr isfinite 3 ,
83 .Xr isnormal 3 ,
84 .Xr math 3 ,
85 .Xr signbit 3
86 .Sh STANDARDS
87 The
88 .Fn fpclassify
89 macro conforms to
90 .St -isoC-99 .