Changes.old: Add missing entry in 5.13 changelog
[man-pages.git] / man3 / log1p.3
blobf262c7d66d1d646cd1bfff774890c641235808e3
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 by Walter Harms
28 .\"     (walter.harms@informatik.uni-oldenburg.de)
29 .TH LOG1P 3   2021-03-22 "" "Linux Programmer's Manual"
30 .SH NAME
31 log1p, log1pf, log1pl \-  logarithm of 1 plus argument
32 .SH SYNOPSIS
33 .nf
34 .B #include <math.h>
35 .PP
36 .BI "double log1p(double " x );
37 .BI "float log1pf(float " x );
38 .BI "long double log1pl(long double " x );
39 .PP
40 .fi
41 Link with \fI\-lm\fP.
42 .PP
43 .RS -4
44 Feature Test Macro Requirements for glibc (see
45 .BR feature_test_macros (7)):
46 .RE
47 .PP
48 .nf
49 .BR log1p ():
50     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
51         || _XOPEN_SOURCE >= 500
52 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
53         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
54         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
55 .fi
56 .PP
57 .BR log1pf (),
58 .BR log1pl ():
59 .nf
60     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
61         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
62         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
63 .fi
64 .SH DESCRIPTION
65 These functions return a value equivalent to
66 .PP
67 .nf
68     log (1 + \fIx\fP)
69 .fi
70 .PP
71 The result is computed in a way
72 that is accurate even if the value of
73 .I x
74 is near zero.
75 .SH RETURN VALUE
76 On success, these functions return the natural logarithm of
77 .IR "(1\ +\ x)" .
78 .PP
80 .I x
81 is a NaN,
82 a NaN is returned.
83 .PP
85 .I x
86 is positive infinity, positive infinity is returned.
87 .PP
89 .I x
90 is \-1, a pole error occurs,
91 and the functions return
92 .RB \- HUGE_VAL ,
93 .RB \- HUGE_VALF ,
95 .RB \- HUGE_VALL ,
96 respectively.
97 .PP
99 .I x
100 is less than \-1 (including negative infinity),
101 a domain error occurs,
102 and a NaN (not a number) is returned.
103 .\" POSIX.1 specifies a possible range error if x is subnormal
104 .\" glibc 2.8 doesn't do this
105 .SH ERRORS
107 .BR math_error (7)
108 for information on how to determine whether an error has occurred
109 when calling these functions.
111 The following errors can occur:
113 Domain error: \fIx\fP is less than \-1
114 .I errno
115 is set to
116 .BR EDOM
117 (but see BUGS).
118 An invalid floating-point exception
119 .RB ( FE_INVALID )
120 is raised.
122 Pole error: \fIx\fP is \-1
123 .I errno
124 is set to
125 .BR ERANGE
126 (but see BUGS).
127 A divide-by-zero floating-point exception
128 .RB ( FE_DIVBYZERO )
129 is raised.
130 .SH ATTRIBUTES
131 For an explanation of the terms used in this section, see
132 .BR attributes (7).
133 .ad l
136 allbox;
137 lbx lb lb
138 l l l.
139 Interface       Attribute       Value
141 .BR log1p (),
142 .BR log1pf (),
143 .BR log1pl ()
144 T}      Thread safety   MT-Safe
148 .sp 1
149 .SH CONFORMING TO
150 C99, POSIX.1-2001, POSIX.1-2008.
151 .\" BSD
152 .SH BUGS
153 Before version 2.22, the glibc implementation did not set
154 .\" https://www.sourceware.org/bugzilla/show_bug.cgi?id=6792
155 .I errno
157 .B EDOM
158 when a domain error occurred.
160 Before version 2.22, the glibc implementation did not set
161 .\" https://www.sourceware.org/bugzilla/show_bug.cgi?id=6792
162 .I errno
164 .B ERANGE
165 when a range error occurred.
166 .SH SEE ALSO
167 .BR exp (3),
168 .BR expm1 (3),
169 .BR log (3)