tools

Module Contents

Classes

Functions

Attributes

_workspace_path

class text_format

software_version()

find_and_replace(begin_char, end_char, theStr, replace_function)

create_unique_dirname(dirname)

Create dirname if it doesn’t exists, otherwise append an integer to dirname and create it.

Parameters:dirname – name of the directory to create Returns:name of the directory created

applyEquation(objectIn, s)

Apply literal expression based on an object

Parameters:

• objectIn – Object
• s – literal expression. Float variables taken from the object are written between {}, int between []. Example: s=”{x}+{y}*2” if x and y are attributes of objectIn.

Returns:

value (float)

arithmeticEval(s)

isNonePrintMessage(theObject, theMessage, show_type=SHOW_INFO)

getPath_workspace()

Get workspace path (i.e., location where optimeed files will be created). Create directory if doesn’t exist.

setPath_workspace(thePath)

Set workspace path (i.e., location where optimeed files will be created)

getLineInfo(lvl=1)

printIfShown(theStr, show_type=SHOW_DEBUG, isToPrint=True, appendTypeName=True, end='n')

universalPath(thePath)

add_suffix_to_path(thePath, suffix)

get_object_attrs(obj)

rsetattr(obj, attr, val)

setattr, but recursively. Works with list (i.e. theObj.myList[0].var_x)

rgetattr(obj, attr)

getattr, but recursively. Works with list.

indentParagraph(text_in, indent_level=1)

Add ‘ ‘ at beginning of strings and after each ‘ ‘.

truncate(theStr, truncsize)

get_recursive_attrs(theObject, max_recursion_level=2)

str_all_attr(theObject, max_recursion_level)

get_2D_pareto(xList, yList, max_X=True, max_Y=True)

Get 2D pareto front

Parameters:

• xList – list of x coordinates
• yList – list of y coordinates
• max_X – True if x is to maximize
• max_Y – true if y is to maximize

Returns:

x pareto-optimal coordinates, y pareto-optimal coordinates, indices of these points in input parameters

get_ND_pareto(objectives_list, are_maxobjectives_list=None)

Return the N-D pareto front

Parameters:

• objectives_list – list of list of objectives: example [[0,1], [1,1], [2,2]]
• are_maxobjectives_list – for each objective, tells if they are to be maximized or not: example [True, False]. Default: False

Returns:

extracted_pareto, indices: list of [x, y, …] points forming the pareto front, and list of the indices of these points from the base list.

delete_indices_from_list(indices, theList)

Delete elements from list at indices

Parameters:

• indices – list
• theList – list

merge_two_dicts(dict1, dict2)

Merge two dicts without affecting them

Returns:new dictionary

deep_sizeof(obj)

order_lists(ref_list, linked_list)