onesidedhptrend.m 1.58 KB
Newer Older
1
function o = onesidedhptrend(o, lambda, init) % --*-- Unitary tests --*--
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

% Extracts the trend component from a dseries object using the one sided HP filter.
%
% INPUTS
% - o         [dseries]   Original time series.
% - lambda    [double]    scalar, trend smoothness parameter.
%
% OUTPUTS
% - o         [dseries]   Trend component of the original time series.

% Copyright (C) 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>1
    if lambda<=0
        error(['dseries::onesidedhptrend: Lambda must be a positive integer!'])
    end
33 34 35 36 37
    if nargin>2
        if ~isequal(init, 'hpfilter')
            error('dseries::onesidedhpcycle: Unknown option!')
        end
    end
38 39 40 41 42
else
    lambda = [];
end

o = copy(o);
43 44 45 46 47
if nargin<3
    o.onesidedhptrend_(lambda);
else
    o.onesidedhptrend_(lambda, init);
end
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

return

%@test:1
d = randn(100,1);
o = dseries(d);

try
    p = o.onesidedhptrend();
    t(1) = 1;
catch
    t(1) = 0;
end

if t(1)
    t(2) = dassert(o.data,d);
end

T = all(t);
%@eof:1