simopt.plots.area_scatterplot
=============================

.. py:module:: simopt.plots.area_scatterplot

.. autoapi-nested-parse::

   Area scatter plot.





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

.. py:function:: 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.

   :param experiments: Problem-solver pairs used for plotting.
   :type experiments: list[list[ProblemSolver]]
   :param all_in_one: If True, plot all solvers 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 CIs (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: Placeholder for printing max half-widths.
                        Currently unused.
   :type print_max_hw: bool, optional
   :param plot_title: Custom title for the plot
                      (applies only if `all_in_one=True`).
   :type plot_title: str, optional
   :param legend_loc: Location of the legend
                      (e.g., "best", "lower right").
   :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 plot as a pickle file.
                          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
   :param problem_set_name: Label for problem group in 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 `n_bootstraps` is not positive or `conf_level` is outside (0, 1).