Diff of /inst/nls_estimate.m [508d22] .. [eb5224]  Maximize  Restore

  Switch to unified view

a/inst/nls_estimate.m b/inst/nls_estimate.m
1
## Copyright (C) 2005  Michael Creel <michael.creel@uab.es>
1
## Copyright (C) 2005 Michael Creel <michael.creel@uab.es>
2
##
2
##
3
## This program is free software; you can redistribute it and/or modify
3
## This program is free software; you can redistribute it and/or modify it under
4
## it under the terms of the GNU General Public License as published by
4
## the terms of the GNU General Public License as published by the Free Software
5
## the Free Software Foundation; either version 2 of the License, or
5
## Foundation; either version 3 of the License, or (at your option) any later
6
## (at your option) any later version.
6
## version.
7
##
7
##
8
## This program is distributed in the hope that it will be useful,
8
## This program is distributed in the hope that it will be useful, but WITHOUT
9
## but WITHOUT ANY WARRANTY; without even the implied warranty of
9
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
11
## GNU General Public License for more details.
11
## details.
12
##
12
##
13
## You should have received a copy of the GNU General Public License
13
## You should have received a copy of the GNU General Public License along with
14
## along with this program; If not, see <http://www.gnu.org/licenses/>.
14
## this program; if not, see <http://www.gnu.org/licenses/>.
15
15
16
# usage:
16
## usage:
17
# [theta, obj_value, conv, iters] = nls_estimate(theta, data, model, modelargs, control, nslaves)
17
## [theta, obj_value, conv, iters] = nls_estimate(theta, data, model, modelargs, control, nslaves)
18
#
18
##
19
# inputs:
19
## inputs:
20
# theta: column vector of model parameters
20
## theta: column vector of model parameters
21
# data: data matrix
21
## data: data matrix
22
# model: name of function that computes the vector of sums of squared errors
22
## model: name of function that computes the vector of sums of squared errors
23
# modelargs: (cell) additional inputs needed by model. May be empty ("")
23
## modelargs: (cell) additional inputs needed by model. May be empty ("")
24
# control: (optional) BFGS or SA controls (see bfgsmin and samin). May be empty ("").
24
## control: (optional) BFGS or SA controls (see bfgsmin and samin). May be empty ("").
25
# nslaves: (optional) number of slaves if executed in parallel (requires MPITB)
25
## nslaves: (optional) number of slaves if executed in parallel (requires MPITB)
26
#
26
##
27
# outputs:
27
## outputs:
28
# theta: NLS estimated value of parameters
28
## theta: NLS estimated value of parameters
29
# obj_value: the value of the sum of squared errors at NLS estimate
29
## obj_value: the value of the sum of squared errors at NLS estimate
30
# conv: return code from bfgsmin (1 means success, see bfgsmin for details)
30
## conv: return code from bfgsmin (1 means success, see bfgsmin for details)
31
# iters: number of BFGS iteration used
31
## iters: number of BFGS iteration used
32
#
32
##
33
# please see nls_example.m for examples of how to use this
33
## please see nls_example.m for examples of how to use this
34
34
function [theta, obj_value, convergence, iters] = nls_estimate(theta, data, model, modelargs, control, nslaves)
35
function [theta, obj_value, convergence, iters] = nls_estimate(theta, data, model, modelargs, control, nslaves)
35
36
36
    if nargin < 3
37
    if nargin < 3
37
        error("nls_estimate: 3 arguments required");
38
        error("nls_estimate: 3 arguments required");
38
    endif
39
    endif