5.1.2.1. numdifftools.step_generators.BasicMaxStepGenerator

class BasicMaxStepGenerator(base_step, step_ratio, num_steps, offset=0)

Generates a sequence of steps of decreasing magnitude

where

steps = base_step * step_ratio ** (-i + offset)

for i=0, 1,.., num_steps-1.

Parameters

base_stepfloat, array-like.

Defines the start step, i.e., maximum 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 BasicMaxStepGenerator
>>> step_gen = BasicMaxStepGenerator(base_step=2.0, 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[, ...])