Solution Interface (i_solution)

class pypint.solutions.i_solution.ISolution(*args, **kwargs)[source]

Bases: builtins.object

Generalized storage for solutions of solvers.

add_solution(*args, **kwargs)[source]

Adds a new solution data storage object.

Raises:NotImplementedError – If called directly or via super().

Notes

This method must be overridden in derived classes.

__weakref__

list of weak references to the object (if defined)

data_storage_type[source]

Read-only accessor for the data storage type.

Returns:data_storage_type – or a derived class thereof
Return type:TrajectorySolutionData or StepSolutionData
used_iterations[source]

Accessor for the number of iterations.

Parameters:used_iterations (int) – number of used iterations
Raises:ValueError – If used_iterations is not a non-zero positive integer value.
Returns:used_iterations – number of used iterations
Return type:int