mappy_ds.continuation.StepFunctionResult

class mappy_ds.continuation.StepFunctionResult(success, y=None, params=None, info=None)

Return value of a step function passed to continuation().

Attributes:

successbool

Whether the step succeeded. The continuation stops at the first unsuccessful step.

yT or None

Value of the continued variable found by the step; it seeds the next step.

paramsdict or None

Parameters after the step, e.g. with a solved parameter updated. None keeps the parameters the step function was called with.

infodict or None

Extra data to store in ContinuationStep.info.