center_.m 1.79 KB
Newer Older
1 2 3 4
function o = center_(o, geometric) % --*-- Unitary tests --*--

% Centers dseries object o around its mean (arithmetic or geometric).
%
Stéphane Adjemian's avatar
Stéphane Adjemian committed
5
% INPUTS
6 7 8
%  - o             dseries object [mandatory].
%  - geometric     logical [default is false], if true returns the geometric mean.
%
Stéphane Adjemian's avatar
Stéphane Adjemian committed
9
% OUTPUTS
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
%  - o             dseries object.

% Copyright (C) 2016-2017 Dynare Team
%
% This file is part of Dynare.
%
% Dynare 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.
%
% Dynare 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 Dynare.  If not, see <http://www.gnu.org/licenses/>.

if nargin<2
    geometric = false;
end

33 34
m = mean(o.data);

35
if geometric
36
    o.data = bsxfun(@rdivide, o.data, m);
37
else
38
    o.data = bsxfun(@minus, o.data, m);
39 40
end

Stéphane Adjemian's avatar
Stéphane Adjemian committed
41 42 43 44 45 46 47 48
for i=1:o.vobs
    if isempty(o.ops{i})
        o.ops(i) = {sprintf('center(%s, %s)', o.name{i}, num2str(geometric))};
    else
        o.ops(i) = {sprintf('center(%s, %s)', o.ops{i}, num2str(geometric))};
    end
end

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
%@test:1
%$ % Define a dataset.
%$ A = repmat([1.005, 1.05], 10, 1);
%$
%$ % Instantiate a time series object and compute the mean.
%$ try
%$    ts = dseries(A);
%$    ts.center_(true);
%$    t(1) = 1;
%$ catch
%$    t = 0;
%$ end
%$
%$ if t(1)
%$    t(2) = all(all(abs(ts.data-ones(10,2))<1e-12));
Stéphane Adjemian's avatar
Stéphane Adjemian committed
64 65
%$    t(3) = dassert(ts.ops{1}, 'center(Variable_1, 1)');
%$    t(4) = dassert(ts.name{1}, 'Variable_1');
66 67 68
%$ end
%$ T = all(t);
%@eof:1