pymor.algorithms.rules

Module Contents

class pymor.algorithms.rules.RuleTable(use_caching=False)

Bases: pymor.core.base.BasicObject

Define algorithm by a table of match conditions and corresponding actions.

RuleTable manages a table of rules, stored in the rules attributes, which can be applied to given objects.

A new table is created by subclassing RuleTable and defining new methods which are decorated with match_class, match_generic or another rule subclass. The order of the method definitions determines the order in which the defined rules are applied.

Parameters:

use_caching – If True, cache results of apply.

rules

list of all defined rules.

Methods

append_rule	noindex:
apply	Sequentially apply rules to given object.
apply_children	Apply rules to all children of the given object.
breakpoint_for_name	Add a conditional breakpoint for objects of given name.
breakpoint_for_obj	Add a conditional breakpoint for given object.
get_children	Determine children of given object.
insert_rule	noindex:
replace_children	Replace children of object according to rule table.

append_rule(rule_)

apply(obj)

Sequentially apply rules to given object.

This method iterates over all rules of the given RuleTable. For each rule, it is checked if it matches the given object. If False, the next rule in the table is considered. If True the corresponding action is executed with obj as parameter. If execution of action raises RuleNotMatchingError, the rule is considered as not matching, and execution continues with evaluation of the next rule. Otherwise, execution is stopped and the return value of action is returned to the caller.

If no rule matches, a NoMatchingRuleError is raised.

Parameters:

obj – The object to apply the RuleTable to.

Returns:

Return value of the action of the first matching |rule| in the table.

Raises:

NoMatchingRuleError – No rule could be applied to the given object.

apply_children(obj, children=None)

Apply rules to all children of the given object.

This method calls apply to each child of the given object. The children of the object are either provided by the children parameter or automatically inferred by the get_children method.

Parameters:

• obj – The object to apply the RuleTable to.

• children – None or a list of attribute names defining the children to consider.

Returns:

Result of apply for all given children.

classmethod breakpoint_for_name(name)

Add a conditional breakpoint for objects of given name.

Break execution in apply, when being applied to an object with a certain name.

Parameters:

name – name of the object for which to add the conditional breakpoint.

classmethod breakpoint_for_obj(obj)

Add a conditional breakpoint for given object.

Break execution in apply, when being applied to a certain object.

Parameters:

obj – Object for which to add the conditional breakpoint.

classmethod get_children(obj)

Determine children of given object.

This method returns a list of the names of all attributes a, for which one of the following is true:

1. a is an Operator.

2. a is a dict` and each of its values is either an Operator or None.

3. a is a list or tuple and each of its elements is either an Operator or None.

4. a is an ‘np.ndarray` of dtype=object and each of its elements is either an Operator or None.

insert_rule(index, rule_)

replace_children(obj, children=None)

Replace children of object according to rule table.

Same as apply_children, but additionally calls obj.with_ to replace the children of obj with the result of the corresponding apply call.

class pymor.algorithms.rules.RuleTableMeta(name, bases, namespace)

Bases: pymor.core.base.UberMeta

Meta class for RuleTable.

class pymor.algorithms.rules.match_always(action)

Bases: rule

rule that always matches.

condition_type = 'ALWAYS'

class pymor.algorithms.rules.match_class(*classes)

Bases: match_class_base

rule that matches when obj is instance of one of the given classes.

condition_type = 'CLASS'

class pymor.algorithms.rules.match_class_all(*classes)

Bases: match_class_base

rule that matches when each item of obj is instance of one of the given classes.

condition_type = 'ALLCLASSES'

class pymor.algorithms.rules.match_class_any(*classes)

Bases: match_class_base

rule that matches when any item of obj is instance of one of the given classes.

condition_type = 'ANYCLASS'

class pymor.algorithms.rules.match_class_base(*classes)

Bases: rule

Base class for rules.

class pymor.algorithms.rules.match_generic(condition, condition_description=None)

Bases: rule

rule with matching condition given by an arbitrary function.

Parameters:

• condition – Function of one argument which checks if given object matches condition.

• condition_description – Optional string describing the condition implemented by condition.

condition_type = 'GENERIC'

class pymor.algorithms.rules.rule

Decorator to make a method a rule in a given RuleTable.

The decorated function will become the action to perform in case the rule matches. Matching conditions are specified by subclassing and overriding the matches method.

If an action is decorated by multiple rules, all these rules must match for the action to apply.

action

Method to call in case the rule matches.

Methods

matches

Returns True if given object matches the condition.

condition_description = None

condition_type = None

matches(obj)

Returns True if given object matches the condition.

pymor.algorithms.rules.format_rules(rules)

pymor.algorithms.rules.print_children(obj)

pymor.algorithms.rules.print_rules(rules)