2013-10-13 09:39:27 +02:00
function B = pop ( A,a) % --*-- Unitary tests --*--
2013-09-05 11:34:19 +02:00
2013-10-15 15:36:21 +02:00
% pop method for dates class (removes a date).
2013-10-13 09:39:27 +02:00
%
% INPUTS
2013-10-15 15:36:21 +02:00
% o A dates object.
% o a dates object with one element, string which can be interpreted as a date or integer scalar.
2013-10-13 09:39:27 +02:00
%
% OUTPUTS
2013-10-15 15:36:21 +02:00
% o B dates object (with B.ndat==A.ndat-1).
2013-10-13 09:39:27 +02:00
%
% REMARKS
% If a is a date appearing more than once in A, then only the last occurence is removed. If one wants to
% remove all the occurences of a in A, the setdiff function should be used instead.
2012-11-14 11:44:37 +01:00
2013-10-13 09:39:27 +02:00
% Copyright (C) 2012-2013 Dynare Team
2012-11-14 11:44:37 +01:00
%
% 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
% Remove last date
2013-10-15 15:36:21 +02:00
B = dates ( ) ;
2013-10-13 09:39:27 +02:00
B . ndat = A . ndat - 1 ;
B . freq = A . freq ;
B . time = NaN ( B . ndat , 2 ) ;
B . time = A . time ( 1 : end - 1 , : ) ;
2012-11-14 11:44:37 +01:00
return
end
2013-11-29 15:50:00 +01:00
if ~ ( isdates ( a ) || isdate ( a ) || ( isscalar ( a ) && isint ( a ) ) )
2013-10-15 15:36:21 +02:00
error ( [ ' dates::pop: Input argument ' inputname ( 2 ) ' has to be a dates object with a single element, a string (which can be interpreted as a date) or an integer.' ] )
2012-11-14 11:44:37 +01:00
end
2013-10-13 09:39:27 +02:00
if ischar ( a )
2013-10-15 15:36:21 +02:00
a = dates ( a ) ;
2012-11-14 11:44:37 +01:00
end
2013-10-15 15:36:21 +02:00
B = dates ( ) ;
2013-10-13 09:39:27 +02:00
B . ndat = A . ndat - 1 ;
B . freq = A . freq ;
B . time = NaN ( B . ndat , 2 ) ;
if isscalar ( a ) && isint ( a )
idx = find ( transpose ( 1 : A . ndat ) ~= a ) ;
B . time = A . time ( idx , : ) ;
else
if ~ isequal ( A . freq , a . freq )
2013-10-15 15:36:21 +02:00
error ( ' dates::pop: Inputs must have common frequency!' )
2013-10-13 09:39:27 +02:00
end
idx = find ( A == a ) ;
jdx = find ( transpose ( 1 : A . ndat ) ~= idx ( end ) ) ;
B . time = A . time ( jdx , : ) ;
end
2012-11-14 11:44:37 +01:00
%@test:1
%$ % Define some dates
%$ B1 = '1953Q4';
%$ B2 = '1950Q2';
%$ B3 = '1950Q1';
%$ B4 = '1945Q3';
%$ B5 = '2009Q2';
%$
%$ % Define expected results
%$ e.time = [1945 3; 1950 1; 1950 2; 1953 4; 2009 2];
%$ e.freq = 4;
%$ e.ndat = 5;
%$
%$ % Call the tested routine
2013-10-15 15:36:21 +02:00
%$ d = dates(B4,B3,B2,B1);
%$ d = d.append(dates(B5));
2012-11-14 11:44:37 +01:00
%$ f = d.pop();
%$ t(1) = dyn_assert(f.time,e.time(1:end-1,:));
%$ t(2) = dyn_assert(f.freq,e.freq);
%$ t(3) = dyn_assert(f.ndat,e.ndat-1);
%$ f = d.pop(B1);
%$ t(4) = dyn_assert(f.time,[1945 3; 1950 1; 1950 2; 2009 2]);
%$ t(5) = dyn_assert(f.freq,e.freq);
%$ t(6) = dyn_assert(f.ndat,e.ndat-1);
2013-10-15 15:36:21 +02:00
%$ f = d.pop(dates(B1));
2012-11-14 11:44:37 +01:00
%$ t(7) = dyn_assert(f.time,[1945 3; 1950 1; 1950 2; 2009 2]);
%$ t(8) = dyn_assert(f.freq,e.freq);
%$ t(9) = dyn_assert(f.ndat,e.ndat-1);
%$
%$ % Check the results.
%$ T = all(t);
2013-10-13 09:39:27 +02:00
%@eof:1
%@test:2
%$ % Define some dates
%$ B1 = '1950Q1';
%$ B2 = '1950Q2';
%$ B3 = '1950Q1';
%$ B4 = '1945Q3';
%$ B5 = '2009Q2';
%$
%$ % Call the tested routine
2013-10-15 15:36:21 +02:00
%$ d = dates(B1,B2,B3,B4);
%$ d = d.append(dates(B5));
2013-10-13 09:39:27 +02:00
%$ f = d.pop();
2013-10-15 15:36:21 +02:00
%$ t(1) = dyn_assert(isequal(f,dates(B1,B2,B3,B4)),1);
2013-10-13 09:39:27 +02:00
%$ f = d.pop(B1);
2013-10-15 15:36:21 +02:00
%$ t(2) = dyn_assert(isequal(f,dates(B1,B2,B4,B5)),1);
2013-10-13 09:39:27 +02:00
%$ g = f.pop(1);
2013-10-15 15:36:21 +02:00
%$ t(3) = dyn_assert(isequal(g,dates(B2,B4,B5)),1);
2013-10-13 09:39:27 +02:00
%$ T = all(t);
%@eof:2