lead.m 1.58 KB
Newer Older
1
function o = lead(o, p) % --*-- Unitary tests --*--
2

3 4
% Returns a lagged time series
%
Stéphane Adjemian's avatar
Stéphane Adjemian committed
5
% INPUTS
6 7 8
% - o [dseries]
% - p [integer] Number of leads
%
Stéphane Adjemian's avatar
Stéphane Adjemian committed
9
% OUTPUTS
10 11
% - o [dseries]
%
Stéphane Adjemian's avatar
Stéphane Adjemian committed
12
% EXAMPLE
13 14 15 16 17 18 19
% Define a dseries object as follows:
%
% >> o = dseries(transpose(1:5))
%
% then o.lag(1) returns
%
%       | lead(Variable_1,1)
Stéphane Adjemian's avatar
Stéphane Adjemian committed
20 21 22 23 24
%    1Y | 2
%    2Y | 3
%    3Y | 4
%    4Y | 5
%    5Y | NaN
25

26
% Copyright (C) 2013-2017 Dynare Team
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
%
% 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 number of leads
if nargin<2
    p = 1;
end

48 49
o = copy(o);
o.lead_(p);
50 51 52

%@test:1
%$ try
53
%$     data = transpose(1:50);
54 55 56 57
%$     ts = dseries(data,'1950Q1');
%$     a = ts.lead;
%$     b = ts.lead.lead;
%$     c = lead(ts,2);
58
%$     t(1) = true;
59
%$ catch
60
%$     t(1) = false;
61 62
%$ end
%$
63 64 65 66 67 68 69
%$ if t(1)
%$
%$     DATA = [data(2:end); NaN(1)];
%$     t(2) = dassert(a.data, DATA, 1e-15);
%$     DATA = [data(3:end); NaN(2,1)];
%$     t(3) = dassert(b.data, DATA, 1e-15);
%$     t(4) = dassert(c.data, DATA, 1e-15);
70 71 72 73
%$ end
%$
%$ T = all(t);
%@eof:1