module documentation

For generating performance profiles. This module is not in use (anymore or not yet?).

Example

Function beautify Customize figure presentation.
Function main Generates image files of the performance profiles of algorithms
Function plot Generates a graph showing the performance profile of an algorithm.
Function plotmultiple Generate performance profile figure.
Variable best Undocumented
Variable defaulttargets Undocumented
Variable nbperdecade Undocumented
Variable styles Undocumented
def beautify():

Customize figure presentation.

def main(dictAlg, dsref=None, order=None, targets=defaulttargets, outputdir='', info='default', verbose=True):

Generates image files of the performance profiles of algorithms

From a dictionary of DataSetList sorted by algorithms, generates the performance profile (Moré:2008) on multiple functions for multiple targets altogether.

Parameters
dictAlgUndocumented
dsrefUndocumented
orderUndocumented
targetsUndocumented
outputdirUndocumented
infoUndocumented
verboseUndocumented
dict dictAlgdictionary of DataSetList instances, one dataSetList
list targetstarget function values
list ordersorted list of keys to dictAlg for plotting order
def plot(dsList, dsref, targets=defaulttargets, istoolsstats=False, **kwargs):

Generates a graph showing the performance profile of an algorithm.

We display the empirical cumulative distribution function ECDF of the bootstrapped distribution of the expected running time (ERT) for an algorithm to reach the function value targets normalized by the ERT of the reference algorithm for these targets.

Parameters
dsListUndocumented
dsrefUndocumented
targetsUndocumented
istoolsstatsUndocumented
DataSetList dsListdata set for one algorithm
DataSetList dsrefreference data set for normalization
seq targetstarget function values
dict kwargsadditional parameters provided to plot function.
**kwargsUndocumented
Returns
handles
def plotmultiple(dictAlg, dsref=None, order=None, targets=defaulttargets, istoolsstats=False, rhleg=True):

Generate performance profile figure.

Parameters
dictAlgUndocumented
dsrefUndocumented
orderUndocumented
targetsUndocumented
istoolsstatsUndocumented
rhlegUndocumented
dict dictAlgdictionary of DataSetList instances one instance = one algorithm
DataSetList dsrefreference data set
seq targetstarget function values
bool istoolsstatsif True, uses bootstrapped distribution
bool rhlegif True, displays the right-hand legend
best: tuple[str, ...] =

Undocumented

defaulttargets =

Undocumented

nbperdecade: int =

Undocumented

styles: list =

Undocumented