pyHarm.StepSizeRules.FactoryStepSize

Module that contains the factory of ABCStepSizeRule objects.

pyHarm.StepSizeRules.FactoryStepSize.StepSizer_dico

Dictionary containing the factory keywords and their associated class of ABCStepSizeRule objects.

Type:

dict

Attributes

StepSizer_dico

Dictionary containing the factory keywords and their associated class of ABCStepSizeRule objects.

Functions

generateStepSizeRule(...)

Factory function that creates a ABCStepSizeRule object.

Module Contents

pyHarm.StepSizeRules.FactoryStepSize.StepSizer_dico

Dictionary containing the factory keywords and their associated class of ABCStepSizeRule objects.

Type:

dict

pyHarm.StepSizeRules.FactoryStepSize.generateStepSizeRule(name_stepsize, bounds: list[float, float], stepsize_options) → pyHarm.StepSizeRules.ABCStepSizeRule.ABCStepSizeRule

Factory function that creates a ABCStepSizeRule object.

Parameters:

  • name_stepsize (str) – Type of the stepsize rule object that is to be instanciated.

  • bounds (list[float,float]) – list containing the bounds of the step-size [min_step, max_step].

  • stepsize_options (dict) – dictionary containing complementary keywords argument that is passed to the initialisation of the object.

Returns:

Instance of the required ABCStepSizeRule class.

Return type:

ABCStepSizeRule