Module « scipy.special »

Fonction boxcox1p - module scipy.special

Signature de la fonction boxcox1p

Description

boxcox1p.__doc__

boxcox1p(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])

boxcox1p(x, lmbda)

Compute the Box-Cox transformation of 1 + `x`.

The Box-Cox transformation computed by `boxcox1p` is::

    y = ((1+x)**lmbda - 1) / lmbda  if lmbda != 0
        log(1+x)                    if lmbda == 0

Returns `nan` if ``x < -1``.
Returns `-inf` if ``x == -1`` and ``lmbda < 0``.

Parameters
----------
x : array_like
    Data to be transformed.
lmbda : array_like
    Power parameter of the Box-Cox transform.

Returns
-------
y : array
    Transformed data.

Notes
-----

.. versionadded:: 0.14.0

Examples
--------
>>> from scipy.special import boxcox1p
>>> boxcox1p(1e-4, [0, 0.5, 1])
array([  9.99950003e-05,   9.99975001e-05,   1.00000000e-04])
>>> boxcox1p([0.01, 0.1], 0.25)
array([ 0.00996272,  0.09645476])