Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libcr / gen / isinf.3
1 .\" Copyright (c) 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)isinf.3     8.2 (Berkeley) 1/29/94
33 .\" $FreeBSD: src/lib/libc/gen/isinf.3,v 1.5.2.3 2003/05/04 22:25:22 murray Exp $
34 .\"
35 .Dd January 29, 1994
36 .Dt ISINF 3
37 .Os
38 .Sh NAME
39 .Nm isinf ,
40 .Nm isnan ,
41 .Nm isnanf
42 .Nd test for infinity or not-a-number
43 .Sh LIBRARY
44 .Lb libc
45 .Sh SYNOPSIS
46 .In math.h
47 .Ft int
48 .Fn isinf double
49 .Ft int
50 .Fn isnan double
51 .Ft int
52 .Fn isnanf float
53 .Sh DESCRIPTION
54 The
55 .Fn isinf
56 function
57 returns 1 if the number is
58 .Dq \\*(If ,
59 otherwise 0.
60 .Pp
61 The
62 .Fn isnan
63 and
64 .Fn isnanf
65 functions
66 return 1 if the double or float (respectively) is
67 .Dq not-a-number ,
68 otherwise 0.
69 .Sh SEE ALSO
70 .Xr math 3
71 .Rs
72 .%T "IEEE Standard for Binary Floating-Point Arithmetic"
73 .%Q ANSI
74 .%R Std 754-1985
75 .Re
76 .Sh BUGS
77 Neither the
78 .Tn VAX
79 nor the Tahoe floating point have distinguished values
80 for either infinity or not-a-number.
81 These routines always return 0 on those architectures.