fitbenchmarking.parsing.nist_data_functions module

Functions that prepare the function specified in NIST problem definition file into the right format for SciPy.

fitbenchmarking.parsing.nist_data_functions.format_function_scipy(function)

Formats the function string such that it is scipy-ready.

Parameters:

function (str) – The function to be formatted

Returns:

The formatted function

Return type:

str

fitbenchmarking.parsing.nist_data_functions.is_int(value)

Checks to see if a value is an integer or not

Parameters:

value (str) – String representation of an equation

Returns:

Whether or not value is an int

Return type:

bool

fitbenchmarking.parsing.nist_data_functions.is_safe(func_str)

Verifies that a string is safe to be passed to exec in the context of an equation.

Parameters:

func_str (string) – The function to be checked

Returns:

Whether the string is of the expected format for an equation

Return type:

bool

fitbenchmarking.parsing.nist_data_functions.nist_func_definition(function, param_names)

Processing a function plus different set of starting values as specified in the NIST problem definition file into a callable

Parameters:
  • function (str) – function string as defined in a NIST problem definition file

  • param_names (list) – names of the parameters in the function

Returns:

callable function

Return type:

callable

fitbenchmarking.parsing.nist_data_functions.nist_hessian_definition(hessian, param_names)

Processing a Hessian into a callable

Parameters:
  • hessian (str) – Hessian string as defined in the data files for the corresponding NIST problem definition file

  • param_names (list) – names of the parameters in the function

Returns:

callable function

Return type:

callable

fitbenchmarking.parsing.nist_data_functions.nist_jacobian_definition(jacobian, param_names)

Processing a Jacobian plus different set of starting values as specified in the NIST problem definition file into a callable

Parameters:
  • jacobian (str) – Jacobian string as defined in the data files for the corresponding NIST problem definition file

  • param_names (list) – names of the parameters in the function

Returns:

callable function

Return type:

callable