erf

Contents

erf#

class brainunit.lax.erf(x, unit_to_scale=None, **kwargs)#

Elementwise error function: \(\mathrm{erf}(x)\).

Parameters:

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

  • unit_to_scale (saiunit.Unit | None) – If provided, x is scaled by this unit before applying the function.

Returns:

result – Always unitless.

Return type:

Array

Examples

>>> import saiunit as u
>>> import saiunit.lax as sulax
>>> import jax.numpy as jnp
>>> sulax.erf(jnp.array([0.0, 0.5, 1.0]))
Array([0.       , 0.5204999, 0.8427007], dtype=float32)
Contents