summaryrefslogtreecommitdiff
path: root/inst/model/prior_struct/stk_set_optimizable_model_parameters.m
blob: 488b9e8ea9d7282e6aac458d83ccf8e86ee98eb1 (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
% STK_SET_OPTIMIZABLE_PARAMETERS [STK internal]
%
% 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) 2017, 2018 CentraleSupelec
%    Copyright (C) 2017 LNE
%
%    Authors:  Remi Stroh   <remi.stroh@lne.fr>
%              Julien Bect  <julien.bect@centralesupelec.fr>

% Copying Permission Statement
%
%    This file is part of
%
%            STK: a Small (Matlab/Octave) Toolbox for Kriging
%               (https://github.com/stk-kriging/stk/)
%
%    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 model = stk_set_optimizable_model_parameters (model, value)

stk_assert_model_struct (model);

% Covariance parameters
covparam = stk_get_optimizable_parameters (model.param);
covparam_size = length (covparam);

% Noise parameters
noiseparam = stk_get_optimizable_noise_parameters (model);
noiseparam_size = length (noiseparam);

total_size = covparam_size + noiseparam_size;

% Check length of value
if numel (value) ~= total_size
    stk_error (['The length of ''value'' must be equal to ' ...
        'the number of parameters.'], 'IncorrectSize');
end

% Change covariance parameter
if covparam_size > 0
    covparam = value(1:covparam_size);
    model.param = stk_set_optimizable_parameters (model.param, covparam);
end

% Change noise variance parameter
if noiseparam_size > 0
    noiseparam = value(covparam_size + (1:noiseparam_size));
    model.lognoisevariance = stk_set_optimizable_parameters ...
        (model.lognoisevariance, noiseparam);
end

end % function