Method mfh/fminsearch


  FMINSEARCH uses a simplex search to minimise the given function handle.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: FMINSEARCH uses a simplex search to minimise the given
               function handle.
 
  The function handle is minimised a function of its 'inputs' by calling
  MATLAB's fminsearch() function.
 
  CALL:        min = fminsearch(fh, pl)
 
  INPUTS:      fh   - input function handle object (@mfh)
               pl   - input parameter list
 
  OUTPUTS:    min   - output pest object containing fit details
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class mfh
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
fminsearch
PARAM NAMES {} [0x0] none A optional cell-array of parameter names to set in the final pest object. If empty, the input names from the function handle will be taken.
P0 [] none Array of initial parameter values. If empty, an array of ones of the appropriate length will be used.
TOLX [] none Termination tolerance on x, the current point. (See >> help fminsearch)
DISPLAY 'iter' none Display setting for fminsearch. (See >> help fminsearch)
MAXITER [] none Maximum number of iterations allowed. (See >> help fminsearch)
OPTIONS [] none A complete options structure (as defined by optimset) to pass to fminsearch. (See >> help fminsearch)
OUTPUT FILE [] none Filename for (optional) logging of search steps. No logging if empty.
SHOW PLOT 0
  • 0
  • 1
Displays search progress in a figure window
MODEL [] none Model function handle. If left empty we do not provide error.
DSTEP [] none Vector with derivative steps for each parameter.
APPLY NEGATIVE 0
  • 0
  • 1
For some cases (like for example a log-likelihood function), a negative sign is added to the numerical value, because the FMINSEARCH is a minimisation algorithm
YUNITS [] none The Y units of the parameters to be estimated. The 'UNIT' objects must be used.

Example

plist('PARAM NAMES', cell(0,0), 'P0', [[]], 'TOLX', [[]], 'DISPLAY', 'iter', 'MAXITER', [[]], 'OPTIONS', [[]], 'OUTPUT FILE', [[]], 'SHOW PLOT', [false], 'MODEL', [[]], 'DSTEP', [[]], 'APPLY NEGATIVE', [false], 'YUNITS', [[]])

back to top back to top

Some information of the method mfh/fminsearch are listed below:
Class name mfh
Method name fminsearch
Category Signal Processing
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 1
Supported numeric types {'double'}




©LTP Team