list_methods

Contents

list_methods#

class braintools.quad.list_methods(kind=None)#

List the registered method names.

Parameters:

kind (str | None) – Equation kind. If None (default), list every kind.

Returns:

The sorted names registered for kind; if kind is None, a dict mapping each kind to its sorted list of names.

Return type:

List[str] | Dict[str, List[str]]

Raises:

ValueError – If kind is not None and unknown.

See also

get_method

Look up a registered stepper.

register_method

Add a stepper to the registry.

Examples

>>> from braintools.quad import list_methods
>>> list_methods('imex')
['ars222', 'cnab', 'euler']
>>> sorted(list_methods())
['dde', 'imex', 'ode', 'sde']