cocopp.pplogloss : API documentation

def table_caption():

Undocumented

def figure_caption():

Undocumented

def detERT(entry, funvals):

Undocumented

def detf(entry, evals):

Determines a function value given a number of evaluations.

Let A be the algorithm considered. Let f=f_A(evals) be the smallest target value such that the average running time of algorithm A was smaller than or equal to evals.

Parameters	DataSet entry	data set
	list evals	numbers of function evaluations considered
Returns	list of the target function values

def generateData(dsList, evals, CrE_A):

Undocumented

def boxplot(x, notch=0, sym='b+', positions=None, widths=None):

Makes a box and whisker plot.

Adapted from matplotlib.axes 0.98.5.2
Modified such that the caps are set to the 10th and 90th
percentiles, and to have some control on the colors.

call signature::

  boxplot(x, notch=0, sym='+', positions=None, widths=None)

Make a box and whisker plot for each column of *x* or each
vector in sequence *x*.  The box extends from the lower to
upper quartile values of the data, with a line at the median.
The whiskers extend from the box to show the range of the
data.  Flier points are those past the end of the whiskers.

- *notch* = 0 (default) produces a rectangular box plot.
- *notch* = 1 will produce a notched box plot

*sym* (default 'b+') is the default symbol for flier points.
Enter an empty string ('') if you don't want to show fliers.

*whis* (default 1.5) defines the length of the whiskers as
a function of the inner quartile range.  They extend to the
most extreme data point within ( ``whis*(75%-25%)`` ) data range.

*positions* (default 1,2,...,n) sets the horizontal positions of
the boxes. The ticks and limits are automatically set to match
the positions.

*widths* is either a scalar or a vector and sets the width of
each box. The default is 0.5, or ``0.15*(distance between extreme
positions)`` if that is smaller.

*x* is an array or a sequence of vectors.

Returns a dictionary mapping each component of the boxplot
to a list of the :class:`matplotlib.lines.Line2D`
instances created.

Copyright (c) 2002-2009 John D. Hunter; All Rights Reserved

def plot(xdata, ydata):

Plot the aRT log loss figures.

Two cases: box-whisker plot is used for representing the data of all functions, otherwise all data is represented using crosses.

def beautify():

Format the figure.

def generateTable(dsList, CrE=0.0, outputdir='.', info='default'):

Generates aRT loss ratio tables.

Parameters	DataSetList dsList	input data set
	float CrE	crafting effort (see COCO documentation)
	string outputdir	output folder (must exist)
	string info	string suffix for output file names

def generateSingleTableTex(dsList, funcs, mFE, d, prcOfInterest, EVALS, data, outputdir='.', info='default'):

Generates single aRT loss ratio table.

Parameters	DataSetList dsList	input data set
	funcs
	mFE
	d
	prcOfInterest
	EVALS
	data
	string outputdir	output folder (must exist)
	string info	string suffix for output file names

def generateSingleTableHtml(dsList, funcs, mFE, d, prcOfInterest, EVALS, data, outputdir='.', info='default'):

Generates single aRT loss ratio table.

Parameters	DataSetList dsList	input data set
	funcs
	mFE
	d
	prcOfInterest
	EVALS
	data
	string outputdir	output folder (must exist)
	string info	string suffix for output file names

def generateFigure(dsList, CrE=0.0, isStoringXRange=True, outputdir='.', info='default'):

Generates aRT loss ratio figures.

:param DataSetList dsList: input data set
:param float CrE: crafting effort (see COCO documentation)
:param bool isStoringXRange: if set to True, the first call to this
                             function sets the global
                             :py:data:`evalf` and all subsequent
                             calls will use this value as boundaries
                             in the generated figures.
:param string outputdir: output folder (must exist)
:param string info: string suffix for output file names

def main(dsList, CrE=0.0, isStoringXRange=True, outputdir='.', info='default'):

Generates aRT loss ratio boxplot figures.

Calls method generateFigure.

Function	table_caption	Undocumented
Function	figure_caption	Undocumented
Function	detERT	Undocumented
Function	detf	Determines a function value given a number of evaluations.
Function	generateData	Undocumented
Function	boxplot	Makes a box and whisker plot.
Function	plot	Plot the aRT log loss figures.
Function	beautify	Format the figure.
Function	generateTable	Generates aRT loss ratio tables.
Function	generateSingleTableTex	Generates single aRT loss ratio table.
Function	generateSingleTableHtml	Generates single aRT loss ratio table.
Function	generateFigure	Generates aRT loss ratio figures.
Function	main	Generates aRT loss ratio boxplot figures.

cocopp.pplogloss module documentation

`cocopp.pplogloss` module documentation