cocopp.compall.ppfigcons

module documentation

Generate performance scaling figures for the constrained testbed.

The figures show the scaling of the performance in terms of ERT w.r.t. number of constraints on a log-log scale.

TODO: - docstring - example

Comments: (Paul) for now the strategy is to keep the same interface as in ppfigdim.py and implement an additional call to ppfigcons if data is from the constrained test suite

Function	`beautify`	Customize figure format.
Function	`ecdfs_figure_caption`	Undocumented
Function	`fix_styles`	a short hack to fix length of styles
Function	`get_ecdfs_all_groups_caption`	Returns figure caption for ECDF plots aggregating over function groups.
Function	`get_ecdfs_single_fcts_caption`	Returns figure caption for single function ECDF plots.
Function	`get_ecdfs_single_functions_single_dim_caption`	Returns figure caption for single function ECDF plots showing the results of 2+ algorithms in a single dimension.
Function	`legend_fontsize_scaler`	return a fontsize scaling factor depending on the number of entries in the legend.
Function	`main`	From a DataSetList, returns figures showing the scaling: ERT/dim vs dim.
Function	`plotLegend`	Display right-side legend.
Function	`prepare_ecdfs_figure_caption`	Undocumented
Function	`prepare_scaling_figure_caption`	Undocumented
Function	`providecolorsforlatex`	Provides the dvipsnames colors in pure LaTeX.
Function	`scaling_figure_caption`	Undocumented
Function	`ylim_upperbound`	Undocumented
Variable	`fontsize`	Undocumented
Variable	`legend`	Undocumented
Variable	`legend_text_max_len`	Undocumented
Variable	`ratio_nbsucc_to_display`	Undocumented
Variable	`refcolor`	Undocumented
Variable	`show_algorithms`	Undocumented
Variable	`show_significance`	Undocumented

def beautify(dim, legend=False, rightlegend=False): ¶

Customize figure format.

adding a legend, axis label, etc

Parameters
dim	Undocumented
legend	Undocumented
rightlegend	Undocumented
bool legend	if True, display a box legend
bool rightlegend	if True, makes some space on the right for legend

def ecdfs_figure_caption(for_html=False, dimension=0): ¶

Undocumented

def fix_styles(plotting_styles, line_styles): ¶

a short hack to fix length of styles

def get_ecdfs_all_groups_caption(): ¶

Returns figure caption for ECDF plots aggregating over function groups.

def get_ecdfs_single_fcts_caption(): ¶

Returns figure caption for single function ECDF plots.

def get_ecdfs_single_functions_single_dim_caption(): ¶

Returns figure caption for single function ECDF plots showing the results of 2+ algorithms in a single dimension.

def legend_fontsize_scaler(number_of_entries=None): ¶

return a fontsize scaling factor depending on the number of entries in the legend.

Works currently well with fontsize 14, where a legend with up to ~30 entries will still fit into the figure.

def main(dictAlg, html_file_prefix, sorted_algorithms=None, output_dir='ppdata', latex_commands_file=''): ¶

From a DataSetList, returns figures showing the scaling: ERT/dim vs dim.

One function and one target per figure.

target can be a scalar, a list with one element or a pproc.TargetValues instance with one target.

sortedAlgs is a list of string-identifies (folder names)

def plotLegend(handles, maxval=None): ¶

Display right-side legend.

Sorted from smaller to larger y-coordinate values.

def prepare_ecdfs_figure_caption(): ¶

Undocumented

def prepare_scaling_figure_caption(): ¶

Undocumented

def providecolorsforlatex(): ¶

Provides the dvipsnames colors in pure LaTeX.

Used when the xcolor option of the same name is not available, e.g. within the new ACM LaTeX templates.

def scaling_figure_caption(for_html=False): ¶

Undocumented

def ylim_upperbound(ymax): ¶

Undocumented

fontsize: float = ¶

Undocumented

legend: bool = ¶

Undocumented

legend_text_max_len: int = ¶

Undocumented

ratio_nbsucc_to_display: float = ¶

Undocumented

refcolor: str = ¶

Undocumented

show_algorithms: list = ¶

Undocumented

show_significance: float = ¶

Undocumented