simopt.plots.solvability_cdf

Solvability CDF plot.

Module Contents

simopt.plots.solvability_cdf.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.

Parameters:

  • experiments (list[ProblemSolver]) – Problem-solver pairs for different solvers on a common problem.

  • solve_tol (float, optional) – Optimality gap that defines when a problem is considered solved (0 < solve_tol ≤ 1). Defaults to 0.1.

  • all_in_one (bool, optional) – If True, plot all curves together. Defaults to True.

  • n_bootstraps (int, optional) – Number of bootstrap samples. Defaults to 100.

  • conf_level (float, optional) – Confidence level for intervals (0 < conf_level < 1). Defaults to 0.95.

  • plot_conf_ints (bool, optional) – If True, include bootstrapped confidence intervals. Defaults to True.

  • print_max_hw (bool, optional) – If True, print the max half-width in the caption. Defaults to True.

  • plot_title (str, optional) – Custom title to override the generated one (used only if all_in_one is True).

  • legend_loc (str, optional) – Location of the plot legend (e.g., “best”).

  • ext (str, optional) – File extension for saved plots. Defaults to “.png”.

  • save_as_pickle (bool, optional) – If True, save plots as pickle files. Defaults to False.

  • solver_set_name (str, optional) – Label for solver group in plot titles. Defaults to “SOLVER_SET”.

Returns:

List of file paths for the generated plots.

Return type:

list[Path]

Raises:

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