summaryrefslogtreecommitdiff
path: root/inst/arrays/@stk_dataframe/stk_rescale.m
blob: 6c8cd18977d5ca260839a972dcfcc027539895c6 (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
% STK_RESCALE [overload STK function]

% Copyright Notice
%
%    Copyright (C) 2012-2014 SUPELEC
%
%    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 [x, a, b] = stk_rescale (x, box1, varargin)

% Ensure that box1 is an stk_hrect object
if ~ isa (box1, 'stk_hrect')
    if isempty (box1)
        box1 = stk_hrect (size (x, 2));  % Default: [0; 1] ^ DIM
    else
        box1 = stk_hrect (box1);
    end
end

% Rescale using @stk_hrect/stk_rescale
if isa (x, 'stk_dataframe')
    [x.data, a, b] = stk_rescale (x.data, box1, varargin{:});
else
    [x, a, b] = stk_rescale (x, box1, varargin{:});
end

end % function

%!test
%! u = rand(5, 1) * 2;
%! x = stk_dataframe(u);
%! y = stk_rescale(x, [0; 2], [0; 3]);
%! assert (isa (y, 'stk_dataframe') && isequal(double(y), u * 3/2))