secant

kgpy.optimization.root_finding.secant(func, root_guess, step_size, max_abs_error=None, max_iterations=100, damping=1)
Return type:

typing.TypeVar(InputT, bound= typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray, VectorInterface])

Parameters:
  • func (Callable[[InputT], OutputT]) –

  • root_guess (InputT) –

  • step_size (InputT) –

  • max_abs_error (OutputT | None) –

  • max_iterations (int) –

  • damping (float) –