set_exprel_order

Contents

set_exprel_order#

class brainunit.math.set_exprel_order(order)[source]#

Set the Taylor series order used by exprel() near zero.

Parameters:

order (int) – The order of the Taylor series expansion. Higher values provide better accuracy near x = 0 but require more computation. Valid range is 2 to 20 inclusive. The default module value is 5.

Raises:

ValueError – If order is not an integer in the range [2, 20].

Return type:

None

Notes

The Taylor expansion for exprel(x) = (exp(x) - 1) / x is:

\[f(x) = 1 + \frac{x}{2!} + \frac{x^2}{3!} + \cdots + \frac{x^n}{(n+1)!}\]

Examples

>>> from saiunit.math._exprel import set_exprel_order, get_exprel_order
>>> set_exprel_order(10)
>>> get_exprel_order()
10
>>> set_exprel_order(5)  # restore default