[apple/libc.git] / gen / isinf.3

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