mappy_ds.border

mappy_ds.border(dim, direction=1, name=None)

Declare a border (section) \(b(y, p) = 0\) of a continuous mode.

Parameters:

dimint

Dimension of the state space of the mode the border belongs to.

directionint, optional

Direction of the zero crossing that triggers the border: 1 for negative-to-positive, -1 for positive-to-negative and 0 for both. By default 1.

namestr, optional

Name used to refer to the border in transition rules written as {mode: {border_name: next_mode}}; by default the function name.

Examples

>>> from mappy_ds import border
>>> @border(dim=2)
... def fire(y, _):
...     return y[0] - 30.0
>>> fire.name
'fire'