numdifftools.core.MaxStepGenerator

class numdifftools.core.MaxStepGenerator(step_max=2.0, step_ratio=2.0, num_steps=15, step_nom=None, offset=0, num_extrap=0, use_exact_steps=False, check_num_steps=True)[source][source]

Generates a sequence of steps

where
steps = base_step * step_ratio ** (-np.arange(num_steps) + offset) base_step = step_max * step_nom
Parameters:

max_step : float, array-like, optional default 2

Defines the maximum step

step_ratio : real scalar, optional, default 2

Ratio between sequential steps generated. Note: Ratio > 1

num_steps : scalar integer, optional, default n + order - 1 + num_extrap

defines number of steps generated. It should be larger than n + order - 1

step_nom : default maximum(log1p(abs(x)), 1)

Nominal step.

offset : real scalar, optional, default 0

offset to the base step: max_step * nom_step

__init__(step_max=2.0, step_ratio=2.0, num_steps=15, step_nom=None, offset=0, num_extrap=0, use_exact_steps=False, check_num_steps=True)[source][source]

Methods

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