SeparationResults

(class from pyomo.contrib.pyros.solve_data)

class pyomo.contrib.pyros.solve_data.SeparationResults(local_separation_loop_results, global_separation_loop_results)

Bases: object

Container for results of PyROS separation problem routine.

Parameters:

• local_separation_loop_results (None or SeparationLoopResults) – Local separation problem loop results.

• global_separation_loop_results (None or SeparationLoopResults) – Global separation problem loop results.

local_separation_loop_results

Local separation results. If separation problems were not solved locally, then this attribute is set to None.

Type:

None or SeparationLoopResults

global_separation_loop_results

Global separation results. If separation problems were not solved globally, then this attribute is set to None.

Type:

None or SeparationLoopResults

__init__(local_separation_loop_results, global_separation_loop_results)

Initialize self (see class docstring).

Methods

__init__(local_separation_loop_results, ...)	Initialize self (see class docstring).
get_violating_attr(attr_name)	If separation problems solved globally, returns value of attribute of global separation loop results.

Attributes

all_discrete_scenarios_exhausted	For problems where the uncertainty set is of type DiscreteScenarioSet, True if last master problem solved explicitly accounts for all scenarios in the uncertainty set, False otherwise.
auxiliary_param_values	Auxiliary parameter values accompanying self.violating_param_realization.
found_violation	True if found_violation attribute for main separation loop results is True, False otherwise.
main_loop_results	Main separation loop results.
robustness_certified	Return True if separation results certify that first-stage solution is robust, False otherwise.
scaled_violations	None or ComponentMap: Scaled second-stage inequality constraint violations for maximally violating separation problem solution reported in local or global separation loop results.
solved_globally	True if global separation loop was invoked, False otherwise.
solved_locally	true if local separation loop was invoked, False otherwise.
subsolver_error	True if subsolver error found for local or global separation loop, False otherwise.
time_out	True if time out found for local or global separation loop, False otherwise.
violated_second_stage_ineq_cons	Return list of violated second-stage inequality constraints.
violating_param_realization	Uncertain parameter values for maximally violating separation problem solution reported in local or global separation loop results.
violating_separation_variable_values	Second-stage and state variable values for maximally violating separation problem solution reported in local or global separation loop results.
worst_case_ss_ineq_con	Second-stage inequality constraint corresponding to the separation solution chosen for the next master problem.

Member Documentation

get_violating_attr(attr_name)

If separation problems solved globally, returns value of attribute of global separation loop results.

Otherwise, if separation problems solved locally, returns value of attribute of local separation loop results. If local separation loop results specified, return value of attribute of local separation loop results.

Otherwise, if global separation loop results specified, return value of attribute of global separation loop results.

Otherwise, return None.

Parameters:

attr_name (str) – Name of attribute to be retrieved. Should be valid attribute name for object of type SeparationLoopResults.

Returns:

Attribute value.

Return type:

object

property all_discrete_scenarios_exhausted

For problems where the uncertainty set is of type DiscreteScenarioSet, True if last master problem solved explicitly accounts for all scenarios in the uncertainty set, False otherwise.

Type:

bool

property auxiliary_param_values

Auxiliary parameter values accompanying self.violating_param_realization.

Type:

None or list of float

property found_violation

True if found_violation attribute for main separation loop results is True, False otherwise.

Type:

bool

property main_loop_results

Main separation loop results. In particular, this is considered to be the global loop result if solved globally, and the local loop results otherwise.

Type:

SeparationLoopResults

property robustness_certified

Return True if separation results certify that first-stage solution is robust, False otherwise.

Type:

bool

property scaled_violations

None or ComponentMap: Scaled second-stage inequality constraint violations for maximally violating separation problem solution reported in local or global separation loop results. If no such solution found, (i.e. worst_case_ss_ineq_con set to None for both local and global loop results), then None is returned.

property solved_globally

True if global separation loop was invoked, False otherwise.

Type:

bool

property solved_locally

true if local separation loop was invoked, False otherwise.

Type:

bool

property subsolver_error

True if subsolver error found for local or global separation loop, False otherwise.

Type:

bool

property time_out

True if time out found for local or global separation loop, False otherwise.

Type:

bool

property violated_second_stage_ineq_cons

Return list of violated second-stage inequality constraints.

property violating_param_realization

Uncertain parameter values for maximally violating separation problem solution reported in local or global separation loop results. If no such solution found, (i.e. worst_case_ss_ineq_con set to None for both local and global loop results), then None is returned.

Type:

None or list of float

property violating_separation_variable_values

Second-stage and state variable values for maximally violating separation problem solution reported in local or global separation loop results. If no such solution found, (i.e. worst_case_ss_ineq_con set to None for both local and global loop results), then None is returned.

Type:

None or ComponentMap

property worst_case_ss_ineq_con

Second-stage inequality constraint corresponding to the separation solution chosen for the next master problem.

Type:

ConstraintData