register_integrator

class braincell.quad.register_integrator(name, *, aliases=(), category='general', order=None, description='', deprecated=False, override=False)

Decorator: register the wrapped function in the global registry.

The decorated function is returned unchanged so it remains directly callable. Place this decorator outside any other decorators (such as braincell._misc.set_module_as()) so that the registry stores the

final exported function.

Parameters:

• name (str) – Canonical name under which to register the integrator.

• aliases (Iterable[str]) – Alternative lookup names. See IntegratorRegistry.register().

• category (str) – Forwarded to IntegratorRegistry.register().

• order (int | None) – Forwarded to IntegratorRegistry.register().

• description (str) – Forwarded to IntegratorRegistry.register().

• deprecated (bool) – Forwarded to IntegratorRegistry.register().

• override (bool) – Forwarded to IntegratorRegistry.register().

Return type:

Callable[[Callable], Callable]

Examples

>>> from braincell.quad import register_integrator
>>> @register_integrator("euler", aliases=("explicit",),
...                      category="explicit", order=1)
... def euler_step(target, *args):
...     ...