original/man3/expm1.3

   1 .\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com>
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" Modified 2002-07-27 Walter Harms
  28 .\"     (walter.harms@informatik.uni-oldenburg.de)
  29 .\"
  30 .TH EXPM1 3  2010-09-12 "" "Linux Programmer's Manual"
  31 .SH NAME
  32 expm1, expm1f, expm1l \- exponential minus 1
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <math.h>
  36 .sp
  37 .BI "double expm1(double " x );
  38 .br
  39 .BI "float expm1f(float " x );
  40 .br
  41 .BI "long double expm1l(long double " x );
  42 .sp
  43 .fi
  44 Link with \fI\-lm\fP.
  45 .sp
  46 .in -4n
  47 Feature Test Macro Requirements for glibc (see
  48 .BR feature_test_macros (7)):
  49 .in
  50 .sp
  51 .ad l
  52 .BR expm1 ():
  53 .RS 4
  54 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  55 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
  56 _POSIX_C_SOURCE\ >=\ 200112L;
  57 .br
  58 or
  59 .I cc\ -std=c99
  60 .RE
  61 .br
  62 .BR expm1f (),
  63 .BR expm1l ():
  64 .RS 4
  65 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  66 _POSIX_C_SOURCE\ >=\ 200112L;
  67 .br
  68 or
  69 .I cc\ -std=c99
  70 .RE
  71 .ad b
  72 .SH DESCRIPTION
  73 .I expm1(x)
  74 returns a value equivalent to
  75 .nf
  76
  77     exp(x) \- 1
  78
  79 .fi
  80 It is
  81 computed in a way that is accurate even if the value of \fIx\fP is near
  82 zero\(ema case where
  83 .I "exp(x) \- 1"
  84 would be inaccurate due to
  85 subtraction of two numbers that are nearly equal.
  86 .SH RETURN VALUE
  87 On success, these functions return
  88 .IR "exp(x)\ \-\ 1" .
  89
  90 If
  91 .I x
  92 is a NaN,
  93 a NaN is returned.
  94
  95 If
  96 .I x
  97 is +0 (\-0),
  98 +0 (\-0) is returned.
  99
 100 If
 101 .I x
 102 is positive infinity, positive infinity is returned.
 103
 104 If
 105 .I x
 106 is negative infinity, \-1 is returned.
 107
 108 If the result overflows, a range error occurs,
 109 and the functions return
 110 .RB - HUGE_VAL ,
 111 .RB - HUGE_VALF ,
 112 or
 113 .RB - HUGE_VALL ,
 114 respectively.
 115 .SH ERRORS
 116 See
 117 .BR math_error (7)
 118 for information on how to determine whether an error has occurred
 119 when calling these functions.
 120 .PP
 121 The following errors can occur:
 122 .TP
 123 Range error, overflow
 124 .I errno
 125 is set to
 126 .BR ERANGE
 127 (but see BUGS).
 128 An overflow floating-point exception
 129 .RB ( FE_OVERFLOW )
 130 is raised.
 131 .\"
 132 .\" POSIX.1 specifies an optional range error (underflow) if
 133 .\" x is subnormal.  Glibc does not implement this.
 134 .SH CONFORMING TO
 135 C99, POSIX.1-2001.
 136 .\" BSD.
 137 .SH BUGS
 138 For some large negative
 139 .I x
 140 values (where the function result approaches \-1),
 141 .BR expm1 ()
 142 raises a bogus underflow floating-point exception.
 143 .\" FIXME .
 144 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6778
 145
 146 For some large positive
 147 .I x
 148 values,
 149 .BR expm1 ()
 150 raises a bogus invalid floating-point exception in addition to the expected
 151 overflow exception, and returns a NaN instead of positive infinity.
 152 .\" FIXME .
 153 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6814
 154 .\" e.g., expm1(1e5) through expm1(1.00199970127e5),
 155 .\" but not expm1(1.00199970128e5) and beyond.
 156
 157 Before version 2.11,
 158 .\" It looks like the fix was in 2.11, or possibly 2.12.
 159 .\" I have no test system for 2.11, but 2.12 passes.
 160 .\" From the source (sysdeps/i386/fpu/s_expm1.S) it looks
 161 .\" like the changes were in 2.11.
 162 the glibc implementation did not set
 163 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6788
 164 .I errno
 165 to
 166 .B ERANGE
 167 when a range error occurred.
 168 .SH SEE ALSO
 169 .BR exp (3),
 170 .BR log (3),
 171 .BR log1p (3)