simopt.plots.solvability_profile
================================

.. py:module:: simopt.plots.solvability_profile

.. autoapi-nested-parse::

   Solvability profile plot.





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

.. py:function:: plot_solvability_profiles(experiments: list[list[simopt.experiment.ProblemSolver]], plot_type: simopt.plot_type.PlotType, all_in_one: bool = True, n_bootstraps: int = 100, conf_level: float = 0.95, plot_conf_ints: bool = True, print_max_hw: bool = True, solve_tol: float = 0.1, beta: float = 0.5, ref_solver: str | None = None, plot_title: str | None = None, legend_loc: str | None = None, ext: str = '.png', save_as_pickle: bool = False, solver_set_name: str = 'SOLVER_SET', problem_set_name: str = 'PROBLEM_SET') -> list[pathlib.Path]

   Plots solvability or difference profiles for solvers on multiple problems.

   :param experiments: Problem-solver pairs used for plotting.
   :type experiments: list[list[ProblemSolver]]
   :param plot_type: Type of solvability plot to produce:
                     - PlotType.CDF_SOLVABILITY
                     - PlotType.QUANTILE_SOLVABILITY
                     - PlotType.DIFFERENCE_OF_CDF_SOLVABILITY
                     - PlotType.DIFFERENCE_OF_QUANTILE_SOLVABILITY
   :type plot_type: PlotType
   :param all_in_one: If True, plot all curves together.
                      Defaults to True.
   :type all_in_one: bool, optional
   :param n_bootstraps: Number of bootstrap samples. Defaults to 100.
   :type n_bootstraps: int, optional
   :param conf_level: Confidence level for intervals
                      (0 < conf_level < 1). Defaults to 0.95.
   :type conf_level: float, optional
   :param plot_conf_ints: If True, show bootstrapped confidence
                          intervals. Defaults to True.
   :type plot_conf_ints: bool, optional
   :param print_max_hw: If True, print max half-width in caption.
                        Defaults to True.
   :type print_max_hw: bool, optional
   :param solve_tol: Optimality gap defining when a problem is
                     considered solved (0 < solve_tol ≤ 1). Defaults to 0.1.
   :type solve_tol: float, optional
   :param beta: Quantile level to compute (0 < beta < 1).
                Defaults to 0.5.
   :type beta: float, optional
   :param ref_solver: Name of the reference solver for difference plots.
   :type ref_solver: str, optional
   :param plot_title: Custom title for the plot
                      (used only if `all_in_one=True`).
   :type plot_title: str, optional
   :param legend_loc: Location of the legend
                      (e.g., "best", "upper right").
   :type legend_loc: str, optional
   :param ext: File extension for saved plots (e.g., ".png").
               Defaults to ".png".
   :type ext: str, optional
   :param save_as_pickle: If True, save plots as pickle files.
                          Defaults to False.
   :type save_as_pickle: bool, optional
   :param solver_set_name: Name of solver group for plot titles.
                           Defaults to "SOLVER_SET".
   :type solver_set_name: str, optional
   :param problem_set_name: Name of problem group for plot titles.
                            Defaults to "PROBLEM_SET".
   :type problem_set_name: str, optional

   :returns: List of file paths for the plots produced.
   :rtype: list[Path]

   :raises ValueError: If any input parameter is out of bounds or invalid.