1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
## Copyright (C) 2008-2015 Jaroslav Hajek
## Copyright (C) 2009 VZLU Prague
##
## This function is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## This function is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this function; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {} statget (@var{options}, @var{parname})
## @deftypefnx {Function File} {} statget (@var{options}, @var{parname}, @var{default})
## Return the specific option @var{parname} from the statistics options
## structure @var{options} created by @code{statset}.
##
## If @var{parname} is not defined then return @var{default} if supplied,
## otherwise return an empty matrix.
##
## @seealso{statset}
## @end deftypefn
## Copied from Octave (was 'optimset') (Asma Afzal <asmaafzal5@gmail.com>).
function retval = statget (options, parname, default)
if (nargin < 2 || nargin > 4 || ! isstruct (options) || ! ischar (parname))
print_usage ();
endif
## Expand partial-length names into full names
opts = __all_stat_opts__ ();
idx = strncmpi (opts, parname, length (parname));
nmatch = sum (idx);
if (nmatch == 1)
parname = opts{idx};
elseif (nmatch == 0)
warning ("statget: unrecognized option: %s", parname);
else
fmt = sprintf ("statget: ambiguous option: %%s (%s%%s)",
repmat ("%s, ", 1, nmatch-1));
warning (fmt, parname, opts{idx});
endif
if (isfield (options, parname) && ! isempty (options.(parname)))
retval = options.(parname);
elseif (nargin > 2)
retval = default;
else
retval = [];
endif
endfunction
%!shared opts
%! opts = statset ("maxit", 100);
%!assert (statget (opts, "maxit"), 100)
%!assert (statget (opts, "MaxITer"), 100)
%!assert (statget (opts, "TolFun"), [])
%!assert (statget (opts, "TolFun", 1e-3), 1e-3)
## Test input validation
%!error statget ()
%!error statget (1)
%!error statget (1,2,3,4,5)
%!error statget (1, "name")
%!error statget (struct (), 2)
|
