flopscope.numpy.log1p
fnp.log1p(*args, **kwargs)[flopscope source][numpy source]
Return the natural logarithm of one plus the input array, element-wise.
Adapted from NumPy docs np.log1p
Element-wise log(1+x) (accurate near zero).
Calculates log(1 + x).
Parameters
- x:array_like
Input values.
- out:ndarray, None, or tuple of ndarray and None, optional
A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.
- where:array_like, optional
This condition is broadcast over the input. At locations where the condition is True, the
outarray will be set to the ufunc result. Elsewhere, theoutarray will retain its original value. Note that if an uninitializedoutarray is created via the defaultout=None, locations within it where the condition is False will remain uninitialized.- **kwargs
For other keyword-only arguments, see the ufunc docs.
Returns
- y:ndarray
Natural logarithm of
1 + x, element-wise. This is a scalar ifxis a scalar.
See also
- we.flops.expm1
exp(x) - 1, the inverse of log1p.
Notes
For real-valued input, log1p is accurate also for x so small
that 1 + x == 1 in floating-point accuracy.
Logarithm is a multivalued function: for each x there is an infinite
number of z such that exp(z) = 1 + x. The convention is to return
the z whose imaginary part lies in [-pi, pi].
For real-valued input data types, log1p always returns real output.
For each value that cannot be expressed as a real number or infinity,
it yields nan and sets the invalid floating point error flag.
References
1
M. Abramowitz and I.A. Stegun, "Handbook of Mathematical Functions",
10th printing, 1964, pp. 67.
https://personal.math.ubc.ca/~cbm/aands/page_67.htm2
Wikipedia, "Logarithm". https://en.wikipedia.org/wiki/LogarithmExamples
>>> import flopscope.numpy as fnp
>>> flops.log1p(1e-99)
1e-99
>>> flops.log(1 + 1e-99)
0.0