Class Minimise

Instance Methods

__init__(self, relax)
Class containing the calc, grid_search, minimise, and set functions.

calc(self, run=None, print_flag=1)
Function for calculating the function value.

grid_search(self, run=None, lower=None, upper=None, inc=None, constraints=1, print_flag=1)
The grid search function.

minimise(self, run=None, min_algor=None, min_options=None, func_tol=None, grad_tol=None, max_iterations=None, constraints=1, scaling=1, print_flag=1, sim_index=None)
Minimisation function.

reset_min_stats(self, run, index=None)
Function for resetting the minimisation statistics.

return_conversion_factor(self, stat_type)
Dummy function for returning 1.0.

return_data_name(self, name)
Minimisation statistic data type string matching patterns ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

return_grace_string(self, stat_type)
Function for returning the Grace string representing the data type for axis labelling.

return_units(self, stat_type)
Dummy function which returns None as the stats have no units.

return_value(self, run, index=None, stat_type=None, sim=None)
Function for returning the minimisation statistic corresponding to 'stat_type'.

set(self, run=None, value=None, error=None, param=None, scaling=None, index=None)
Minimisation statistic set details ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Method Details

return_data_name(self, name)

Minimisation statistic data type string matching patterns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

____________________________________________________________________________________________
|                        |              |                                                  |
| Data type              | Object name  | Patterns                                         |
|________________________|______________|__________________________________________________|
|                        |              |                                                  |
| Chi-squared statistic  | 'chi2'       | '^[Cc]hi2$' or '^[Cc]hi[-_ ][Ss]quare'           |
|                        |              |                                                  |
| Iteration count        | 'iter'       | '^[Ii]ter'                                       |
|                        |              |                                                  |
| Function call count    | 'f_count'    | '^[Ff].*[ -_][Cc]ount'                           |
|                        |              |                                                  |
| Gradient call count    | 'g_count'    | '^[Gg].*[ -_][Cc]ount'                           |
|                        |              |                                                  |
| Hessian call count     | 'h_count'    | '^[Hh].*[ -_][Cc]ount'                           |
|________________________|______________|__________________________________________________|

set(self, run=None, value=None, error=None, param=None, scaling=None, index=None)

Minimisation statistic set details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This shouldn't really be executed by a user.