Functions
def	create_empty_figure (nRows=1, nCols=1, figsize=(7, 7), spinesPos=None, sharex=True)

def	grayify_cmap (cmap)

def	movePlotSpines (ax, spinesPos)

def	plot3dQuantity (quantity, title, ax=None, boundUp=None, boundLow=None, yscale="linear", linestyle="k")

def	plotNdQuantity (nRows, nCols, quantity, title="", ax=None, boundUp=None, boundLow=None, yscale="linear", linestyle="k--", sharey=False, margins=None)

def	plotNdQuantityPerSolver (nRows, nCols, quantity, title, solver_names, line_styles, ax=None, boundUp=None, boundLow=None, yscale="linear", subplot_titles=None, ylabels=None, sharey=False, margins=None, x=None)

def	plotQuantityPerSolver (quantity, title, solver_names, line_styles, yscale="linear", ylabel="", x=None, xlabel="", legend_location="best")

def	plotQuantityVsQuantityPerSolver (quantity, quantityPerSolver, legend, solver_names, line_styles, yscale="linear")

def	saveFigure (title)

def	setAxisFontSize (ax, size)

Variables
string	BOUNDS_COLOR = "silver"

int	DEFAULT_AXES_LABEL_SIZE = DEFAULT_FONT_SIZE

int	DEFAULT_AXIS_FONT_SIZE = DEFAULT_FONT_SIZE

string	DEFAULT_FIGURE_FACE_COLOR = "white"

string	DEFAULT_FONT_FAMILY = "sans-serif"

list	DEFAULT_FONT_SERIF

int	DEFAULT_FONT_SIZE = 20

int	DEFAULT_LEGEND_FONT_SIZE = DEFAULT_FONT_SIZE

int	DEFAULT_LINE_WIDTH = 4

int	DEFAULT_MARKER_SIZE = 6

bool	DEFAULT_TEXT_USE_TEX = False

string	FIGURE_PATH = "./"

int	FIGURES_DPI = 150

list	FILE_EXTENSIONS = ["png"]

float	LEGEND_ALPHA = 0.5

float	LINE_ALPHA = 0.9

int	LINE_WIDTH_MIN = 1

int	LINE_WIDTH_RED = 0

bool	SAVE_FIGURES = False

bool	SHOW_FIGURES = False

bool	SHOW_LEGENDS = False

Function Documentation

◆ create_empty_figure()

def plot_utils.create_empty_figure	(	nRows = `1`,
		nCols = `1`,
		figsize = `(7, 7)`,
		spinesPos = `None`,
		sharex = `True`
	)

Definition at line 67 of file plot_utils.py.

◆ grayify_cmap()

def plot_utils.grayify_cmap ( cmap )

Return a grayscale version of the colormap

Definition at line 396 of file plot_utils.py.

◆ movePlotSpines()

def plot_utils.movePlotSpines	(	ax,
		spinesPos
	)

Definition at line 81 of file plot_utils.py.

◆ plot3dQuantity()

def plot_utils.plot3dQuantity	(	quantity,
		title,
		ax = `None`,
		boundUp = `None`,
		boundLow = `None`,
		yscale = `"linear"`,
		linestyle = `"k"`
	)

Definition at line 119 of file plot_utils.py.

◆ plotNdQuantity()

def plot_utils.plotNdQuantity	(	nRows,
		nCols,
		quantity,
		title = `""`,
		ax = `None`,
		boundUp = `None`,
		boundLow = `None`,
		yscale = `"linear"`,
		linestyle = `"k--"`,
		sharey = `False`,
		margins = `None`
	)

Definition at line 137 of file plot_utils.py.

◆ plotNdQuantityPerSolver()

def plot_utils.plotNdQuantityPerSolver	(	nRows,
		nCols,
		quantity,
		title,
		solver_names,
		line_styles,
		ax = `None`,
		boundUp = `None`,
		boundLow = `None`,
		yscale = `"linear"`,
		subplot_titles = `None`,
		ylabels = `None`,
		sharey = `False`,
		margins = `None`,
		x = `None`
	)

Definition at line 179 of file plot_utils.py.

◆ plotQuantityPerSolver()

def plot_utils.plotQuantityPerSolver	(	quantity,
		title,
		solver_names,
		line_styles,
		yscale = `"linear"`,
		ylabel = `""`,
		x = `None`,
		xlabel = `""`,
		legend_location = `"best"`
	)

