original/man3/infnan.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   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 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Sat Jul 24 19:11:11 1993 by Rik Faith (faith@cs.unc.edu)
  28 .\" Modified 2004-11-12 as per suggestion by Fabian Kreutz/AEB
  29 .\"     to note that this function is not available in glibc2.
  30 .\"
  31 .TH INFNAN 3  1993-06-02 "GNU" "Linux Programmer's Manual"
  32 .SH NAME
  33 infnan \- deal with infinite or not-a-number (NaN) result
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <math.h>
  37 .sp
  38 .BI "double infnan(int " error );
  39 .fi
  40 .sp
  41 Link with \fI\-lm\fP.
  42 .SH DESCRIPTION
  43 The
  44 .BR infnan ()
  45 function returns a suitable value for infinity and
  46 "not-a-number" (NaN) results.
  47 The value of \fIerror\fP can be
  48 .B ERANGE
  49 to represent infinity or anything else to represent NaN.
  50 \fIerrno\fP
  51 is also set.
  52 .SH "RETURN VALUE"
  53 If \fIerror\fP is
  54 .B ERANGE
  55 (Infinity),
  56 .B HUGE_VAL
  57 is returned.
  58 .PP
  59 If \fIerror\fP is \-\fBERANGE\fP (\-Infinity), \-\fBHUGE_VAL\fP is returned.
  60 .PP
  61 If \fIerror\fP is anything else, NAN is returned.
  62 .SH ERRORS
  63 .TP
  64 .B EDOM
  65 The value of \fIerror\fP is "not-a-number" (NaN).
  66 .TP
  67 .B ERANGE
  68 The value of \fIerror\fP is positive infinity or negative infinity.
  69 .SH "CONFORMING TO"
  70 4.3BSD.
  71 .SH NOTES
  72 This obsolete function was provided in
  73 libc4 and libc5, but is not available in glibc2.