Return State Enumeration Class Documentation¶
- class mypyopt.return_state_enum.ReturnStateEnum
Bases:
objectThis class simply defines some constants for how functions return
- InfeasibleDV = -1
Search failed because the decision variable went out of the valid parameter space range
- InfeasibleObj = -2
Search failed because the objective function could not be calculated, probably a failed simulation call
- InvalidInitialPoint = -4
Search failed because the initial point was invalid
- Successful = 0
Search returned successfully
- UnsuccessfulOther = -3
Search failed for an unknown reason
- UserAborted = -9
Search was stopped because the user forced it to stop
- static all_enums() List[int]
- static enum_to_string(enum)
This static function converts an enumerated constant integer into a string representation
- Parameters
enum – A constant as defined in this class
- Returns
A string description of the constant