ibl.ibl_method.IntegrationResult

class ibl.ibl_method.IntegrationResult(x_end=np.inf, f_end=np.inf, status=TermReason.UNKNOWN, message='Not Set', success=False)

Bases: object

Bunch object representing the results of the IBL integration.

The integrator within the IBLMethod is solve_ivp from the integrate package from SciPy. To provide as much information as possible after the integration has completed this class is returned to provide detailed information about the integration process. The most important attributes are success, status, and message.

Parameters:

x_end (float)
f_end (float | floating | ndarray[Any, dtype[ScalarType]])
status (TermReason)
message (str)
success (bool)

__init__(x_end=np.inf, f_end=np.inf, status=TermReason.UNKNOWN, message='Not Set', success=False)

Initialize class.

Parameters:

x_end (float, optional) – Termination location of integration, by default np.inf.
f_end (InputParam, optional) – State value(s) at end of integration, by default np.inf.
status (TermReason, optional) – Reason for termination, by default TermReason.UNKNOWN.
message (str, optional) – Long description for termination reason, by default “Not Set”.
success (bool, optional) – Flag indicating whether integration was success, by default False.

Methods

__init__([x_end, f_end, status, message, ...])

Initialize class.

Attributes

`f_end`	State value(s) at end of integration.
`message`	Longer description of reason for termination.
`status`	Enumeration for reason integration terminated.
`success`	Flag indicating whether solver successfully completed.
`x_end`	Terminating location of integration.

property x_end: float: Terminating location of integration.

property f_end: float | floating | ndarray[Any, dtype[ScalarType]]: State value(s) at end of integration.

property status: TermReason: Enumeration for reason integration terminated.

property message: str: Longer description of reason for termination.

property success: bool: Flag indicating whether solver successfully completed.