Skip to main content
`Ctrl`+`K`

# scipy.special.inv_boxcox1p

scipy.special.inv_boxcox1p(y, lmbda, out=None) = <ufunc 'inv_boxcox1p'>

  Compute the inverse of the Box-Cox transformation.

  Find `x` such that:

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

  Parameters:
    y array_like

      Data to be transformed.

    lmbda array_like

      Power parameter of the Box-Cox transform.

    out ndarray, optional

      Optional output array for the function values

  Returns:
    x scalar or ndarray

      Transformed data.

  Notes

  Added in version 0.16.0.

  Array API Standard Support

  `inv_boxcox1p` has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable `SCIPY_ARRAY_API=1` and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.

  Library | CPU | GPU
  --- | --- | ---
  NumPy | ✅ | n/a
  CuPy | n/a | ✅
  PyTorch | ✅ | ⛔
  JAX | ⚠️ no JIT | ⛔
  Dask | ✅ | n/a

  > See Support for the array API standard for more information.

  Examples

      >>> from scipy.special import boxcox1p, inv_boxcox1p
      >>> y = boxcox1p([1, 4, 10], 2.5)
      >>> inv_boxcox1p(y, 2.5)
      array([1., 4., 10.])