colour.algebra.spow

colour.algebra.spow(a: float | DTypeFloat, p: float | DTypeFloat) → DTypeFloat

colour.algebra.spow(a: NDArray, p: ArrayLike) → NDArrayFloat

colour.algebra.spow(a: ArrayLike, p: NDArray) → NDArrayFloat

colour.algebra.spow(a: ArrayLike, p: ArrayLike) → DTypeFloat | NDArrayFloat

Raise specified array \(a\) to the power \(p\) as follows: \(sign(a) * |a|^p\).

This definition avoids NaNs generation when array \(a\) is negative and the power \(p\) is fractional. This behaviour can be enabled or disabled with the colour.algebra.set_spow_enable() definition or with the spow_enable() context manager.

Parameters:

• a – Array \(a\).

• p – Power \(p\).

Returns:

Array \(a\) safely raised to the power \(p\).

Return type:

np.float or numpy.ndarray

Examples

>>> np.power(-2, 0.15)
nan
>>> spow(-2, 0.15)  
-1.1095694...
>>> spow(0, 0)
0.0