2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
|
|
|
|
|
.\" Distributed under GPL
|
|
|
|
|
.\" Based on glibc infopages
|
|
|
|
|
.\"
|
|
|
|
|
.\" Corrections by aeb
|
|
|
|
|
.TH NAN 3 2002-08-10 "GNU" "libc math functions"
|
|
|
|
|
.SH NAME
|
|
|
|
|
nan, nanf, nanl \- return 'Not a Number'
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B #include <math.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "double nan(const char *" tagp );
|
2004-11-11 17:28:42 +00:00
|
|
|
.br
|
2004-11-03 13:51:07 +00:00
|
|
|
.BI "float nanf(const char *" tagp );
|
2004-11-11 17:28:42 +00:00
|
|
|
.br
|
2004-11-03 13:51:07 +00:00
|
|
|
.BI "long double nanl(const char *" tagp );
|
|
|
|
|
.sp
|
2005-07-06 07:41:37 +00:00
|
|
|
Compile with \-std=c99; link with \-lm.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
These functions return a representation (determined by
|
|
|
|
|
.IR tagp )
|
|
|
|
|
of a quiet NaN. If the implementation does not support
|
|
|
|
|
quiet NaNs, these functions return zero.
|
|
|
|
|
.LP
|
|
|
|
|
The call
|
|
|
|
|
.I nan("char-sequence")
|
2007-04-12 22:42:49 +00:00
|
|
|
is equivalent to
|
2004-11-03 13:51:07 +00:00
|
|
|
.I strtod ("NAN(char-sequence)",NULL)
|
|
|
|
|
and similarly calls to
|
2005-11-02 11:34:24 +00:00
|
|
|
.BR nanf ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-11-02 11:34:24 +00:00
|
|
|
.BR nanl ()
|
2004-11-03 13:51:07 +00:00
|
|
|
are equivalent to analogous calls to
|
2005-11-02 11:34:24 +00:00
|
|
|
.BR strtof ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-11-02 11:34:24 +00:00
|
|
|
.BR strtold ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
|
The argument
|
|
|
|
|
.I tagp
|
2007-04-12 22:42:49 +00:00
|
|
|
is used in an unspecified manner.
|
|
|
|
|
On IEEE 754 systems, there are many representations of NaN, and
|
2004-11-03 13:51:07 +00:00
|
|
|
.I tagp
|
2007-04-12 22:42:49 +00:00
|
|
|
selects one.
|
|
|
|
|
On other systems it may do nothing.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
|
C99. See also IEC 559 and the appendix with
|
|
|
|
|
recommended functions in IEEE 754/IEEE 854.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR isnan (3),
|
|
|
|
|
.BR strtod (3)
|
