differt.utils.safe_divide

safe_divide(num, den)

Compute the elementwise division, but returns 0 when den is zero.

Parameters:

• num (Num[ArrayLike, '*#batch']) – The numerator.

• den (Num[ArrayLike, '*#batch']) – The denominator.

Return type:

Num[Array, '*batch']

Returns:

The result of num / den, except that division by zero returns 0.

Examples

The following examples shows how division by zero is handled.

>>> from differt.utils import safe_divide
>>>
>>> x = jnp.array([1, 2, 3, 4, 5])
>>> y = jnp.array([0, 1, 2, 0, 2])
>>> safe_divide(x, y)
Array([0. , 2. , 1.5, 0. , 2.5], dtype=float32)