]>
Commit | Line | Data |
---|---|---|
fea681da | 1 | .\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com> |
caba2e47 MK |
2 | .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk |
3 | .\" <mtk.manpages@gmail.com> | |
fea681da | 4 | .\" |
93015253 | 5 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
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. | |
c13182ef | 14 | .\" |
fea681da MK |
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. | |
c13182ef | 22 | .\" |
fea681da MK |
23 | .\" Formatted or processed versions of this manual, if unaccompanied by |
24 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 25 | .\" %%%LICENSE_END |
fea681da MK |
26 | .\" |
27 | .\" Modified 2002-07-27 by Walter Harms | |
28 | .\" (walter.harms@informatik.uni-oldenburg.de) | |
97986708 | 29 | .TH LOG1P 3 2016-03-15 "" "Linux Programmer's Manual" |
fea681da | 30 | .SH NAME |
9a2d673e | 31 | log1p, log1pf, log1pl \- logarithm of 1 plus argument |
fea681da MK |
32 | .SH SYNOPSIS |
33 | .nf | |
34 | .B #include <math.h> | |
68e4db0a | 35 | .PP |
fea681da | 36 | .BI "double log1p(double " x ); |
d39541ec | 37 | .br |
fea681da | 38 | .BI "float log1pf(float " x ); |
d39541ec | 39 | .br |
fea681da | 40 | .BI "long double log1pl(long double " x ); |
68e4db0a | 41 | .PP |
fea681da | 42 | .fi |
cc4615cc | 43 | Link with \fI\-lm\fP. |
68e4db0a | 44 | .PP |
cc4615cc MK |
45 | .in -4n |
46 | Feature Test Macro Requirements for glibc (see | |
47 | .BR feature_test_macros (7)): | |
48 | .in | |
68e4db0a | 49 | .PP |
cc4615cc | 50 | .ad l |
caba2e47 | 51 | .BR log1p (): |
1b5ffa62 | 52 | .RS 4 |
636ed4d5 MK |
53 | _ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L |
54 | || _XOPEN_SOURCE\ >=\ 500 | |
cf7fa0a1 | 55 | .\" || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED |
636ed4d5 MK |
56 | || /* Since glibc 2.19: */ _DEFAULT_SOURCE |
57 | || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE | |
1b5ffa62 | 58 | .RE |
caba2e47 | 59 | .br |
cc4615cc MK |
60 | .BR log1pf (), |
61 | .BR log1pl (): | |
1b5ffa62 | 62 | .RS 4 |
636ed4d5 MK |
63 | _ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L |
64 | || /* Since glibc 2.19: */ _DEFAULT_SOURCE | |
65 | || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE | |
1b5ffa62 | 66 | .RE |
cc4615cc | 67 | .ad b |
fea681da | 68 | .SH DESCRIPTION |
5600f73a | 69 | These functions return a value equivalent to |
2d986c92 MK |
70 | .nf |
71 | ||
72 | log (1 + \fIx\fP) | |
73 | ||
74 | .fi | |
5600f73a | 75 | The result is computed in a way |
022671eb MK |
76 | that is accurate even if the value of |
77 | .I x | |
78 | is near zero. | |
caba2e47 MK |
79 | .SH RETURN VALUE |
80 | On success, these functions return the natural logarithm of | |
81 | .IR "(1\ +\ x)" . | |
82 | ||
83 | If | |
84 | .I x | |
85 | is a NaN, | |
86 | a NaN is returned. | |
87 | ||
88 | If | |
89 | .I x | |
90 | is positive infinity, positive infinity is returned. | |
91 | ||
92 | If | |
93 | .I x | |
efe294cb | 94 | is \-1, a pole error occurs, |
caba2e47 MK |
95 | and the functions return |
96 | .RB - HUGE_VAL , | |
97 | .RB - HUGE_VALF , | |
98 | or | |
99 | .RB - HUGE_VALL , | |
100 | respectively. | |
101 | ||
102 | If | |
103 | .I x | |
104 | is less than \-1 (including negative infinity), | |
efe294cb | 105 | a domain error occurs, |
caba2e47 MK |
106 | and a NaN (not a number) is returned. |
107 | .\" POSIX.1 specifies a possible range error if x is subnormal | |
108 | .\" glibc 2.8 doesn't do this | |
109 | .SH ERRORS | |
110 | See | |
111 | .BR math_error (7) | |
112 | for information on how to determine whether an error has occurred | |
113 | when calling these functions. | |
114 | .PP | |
115 | The following errors can occur: | |
116 | .TP | |
117 | Domain error: \fIx\fP is less than \-1 | |
118 | .\" .I errno | |
119 | .\" is set to | |
120 | .\" .BR EDOM . | |
121 | An invalid floating-point exception | |
122 | .RB ( FE_INVALID ) | |
123 | is raised. | |
124 | .TP | |
125 | Pole error: \fIx\fP is \-1 | |
126 | .\" .I errno | |
127 | .\" is set to | |
128 | .\" .BR ERANGE . | |
129 | A divide-by-zero floating-point exception | |
130 | .RB ( FE_DIVBYZERO ) | |
131 | is raised. | |
132 | .PP | |
133 | These functions do not set | |
134 | .IR errno . | |
135 | .\" FIXME . Is it intentional that these functions do not set errno? | |
136 | .\" log(), log2(), log10() do set errno | |
137 | .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6792 | |
d05cb848 | 138 | .SH ATTRIBUTES |
eb71cf70 MK |
139 | For an explanation of the terms used in this section, see |
140 | .BR attributes (7). | |
141 | .TS | |
142 | allbox; | |
143 | lbw27 lb lb | |
144 | l l l. | |
145 | Interface Attribute Value | |
146 | T{ | |
d05cb848 PH |
147 | .BR log1p (), |
148 | .BR log1pf (), | |
d05cb848 | 149 | .BR log1pl () |
eb71cf70 MK |
150 | T} Thread safety MT-Safe |
151 | .TE | |
47297adb | 152 | .SH CONFORMING TO |
9a74e018 | 153 | C99, POSIX.1-2001, POSIX.1-2008. |
caba2e47 | 154 | .\" BSD |
47297adb | 155 | .SH SEE ALSO |
fea681da MK |
156 | .BR exp (3), |
157 | .BR expm1 (3), | |
158 | .BR log (3) |