simopt.plots.area_scatterplot

Area scatter plot.

Module Contents

simopt.plots.area_scatterplot.plot_area_scatterplots(experiments: list[list[simopt.experiment.ProblemSolver]], 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 = 'best', ext: str = '.png', save_as_pickle: bool = False, solver_set_name: str = 'SOLVER_SET', problem_set_name: str = 'PROBLEM_SET') → list[pathlib.Path]

Plots scatterplots of mean vs. standard deviation of area under progress curves.

Can generate either one plot per solver or a combined plot for all solvers.

Note

The print_max_hw flag is currently not implemented.

Parameters:

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

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

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

  • conf_level (float, optional) – Confidence level for CIs (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) – Placeholder for printing max half-widths. Currently unused.

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

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

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

  • save_as_pickle (bool, optional) – If True, save plot as a pickle file. Defaults to False.

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

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

Returns:

List of file paths for the plots produced.

Return type:

list[Path]

Raises:

ValueError – If n_bootstraps is not positive or conf_level is outside (0, 1).