manual/LDP_man-pages/original/man3/finite.3

   1 .\" Copyright 2004 Andries Brouwer <aeb@cwi.nl>.
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .TH FINITE 3  2008-08-05 "" "Linux Programmer's Manual"
  24 .SH NAME
  25 finite, finitef, finitel, isinf, isinff, isinfl, isnan, isnanf, isnanl \-
  26 BSD floating-point classification functions
  27 .SH SYNOPSIS
  28 .nf
  29 .B #include <math.h>
  30 .sp
  31 .BI "int finite(double " x );
  32 .br
  33 .BI "int finitef(float " x );
  34 .br
  35 .BI "int finitel(long double " x );
  36 .sp
  37 .BI "int isinf(double " x );
  38 .br
  39 .BI "int isinff(float " x );
  40 .br
  41 .BI "int isinfl(long double " x );
  42 .sp
  43 .BI "int isnan(double " x );
  44 .br
  45 .BI "int isnanf(float " x );
  46 .br
  47 .BI "int isnanl(long double " x );
  48 .fi
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .sp
  55 .ad l
  56 .BR finite (),
  57 .BR finitef (),
  58 .BR finitel ():
  59 _BSD_SOURCE || _SVID_SOURCE
  60 .br
  61 .BR isinf ():
  62 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE;
  63 .I cc\ -std=c99
  64 .br
  65 .BR isinff (),
  66 .BR isinfl ():
  67 _BSD_SOURCE || _SVID_SOURCE
  68 .br
  69 .BR isnan ():
  70 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE || _ISOC99_SOURCE;
  71 .I cc\ -std=c99
  72 .br
  73 .BR isnanf (),
  74 .BR isnanl ():
  75 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600
  76 .ad b
  77 .SH DESCRIPTION
  78 The
  79 .BR finite ()
  80 functions return a nonzero value if \fIx\fP is neither infinite
  81 nor a "not-a-number" (NaN) value, and 0 otherwise.
  82
  83 The
  84 .BR isnan ()
  85 functions return a nonzero value if \fIx\fP is a NaN value,
  86 and 0 otherwise.
  87
  88 The
  89 .BR isinf ()
  90 functions return 1 if \fIx\fP is positive infinity, \-1 if \fIx\fP
  91 is negative infinity, and 0 otherwise.
  92 .SH NOTES
  93 Note that these functions are obsolete.
  94 C99 defines macros
  95 .BR isfinite (),
  96 .BR isinf (),
  97 and
  98 .BR isnan ()
  99 (for all types) replacing them.
 100 Further note that the C99
 101 .BR isinf ()
 102 has weaker guarantees on the return value.
 103 See
 104 .BR fpclassify (3).
 105 .\"
 106 .\" finite* not on HP-UX; they exist on Tru64.
 107 .\" .SH HISTORY
 108 .\" The
 109 .\" .BR finite ()
 110 .\" function occurs in 4.3BSD.
 111 .\" see IEEE.3 in the 4.3BSD manual
 112 .SH "SEE ALSO"
 113 .BR fpclassify (3)