simpeg.typing.MinimizeCallable#
- simpeg.typing.MinimizeCallable[source]#
- The callable expected for the minimization operations. - The function’s signature should look like: - func(x: numpy.ndarray, return_g: bool, return_H: bool) - It should output up to three values ordered as: - f_val : float gradient : numpy.ndarray H : LinearOperator - f_val is always returned, gradient is returned if return_g, and H_func is returned if return_H. f_val should always be the first value returned, gradient will always be the second, and H_func will always be the last. If return_g == return_H == False, then only the single argument f_val is returned. - alias of - Callable[[- ndarray,- bool,- bool],- float|- tuple[- float,- ndarray|- LinearOperator] |- tuple[- float,- ndarray,- LinearOperator]]
