man-pages/man3/INFINITY.3

95 lines
2.4 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright 2004 Andries Brouwer <aeb@cwi.nl>.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
2004-11-03 13:51:07 +00:00
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
2004-11-03 13:51:07 +00:00
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH INFINITY 3 2007-07-26 "" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
INFINITY, NAN, HUGE_VAL, HUGE_VALF, HUGE_VALL \- floating-point constants
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.nf
2007-07-13 08:41:15 +00:00
.B #define _ISOC99_SOURCE
2004-11-03 13:51:07 +00:00
.br
.B #include <math.h>
.sp
.B INFINITY
.sp
.B NAN
.sp
.B HUGE_VAL
.br
.B HUGE_VALF
.br
.B HUGE_VALL
.fi
.SH DESCRIPTION
The macro
.B INFINITY
2007-06-22 19:42:52 +00:00
expands to a \fIfloat\fP constant representing positive infinity.
2004-11-03 13:51:07 +00:00
The macro
.B NAN
2007-06-22 19:42:52 +00:00
expands to a \fIfloat\fP constant representing a quiet NaN
(when supported).
A
2004-11-03 13:51:07 +00:00
.I quiet
NaN is a NaN ("not-a-number") that does not raise exceptions
when it is used in arithmetic.
The opposite is a
.I signaling
NaN.
See IEC 60559:1989.
2004-11-03 13:51:07 +00:00
The macros
.BR HUGE_VAL ,
.BR HUGE_VALF ,
2007-09-20 16:26:31 +00:00
.B HUGE_VALL
2007-06-22 19:42:52 +00:00
expand to constants of types \fIdouble\fP, \fIfloat\fP
and \fIlong double\fP, respectively,
2004-11-03 13:51:07 +00:00
that represent a large positive value, possibly plus infinity.
.SH "CONFORMING TO"
C99.
2004-11-03 13:51:07 +00:00
.SH AVAILABILITY
2007-06-22 19:42:52 +00:00
On a glibc system, the macro
.B HUGE_VAL
is always available.
Availability of the
.B NAN
macro can be tested using
2004-11-03 13:51:07 +00:00
.BR "#ifdef NAN" ,
2007-06-22 19:42:52 +00:00
and similarly for
.BR INFINITY ,
.BR HUGE_VALF ,
.BR HUGE_VALL .
2004-11-03 13:51:07 +00:00
They will be defined by
.I <math.h>
2007-06-22 17:42:06 +00:00
if
.B _ISOC99_SOURCE
or
.B _GNU_SOURCE
2007-06-22 19:42:52 +00:00
is defined, or
.B __STDC_VERSION__
is defined
2004-11-03 13:51:07 +00:00
and has a value not less than 199901L.
.SH "SEE ALSO"
2007-01-28 20:00:24 +00:00
.BR fpclassify (3),
2008-07-23 13:04:14 +00:00
.BR feature_test_macros (7),
.BR math_error (7)