blob: 9aadd28ed6d1f867f0312c05d07bdc299737ea4e (
plain)
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
76
77
78
79
80
81
82
83
84
85
86
87
88
|
% STK_GET_OPTIMIZABLE_PARAMETERS [STK internal]
%
% CALL: VALUE = stk_get_optimizable_parameters (PARAM)
%
% returns the value of the 'optimizable_parameters' property of PARAM.
%
% NOTE:
%
% Numerical arrays are considered as a special kind of parameter object, for
% which the 'optimizable_parameters' property is taken to be PARAM(:).
%
% INTERNAL FUNCTION WARNING:
%
% This function is currently considered as internal. STK users that wish to
% experiment with parameter classes can already overload it, but should be
% aware that API-breaking changes are likely to happen in future releases.
%
% See also: stk_set_optimizable_parameters
% Copyright Notice
%
% Copyright (C) 2016-2018 CentraleSupelec
%
% Author: Julien Bect <julien.bect@centralesupelec.fr>
% Copying Permission Statement
%
% This file is part of
%
% STK: a Small (Matlab/Octave) Toolbox for Kriging
% (http://sourceforge.net/projects/kriging)
%
% STK 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.
%
% STK 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 STK. If not, see <http://www.gnu.org/licenses/>.
function value = stk_get_optimizable_parameters (arg1)
% This function will catch all calls to stk_get_optimizable_parameters for which
% arg1 is not an object of a class that implements stk_get_optimizable_parameters.
if isstruct (arg1)
if isfield (arg1, 'K') && isfield (arg1, 'P')
% A very special case: parameter structure of a discrete covariance model
value = [];
else
% Assuming that arg1 is a model structure:
value = stk_get_optimizable_model_parameters (arg1);
end
else
if isnumeric (arg1)
param = arg1;
else
% Extract parameter values
param = arg1(:);
% Note: if param is an object, the previous line is actually a call to
% subsref in disguise. This way of supporting parameter objects has
% been introduced in STK 2.0.0 as an "experimental" feature. It is now
% deprecated.
end % if
% Make sure that the result is a column vector
value = param(:);
end
end % function
|
