simopt.plots.solvability_profile

Solvability profile plot.

Module Contents

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

Parameters:

  • experiments (list[list[ProblemSolver]]) – Problem-solver pairs used for plotting.

  • plot_type (PlotType) – Type of solvability plot to produce: - PlotType.CDF_SOLVABILITY - PlotType.QUANTILE_SOLVABILITY - PlotType.DIFFERENCE_OF_CDF_SOLVABILITY - PlotType.DIFFERENCE_OF_QUANTILE_SOLVABILITY

  • 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, show bootstrapped confidence intervals. Defaults to True.

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

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

  • beta (float, optional) – Quantile level to compute (0 < beta < 1). Defaults to 0.5.

  • ref_solver (str, optional) – Name of the reference solver for difference plots.

  • plot_title (str, optional) – Custom title for the plot (used only if all_in_one=True).

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

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

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

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

  • problem_set_name (str, optional) – Name of problem group for plot titles. Defaults to “PROBLEM_SET”.

Returns:

List of file paths for the plots produced.

Return type:

list[Path]

Raises:

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