5.1.2.2. numdifftools.step_generators.BasicMinStepGenerator¶

class BasicMinStepGenerator(base_step, step_ratio, num_steps, offset=0)[source]¶

Generates a sequence of steps of decreasing magnitude

where: steps = base_step * step_ratio ** (i + offset), i=num_steps-1,… 1, 0.

Parameters

base_stepfloat, array-like.: Defines the end step, i.e., minimum step
step_ratioreal scalar.: Ratio between sequential steps generated. Note: Ratio > 1
num_stepsscalar integer.: defines number of steps generated.
offsetreal scalar, optional, default 0: offset to the base step

Examples

>>> from numdifftools.step_generators import BasicMinStepGenerator
>>> step_gen = BasicMinStepGenerator(base_step=0.25, step_ratio=2,
...                                  num_steps=4)
>>> [s for s in step_gen()]
[2.0, 1.0, 0.5, 0.25]

__init__(base_step, step_ratio, num_steps, offset=0)¶

Methods

__init__(base_step, step_ratio, num_steps[, ...])