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  2021-03-22 "" "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 .PP
  37 .BI "double expm1(double " x );
  38 .BI "float expm1f(float " x );
  39 .BI "long double expm1l(long double " x );
  40 .PP
  41 .fi
  42 Link with \fI\-lm\fP.
  43 .PP
  44 .RS -4
  45 Feature Test Macro Requirements for glibc (see
  46 .BR feature_test_macros (7)):
  47 .RE
  48 .PP
  49 .BR expm1 ():
  50 .nf
  51     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  52         || _XOPEN_SOURCE >= 500
  53 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  54         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  55         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  56 .fi
  57 .PP
  58 .BR expm1f (),
  59 .BR expm1l ():
  60 .nf
  61     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  62         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  63         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  64 .fi
  65 .SH DESCRIPTION
  66 These functions return a value equivalent to
  67 .PP
  68 .nf
  69     exp(x) \- 1
  70 .fi
  71 .PP
  72 The result is computed in a way that is accurate even if the value of
  73 .I x
  74 is near
  75 zero\(ema case where
  76 .I "exp(x) \- 1"
  77 would be inaccurate due to
  78 subtraction of two numbers that are nearly equal.
  79 .SH RETURN VALUE
  80 On success, these functions return
  81 .IR "exp(x)\ \-\ 1" .
  82 .PP
  83 If
  84 .I x
  85 is a NaN,
  86 a NaN is returned.
  87 .PP
  88 If
  89 .I x
  90 is +0 (\-0),
  91 +0 (\-0) is returned.
  92 .PP
  93 If
  94 .I x
  95 is positive infinity, positive infinity is returned.
  96 .PP
  97 If
  98 .I x
  99 is negative infinity, \-1 is returned.
 100 .PP
 101 If the result overflows, a range error occurs,
 102 and the functions return
 103 .RB \- HUGE_VAL ,
 104 .RB \- HUGE_VALF ,
 105 or
 106 .RB \- HUGE_VALL ,
 107 respectively.
 108 .SH ERRORS
 109 See
 110 .BR math_error (7)
 111 for information on how to determine whether an error has occurred
 112 when calling these functions.
 113 .PP
 114 The following errors can occur:
 115 .TP
 116 Range error, overflow
 117 .I errno
 118 is set to
 119 .BR ERANGE
 120 (but see BUGS).
 121 An overflow floating-point exception
 122 .RB ( FE_OVERFLOW )
 123 is raised.
 124 .\"
 125 .\" POSIX.1 specifies an optional range error (underflow) if
 126 .\" x is subnormal.  Glibc does not implement this.
 127 .SH ATTRIBUTES
 128 For an explanation of the terms used in this section, see
 129 .BR attributes (7).
 130 .ad l
 131 .nh
 132 .TS
 133 allbox;
 134 lbx lb lb
 135 l l l.
 136 Interface       Attribute       Value
 137 T{
 138 .BR expm1 (),
 139 .BR expm1f (),
 140 .BR expm1l ()
 141 T}      Thread safety   MT-Safe
 142 .TE
 143 .hy
 144 .ad
 145 .sp 1
 146 .SH CONFORMING TO
 147 C99, POSIX.1-2001, POSIX.1-2008.
 148 .\" BSD.
 149 .SH BUGS
 150 Before glibc 2.17,
 151 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6778
 152 on certain architectures (e.g., x86, but not x86_64)
 153 .BR expm1 ()
 154 raised a bogus underflow floating-point exception
 155 for some large negative
 156 .I x
 157 values (where the function result approaches \-1).
 158 .PP
 159 Before approximately glibc version 2.11,
 160 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6814
 161 .\" e.g., expm1(1e5) through expm1(1.00199970127e5),
 162 .\" but not expm1(1.00199970128e5) and beyond.
 163 .BR expm1 ()
 164 raised a bogus invalid floating-point exception in addition to the expected
 165 overflow exception, and returned a NaN instead of positive infinity,
 166 for some large positive
 167 .I x
 168 values.
 169 .PP
 170 Before version 2.11,
 171 .\" It looks like the fix was in 2.11, or possibly 2.12.
 172 .\" I have no test system for 2.11, but 2.12 passes.
 173 .\" From the source (sysdeps/i386/fpu/s_expm1.S) it looks
 174 .\" like the changes were in 2.11.
 175 the glibc implementation did not set
 176 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6788
 177 .I errno
 178 to
 179 .B ERANGE
 180 when a range error occurred.
 181 .SH SEE ALSO
 182 .BR exp (3),
 183 .BR log (3),
 184 .BR log1p (3)