simopt.plots.solvability_cdf
============================

.. py:module:: simopt.plots.solvability_cdf

.. autoapi-nested-parse::

   Solvability CDF plot.





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

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

   Plots solvability CDFs for one or more solvers on a single problem.

   :param experiments: Problem-solver pairs for different solvers
                       on a common problem.
   :type experiments: list[ProblemSolver]
   :param solve_tol: Optimality gap that defines when a problem is
                     considered solved (0 < solve_tol ≤ 1). Defaults to 0.1.
   :type solve_tol: float, optional
   :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, include bootstrapped confidence
                          intervals. Defaults to True.
   :type plot_conf_ints: bool, optional
   :param print_max_hw: If True, print the max half-width in the caption.
                        Defaults to True.
   :type print_max_hw: bool, optional
   :param plot_title: Custom title to override the generated one
                      (used only if all_in_one is True).
   :type plot_title: str, optional
   :param legend_loc: Location of the plot legend (e.g., "best").
   :type legend_loc: str, optional
   :param ext: File extension for saved plots. 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: Label for solver group in plot titles.
                           Defaults to "SOLVER_SET".
   :type solver_set_name: str, optional

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

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