log

Contents

log#

class brainunit.math.log(x, unit_to_scale=None, **kwargs)#

Natural logarithm, element-wise.

Parameters:

  • x (Array | ndarray | bool | number | bool | int | float | complex | saiunit.Quantity) – Input array or Quantity. Must be positive.

  • unit_to_scale (saiunit.Unit | None) – Unit used to convert x to a dimensionless number first.

Returns:

out – Element-wise natural logarithm.

Return type:

Array

Examples

>>> import saiunit as u
>>> import jax.numpy as jnp
>>> u.math.log(jnp.array([1.0, jnp.e, jnp.e**2]))
Array([0., 1., 2.], dtype=float32)
Contents