center.m 1.61 KB
Newer Older
1 2
function o = center(o, geometric) % --*-- Unitary tests --*--

3
% Centers dseries object o around its mean (arithmetic or geometric).
4
%
5
% INPUTS
6 7
%  - o             dseries object [mandatory].
%  - geometric     logical [default is false], if true returns the geometric mean.
8
%
9
% OUTPUTS
10
%  - o             dseries object.
11

12
% Copyright (C) 2016-2017 Dynare Team
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
%
% 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
o = copy(o);
o.center_(geometric);
35 36 37 38 39 40 41 42

%@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);
43
%$    ds = ts.center(true);
44 45 46 47 48 49
%$    t(1) = 1;
%$ catch
%$    t = 0;
%$ end
%$
%$ if t(1)
50 51
%$    t(2) = all(all(abs(ds.data-ones(10,2))<1e-12));
%$    t(3) = all(all(abs(ts.data-A)<1e-12));
52 53 54 55
%$    t(4) = dassert(ds.ops{1}, 'center(Variable_1, 1)');
%$    t(5) = dassert(ds.name{1}, 'Variable_1');
%$    t(6) = isempty(ts.ops{1});
%$    t(7) = dassert(ds.name{1}, 'Variable_1');
56 57 58
%$ end
%$ T = all(t);
%@eof:1