numdifftools.core.MinStepGenerator

class numdifftools.core.MinStepGenerator(base_step=None, step_ratio=2, num_steps=None, offset=0, scale=None, num_extrap=0, use_exact_steps=True, check_num_steps=True)[source][source]

Generates a sequence of steps

where steps = base_step * step_ratio ** (np.arange(num_steps) + offset)

Parameters:

base_step : float, array-like, optional

Defines the base step, if None, then base_step is set to EPS**(1/scale)*max(log(1+|x|), 1) where x is supplied at runtime through the __call__ method.

step_ratio : real scalar, optional, default 2

Ratio between sequential steps generated. Note: Ratio > 1 If None then step_ratio is 2 for n=1 otherwise step_ratio is 1.6

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

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

offset : real scalar, optional, default 0

offset to the base step

scale : real scalar, optional

scale used in base step. If not None it will override the default computed with the default_scale function.

__init__(base_step=None, step_ratio=2, num_steps=None, offset=0, scale=None, num_extrap=0, use_exact_steps=True, check_num_steps=True)[source][source]

Methods

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