dynare/matlab/@dseries/detrend.m

111 lines
2.5 KiB
Matlab

function o = detrend(o, model) % --*-- Unitary tests --*--
% Copyright (C) 2014 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/>.
% Set default for the order of the polynomial trend (constant).
if nargin<2
model = 0;
end
data = o.data;
if isnumeric(model)
if isscalar(model) && isint(model)
switch model
case 0
data = demean(data);
otherwise
x = NaN(nobs(o), model+1);
x(:,1) = ones(nobs(o), 1);
x(:,2) = transpose(1:nobs(o));
for c=3:model+1
x(:,c) = x(:,c-1).*x(:,2);
end
data = data - x*(x\data);
end
else
error('dseries::detrend: Second argument must be a positive integer scalar!')
end
else
error('dseries::detrend: Second argument must be a positive integer scalar!')
end
o = dseries(data, o.dates, o.name, o.tex);
%@test:1
%$ % Define a dataset.
%$ a = dseries(randn(1000,3));
%$
%$ % detrend (default).
%$ try
%$ b1 = a.detrend();
%$ t(1) = 1;
%$ catch
%$ t = 0;
%$ end
%$
%$ % detrend (constant).
%$ if t(1)
%$ try
%$ b2 = a.detrend(0);
%$ t(2) = 1;
%$ catch
%$ t(2) = 0;
%$ end
%$ end
%$
%$ % detrend (linear).
%$ if t(2)
%$ try
%$ b3 = a.detrend(1);
%$ t(3) = 1;
%$ catch
%$ t(3) = 0;
%$ end
%$ end
%$
%$ % detrend (quadratic).
%$ if t(3)
%$ try
%$ b4 = a.detrend(2);
%$ t(4) = 1;
%$ catch
%$ t(4) = 0;
%$ end
%$ end
%$
%$ % detrend (cubic).
%$ if t(4)
%$ try
%$ b5 = a.detrend(3);
%$ t(5) = 1;
%$ catch
%$ t(5) = 0;
%$ end
%$ end
%$
%$ if t(5)
%$ t(6) = dyn_assert(max(mean(b1.data)),0,1e-12);
%$ t(7) = dyn_assert(max(mean(b2.data)),0,1e-12);
%$ t(8) = dyn_assert(max(mean(b3.data)),0,1e-12);
%$ t(9) = dyn_assert(max(mean(b4.data)),0,1e-12);
%$ t(10) = dyn_assert(max(mean(b5.data)),0,1e-12);
%$ end
%$ T = all(t);
%@eof:1