VF_multiNonlinfit and VF_multiNonlinfitwW (OptiVec matrix function)">VF_multiNonlinfit, VF_multiNonlinfitwW">
VF_multiNonlinfit_... VD_multiNonlinfit_... VE_multiNonlinfit_...
VF_multiNonlinfitwW_... VD_multiNonlinfitwW_... VE_multiNonlinfitwW_...
..._autoDeriv
..._getChi2
..._getChi2Detail
..._getBestValues
..._getTestRun
..._getTestPar
..._getTestDir
..._stop
Functionhelper functions for VF_multiNonlinfit and VF_multiNonlinfitwW
Syntax C/C++#include <MFstd.h>
void VF_multiNonlinfit_autoDeriv( fVector dYdAi, fVector X, ui size, unsigned ipar, unsigned iexperiment, VF_NONLINFITWORKSPACE *ws );
float VF_multiNonlinfit_getChi2( VF_NONLINFITWORKSPACE *ws );
void VF_multiNonlinfit_getChi2Detail( fVector Chi2Detail, VF_NONLINFITWORKSPACE *ws ); void VF_multiNonlinfit_getBestValues( fVector ABest, VF_NONLINFITWORKSPACE *ws );
int VF_multiNonlinfit_getTestDir( VF_NONLINFITWORKSPACE *ws );
unsigned VF_multiNonlinfit_getTestPar( VF_NONLINFITWORKSPACE *ws );
unsigned VF_multiNonlinfit_getTestRun( VF_NONLINFITWORKSPACE *ws );
void VF_multiNonlinfit_stop( VF_NONLINFITWORKSPACE *ws );

  (identical syntax for the VF_multiNonlinfitwW_... functions)
Pascal/Delphiuses VFmnlfit;
procedure VF_multiNonlinfit_autoDeriv( dYdAi, X:fVector; size:UIntSize; ipar, iex:UInt; PVF_NONLINFITWORKSPACE ws );
function VF_multiNonlinfit_getChi2( PVF_NONLINFITWORKSPACE ws ): Single;
procedure VF_multiNonlinfit_getChi2Detail( Chi2Detail:fVector; PVF_NONLINFITWORKSPACE ws );
procedure VF_multiNonlinfit_getBestValues( BestValues: fVector; PVF_NONLINFITWORKSPACE ws );
function VF_multiNonlinfit_getTestDir( PVF_NONLINFITWORKSPACE ws ): Integer;
function VF_multiNonlinfit_getTestPar( PVF_NONLINFITWORKSPACE ws ): UInt;
function VF_multiNonlinfit_getTestRun( PVF_NONLINFITWORKSPACE ws ): UInt;
procedure VF_multiNonlinfit_stop( PVF_NONLINFITWORKSPACE ws );

  (identical syntax for the VF_multiNonlinfitwW_... functions)
DescriptionVF_multiNonlinfit_autoDeriv performs a numerical differentiation of a user-provided y=f(x) model function with respect to the parameter aipar of the model. All necessary information (model function, current state of parameter set, etc.) is passed to this function through the pointer to the VF_NONLINFITWORKSPACE used in the current VF_multiNonlinfit operation.

The following functions allow to monitor the progress of a nonlinear fitting operation. They can either be called from within the provided model function or, for multi-thread applications, from a second thread running in parallel to the thread containing the fitting function.
VF_multiNonlinfit_getChi2 returns the best figure-of-merit (c2 or, for robust fits, |c|) obtained so far. If you call this function before VF_multiNonlinfit has had the chance to calculate c2, VF_multiNonlinfit_getChi2 returns -1.0.

VF_multiNonlinfit_getChi2Detail fills the user-supplied vector Chi2Detail with the individual figures-of-merit (c2iex or, for robust fits, |ciex|) for all experiments. The sum over these individual c2iex or |ciex| values is the best c2 (or |c|) obtained so far, as returned by VF_multiNonlinfit_getChi2.

VF_multiNonlinfit_getBestValues stores the best parameters ai obtained so far into the user-supplied vector ABest.

VF_multiNonlinfit_getTestDir returns the test direction (+1 for upwards, -1 for downwards) during "breakout" attempts from possible local optima which would otherwise prevent the routine from finally reaching the global optimum (level-of-method greater than 3 specified by VF_setNonlinfitOptions).

VF_multiNonlinfit_getTestPar returns the index of the parameter currently under "breakout" investigation.

VF_multiNonlinfit_getTestRun returns the index of the current "breakout" test run. For each fitted parameter, one test run is performed. The order in which the parameters are checked is determined internally in such a way as to test the most sensitive parameters first.

VF_multiNonlinfit_stop makes VF_multiNonlinfit finish its current Levenberg-Marquardt or Downhill-Simplex cycle, update the output parameters and return. Thereby, long fitting sessions (especially tedious "break-out" attempts) may be broke off without the loss of any data.

See alsochapter 13

MatrixLib Table of Contents  OptiVec home