simopt.plots.terminal_feasibility
=================================

.. py:module:: simopt.plots.terminal_feasibility

.. autoapi-nested-parse::

   Terminal feasibility plot.





Module Contents
---------------

.. py:function:: plot_terminal_feasibility(experiments: list[list[simopt.experiment.ProblemSolver]], plot_type: Literal['scatter', 'violin'] = 'scatter', score_type: Literal['inf_norm', 'norm'] = 'inf_norm', two_sided: bool = True, plot_zero: bool = True, plot_optimal: bool = True, norm_degree: int = 1, all_in_one: bool = True, n_bootstraps: int = 100, conf_level: float = 0.95, plot_conf_ints: bool = True, bias_correction: bool = True, solver_set_name: str = 'SOLVER_SET', plot_title: str | None = None, legend_loc: str | None = None, ext: str = '.png', save_as_pickle: bool = False) -> list[str]

   Plot the feasibility of one solver problem pair. (for now).

   :param experiments: Problem-solver pairs used to produce plots.
   :type experiments: list [list [``experiment_base.ProblemSolver``]]
   :param plot_type:
                     String indicating which type of plot to produce:
                         "scatter" : scatter plot with terminal objective on x-axis and terminal
                         feasiblity score on y-axis for all macroreps
                         "violin" : violin plot showing density of terminal feasiblity scores for all
                         macroreps
   :type plot_type: str, default = 'scatter'
   :param score_type: "inf_norm" : use infinite norm of lhs of violated constraints to calculate
                      feasiblity score
                      "norm" : use "norm_degree" to specify degree of norm of lhs of violated
                      constriants
   :type score_type: str, default = "inf_norm"
   :param two_sided: Two-sided or one-sided feasiblity score
   :type two_sided: bool, default = "True"
   :param plot_zero: Plot a dashed red line a feasiblity score = 0
   :type plot_zero: bool, default = True
   :param plot_optimal: Plot a dashed red line at beast feasible objective across all postreplications
   :type plot_optimal: default = True
   :param norm_degree: if not using inf_norm, specifies degree of norm taken of lhs of violated
                       constraints for feasibility score
   :type norm_degree: int, default = 1
   :param all_in_one: plot all solvers on same plot
   :type all_in_one: bool, default = True
   :param n_bootstraps: number of bootsrap replications for CI construction
   :type n_bootstraps: int, default = 100
   :param conf_level: confidence level of created CI
   :type conf_level: float, default = 0.95
   :param plot_conf_ints: plot CI's for each maroreplication
   :type plot_conf_ints: bool, default = True
   :param bias_correction: use bias correction for CI construction
   :type bias_correction: bool, default = True
   :param solver_set_name: Override solver names in plot, only applies if all_in_one = True
   :type solver_set_name: str, default = "SOLVER_SET"
   :param plot_title: Optional title to override the one that is autmatically generated
   :type plot_title: str, optional
   :param legend_loc: specificies location of legend
   :type legend_loc: str, default="best"
   :param ext: Extension to add to image file path to change file type
   :type ext: str, default = '.png'
   :param save_as_pickle: True if plot should be saved to pickle file, False otherwise.
   :type save_as_pickle: bool, default = False
   :param Returns:
   :param -------:
   :param file_list: List compiling path names for plots produced.
   :type file_list: list [str]
   :param Raises:
   :param ------:
   :param TypeError:
   :param ValueError: