module documentation

Creates ERTs and convergence figures for multiple algorithms.

Function beautify Customize figure format.
Function ecdfs_figure_caption Undocumented
Function fix_styles a short hack to fix length of styles
Function generateData Returns an array of results to be plotted.
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
Variable fontsize Undocumented
Variable legend Undocumented
Variable legend_text_max_len Undocumented
Variable refcolor Undocumented
Variable show_algorithms Undocumented
Variable show_significance Undocumented
def beautify(legend=False, rightlegend=False):

Customize figure format.

adding a legend, axis label, etc

Parameters
legendUndocumented
rightlegendUndocumented
bool legendif True, display a box legend
bool rightlegendif 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 generateData(dataSet, target):

Returns an array of results to be plotted.

Oth column is ert, 1st is the success rate, 2nd the number of successes, 3rd the mean of the number of function evaluations, and 4th the median of number of function evaluations of successful runs or numpy.nan.

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

fontsize: float =

Undocumented

legend: bool =

Undocumented

legend_text_max_len: int =

Undocumented

refcolor: str =

Undocumented

show_algorithms: list =

Undocumented

show_significance: float =

Undocumented