fitbenchmarking.jacobian.base_jacobian module

Implements the base class for the Jacobian.

class fitbenchmarking.jacobian.base_jacobian.Jacobian(problem)

Bases: object

Base class for Jacobian.

INCOMPATIBLE_PROBLEMS = {}
abstract eval(params, **kwargs)

Evaluates Jacobian of the model, \(\nabla_p f(x,p)\), at the point given by the parameters.

Parameters:

params (list) – The parameter values at which to evaluate the Jacobian

Returns:

Computed Jacobian

Return type:

numpy array

property method

Utility function to get the numerical method

Returns:

the names of the parameters

Return type:

list of str

name() str

Get a name for the current status of the jacobian.

Returns:

A unique name for this jacobian/method combination

Return type:

str