summaryrefslogtreecommitdiff
path: root/inst/sampling/@stk_sampcrit_eqi/set.m
blob: 9c81c7575aff242f9ce7d6a0a46b0bf3ee4bdafa (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
% @STK_SAMPCRIT_EQI/SET [overload base function]

% Copyright Notice
%
%    Copyright (C) 2017 CentraleSupelec
%
%    Author:  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 crit = set (crit, propname, value)

switch propname
    
    case 'model'
        
        if isempty (value)
            
            crit.model = [];
            crit.current_minimum = +inf;
            
        else
            
            crit.model = value;
            crit.current_minimum = compute_current_minimum (crit);
            
        end
        
    case 'quantile_order'
        
        order = double (value);
        
        if (~ isscalar (order)) || (order < 0) || (order > 1)
            stk_error (['The value of property ''quantile_order'' ' ...
                'must be a scalar between 0 and 1.'], 'InvalidArgument');
        else
            crit.quantile_order = order;
            try
                crit.quantile_value = norminv (order);
            catch
                crit.quantile_value = - sqrt (2) * erfcinv (2 * order);  % CG#09
            end
        end
        
        if ~ isempty (crit.model)
            crit.current_minimum = compute_current_minimum (crit);
        end
        
    case 'point_batch_size'
        
        if ischar (value)
            
            crit.point_batch_size = str2func (value);
            
        elseif isa (value, 'function_handle')
            
            crit.point_batch_size = value;
            
        else  % Last possibility: a fixed numeric value
            
            point_batch_size = double (value);
            
            if (~ isscalar (point_batch_size)) || (point_batch_size <= 0) ...
                    || (point_batch_size ~= floor (point_batch_size))
                stk_error ('Incorrect ''point_batch_size'' value', ...
                    'InvalidArgument');
            else
                crit.point_batch_size = point_batch_size;
            end
            
        end
        
    case 'current_minimum'  % Visible but read-only property
        
        stk_error (sprintf (['Property ''current_minimum'' is read-only.' ...
            '\n\nWHY: The value of ''current_minimum'' is computed '      ...
            'automatically from the input data of the model.']),          ...
            'ReadOnlyProperty');
        
    case 'quantile_value'  % Hidden, read-only property
        
        stk_error (sprintf (['Property ''quantile_value'' is read-only.' ...
            '\n\nWHY: The value of ''quantile_value'' is computed '      ...
            'automatically from the value of ''quantile_order''.']),     ...
            'ReadOnlyProperty');
        
    otherwise
        
        errmsg = sprintf ('There is no property named %s', propname);
        stk_error (errmsg, 'InvalidArgument');
        
end % switch

end % function


function m = compute_current_minimum (crit)

xi = stk_get_input_data (crit.model);

if isempty (xi)
    m = +inf;
else
    zp = stk_predict (crit.model, xi);
    q = zp.mean + crit.quantile_value * (sqrt (zp.var));
    m = min (q);
end

end % function