misc Package

misc Package

This module contains several useful functions and classes that dont fit in any other modules.

progress_display Module

Displays the progress during the computing.

class ABXpy.misc.progress_display.ProgressDisplay

Bases: object

add(name, message, total)

display()

update(name, amount)

tinytree Module

class ABXpy.misc.tinytree.Tree(children=None)

Bases: object

A simple implementation of an ordered tree

addChild(node)

Add a child to this node.

:child A Tree object

addChildrenFromList(children)

Add children to this node.

:children A nested list specifying a tree of children

attrsToRoot(attr)

Traverses the path from this node to the root of the tree, and yields a value for each attribute. Nodes that do not have the attribute and attribute values that test false are ignored.

:attr A string attribute name

clear()

Clear all the children of this node. Return a list of the removed children.

count()

Number of nodes in this tree, including the root.

dump(outf=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Dump a formatted representation of this tree to the specified file descriptor.

:outf Output file descriptor.

findAttr(attr, default=None)

Traverses the path to the root of the tree, looking for the specified attribute. If it is found, return it, else return default.

:attr A string attribute name :default Arbitrary default return value

findBackwards(*func, **kwargs)

Search backwards in a preOrder traversal of the whole tree (not this node’s subnodes). Return None if object not found.

:func A list of selector functions, that accept a node, and return a boolean.

:kwargs A dictionary of attribute selectors. Checks that matching attributes exist, and that their values are equal to the specified values.

findChild(*func, **kwargs)

Find the first child matching all specified selectors in a pre-order traversal of this node’s subnodes. Return None if no matching object is found.

:func A list of selector functions, that accept a node, and return a boolean.

:kwargs A dictionary of attribute selectors. Checks that matching attributes exist, and that their values are equal to the specified values.

findForwards(*func, **kwargs)

Search forwards in a preOrder traversal of the whole tree (not this node’s subnodes). Return None if object not found.

:func A list of selector functions, that accept a node, and return a boolean.

:kwargs A dictionary of attribute selectors. Checks that matching attributes exist, and that their values are equal to the specified values.

findParent(*func, **kwargs)

Find the first node matching func in a traversal to the root of the tree. Return None if no matching object is found.

:func A list of selector functions, that accept a node, and return a boolean.

:kwargs A dictionary of attribute selectors. Checks that matching attributes exist, and that their values are equal to the specified values.

getDepth()

Return the depth of this node, i.e. the number of nodes on the path to the root.

getNext()

Find the next node in the preOrder traversal of the tree.

getPrevious()

Find the previous node in the preOrder traversal of the tree.

getRoot()

Return the topmost node in the tree.

index()

Return the index of this node in the parent child list, based on object identity.

inject(node)

Inserts a node between the current node and its children. Returns the specified parent node.

:node A Tree object

isDescendantOf(node)

Returns true if this node lies on the path to the root from the specified node.

:node A Tree object

isSiblingOf(node)

Returns true if this node is a sibling of the specified node.

:node A Tree object

pathFromRoot()

Generator yielding all nodes on the path to this node from the root of the tree, including this node itself.

pathToRoot()

Generator yielding all objects on the path from this node to the root of the tree, including this node itself.

postOrder()

Return a list of the subnodes in PostOrder.

preOrder()

Return a list of subnodes in PreOrder.

register(parent)

Called after a node has been added to a parent.

:child A Tree object

remove()

Remove this node from its parent. Returns the index this node had in the parent child list.

reparent(node)

Inserts a node between the current node and its parent. Returns the specified parent node.

:node A Tree object

replace(*nodes)

Replace this node with a sequence of other nodes. This is equivalent to deleting this node from the child list, and then inserting the specified sequence in its place.

:nodes A sequence of Tree objects

siblings()

Generator yielding all siblings of this node, including this node itself.

static treeProp(name)

Define a property whose value should be looked up on nodes between this node and the root, inclusive. Returns the first matching attribute. Raises ValueError if no matching attribute is found.

:name Property name

ABXpy.misc.tinytree.constructFromList(lst)

:lst a nested list of Tree objects

Returns a list consisting of the nodes at the base of each tree. Trees are constructed “bottom-up”, so all parent nodes for a particular node are guaranteed to exist when “addChild” is run.

type_fitting Module

ABXpy.misc.type_fitting.fit_integer_type(n, is_signed=True)

Returns the minimal space needed to store integers of maximal value n