MethodInfo#
- class braintools.quad.MethodInfo(name, kind, fn, order=None, category=None, aliases=(), description='')#
Metadata of a registered one-step integrator.
Returned by
method_info(). Instances are immutable snapshots: later registrations do not change an instance already returned.- Variables:
name (str) – Canonical short name of the method (an alias resolves to it).
kind (str) – Equation kind, one of
KINDS.fn (callable) – The registered stepper.
order (int or float or None) – Convergence order (the strong order for SDE steppers; for an embedded pair, the order of the solution it returns).
Noneif not recorded.category (str or None) – Family of the method, e.g.
'explicit','embedded'or'exponential'for the built-in ODE steppers.Noneif not recorded.aliases (tuple of str) – Alternative names that resolve to this method.
description (str) – One-line description; empty if not recorded.
See also
method_infoLook up the metadata of a method.
register_methodRegister a method with its metadata.
Examples
>>> from braintools.quad import method_info >>> info = method_info('heun3') >>> info.name, info.order, info.category ('heun', 3, 'explicit')