Definition at line 325 of file plot_utils.py.

◆ plotQuantityVsQuantityPerSolver()

def plot_utils.plotQuantityVsQuantityPerSolver	(	quantity,
		quantityPerSolver,
		legend,
		solver_names,
		line_styles,
		yscale = `"linear"`
	)

Definition at line 357 of file plot_utils.py.

◆ saveFigure()

def plot_utils.saveFigure ( title )

Definition at line 410 of file plot_utils.py.

◆ setAxisFontSize()

def plot_utils.setAxisFontSize	(	ax,
		size
	)

Definition at line 90 of file plot_utils.py.

Variable Documentation

◆ BOUNDS_COLOR

string plot_utils.BOUNDS_COLOR = "silver"

Definition at line 48 of file plot_utils.py.

◆ DEFAULT_AXES_LABEL_SIZE

int plot_utils.DEFAULT_AXES_LABEL_SIZE = DEFAULT_FONT_SIZE

Definition at line 36 of file plot_utils.py.

◆ DEFAULT_AXIS_FONT_SIZE

int plot_utils.DEFAULT_AXIS_FONT_SIZE = DEFAULT_FONT_SIZE

Definition at line 14 of file plot_utils.py.

◆ DEFAULT_FIGURE_FACE_COLOR

string plot_utils.DEFAULT_FIGURE_FACE_COLOR = "white"

Definition at line 34 of file plot_utils.py.

◆ DEFAULT_FONT_FAMILY

string plot_utils.DEFAULT_FONT_FAMILY = "sans-serif"

Definition at line 17 of file plot_utils.py.

◆ DEFAULT_FONT_SERIF

list plot_utils.DEFAULT_FONT_SERIF

Initial value:

 =  [
     "Times New Roman",
     "Times",
     "Bitstream Vera Serif",
     "DejaVu Serif",
     "New Century Schoolbook",
     "Century Schoolbook L",
     "Utopia",
     "ITC Bookman",
     "Bookman",
     "Nimbus Roman No9 L",
     "Palatino",
     "Charter",
     "serif",
 ]

Definition at line 19 of file plot_utils.py.

◆ DEFAULT_FONT_SIZE

int plot_utils.DEFAULT_FONT_SIZE = 20

Definition at line 13 of file plot_utils.py.

◆ DEFAULT_LEGEND_FONT_SIZE

int plot_utils.DEFAULT_LEGEND_FONT_SIZE = DEFAULT_FONT_SIZE

Definition at line 35 of file plot_utils.py.

◆ DEFAULT_LINE_WIDTH

int plot_utils.DEFAULT_LINE_WIDTH = 4

Definition at line 15 of file plot_utils.py.

◆ DEFAULT_MARKER_SIZE

int plot_utils.DEFAULT_MARKER_SIZE = 6

Definition at line 16 of file plot_utils.py.

◆ DEFAULT_TEXT_USE_TEX

bool plot_utils.DEFAULT_TEXT_USE_TEX = False

Definition at line 37 of file plot_utils.py.

◆ FIGURE_PATH

string plot_utils.FIGURE_PATH = "./"

Definition at line 45 of file plot_utils.py.

◆ FIGURES_DPI

int plot_utils.FIGURES_DPI = 150

Definition at line 41 of file plot_utils.py.

◆ FILE_EXTENSIONS

list plot_utils.FILE_EXTENSIONS = ["png"]

Definition at line 40 of file plot_utils.py.

◆ LEGEND_ALPHA

float plot_utils.LEGEND_ALPHA = 0.5

Definition at line 43 of file plot_utils.py.

◆ LINE_ALPHA

float plot_utils.LINE_ALPHA = 0.9

Definition at line 38 of file plot_utils.py.

◆ LINE_WIDTH_MIN

int plot_utils.LINE_WIDTH_MIN = 1

Definition at line 47 of file plot_utils.py.

◆ LINE_WIDTH_RED

int plot_utils.LINE_WIDTH_RED = 0

Definition at line 46 of file plot_utils.py.

◆ SAVE_FIGURES

bool plot_utils.SAVE_FIGURES = False

Definition at line 39 of file plot_utils.py.

◆ SHOW_FIGURES

bool plot_utils.SHOW_FIGURES = False

Definition at line 44 of file plot_utils.py.

◆ SHOW_LEGENDS

bool plot_utils.SHOW_LEGENDS = False

Definition at line 42 of file plot_utils.py.

Functions

Variables