Command:
getFactorParams ( |
|
What:
Retrieves the statistical parameters associated with a given factor
Parameters:
name [char*] |
must be the name of the factor of interest. It must begin with a letter and can contain only letters and numbers, this parameter cannot be null! |
maxNumPar [integer] |
maximum number of parameters to be stored in params. It can be retrieved invoking getNumFactorParams. (not necessary in Matlab) |
params [array of double] |
array where the result of the call should be stored |
Return:
error_code [int]: 1 if the operation has occurred without errors, 0 if an error has occurred
Warnings:
No memory will be allocated for the params array, it has to be made by the user. In the Matlab environment the call of the function is made without the parameters maxNumParams and params ( getFactorParams('name') ) since the maxNumParams is obtained directly via getNumFactorParams. Further the result of the call is coupled with getFactorParamNames to obtain a more explicit output
factor_params=getFactorParams('fac1')
this command in Matlab returns in the variable factor_params a structure containing the names of the statistical parameters related to the factor fac1 and the correspondent numerical values associated
- A Matlab example script using this command set_model_inputs.m