Adds setdiff method to dates

time-shift
ferhat 2014-01-21 14:37:43 -06:00
parent 0fde09e5de
commit d325ad15b2
2 changed files with 109 additions and 0 deletions

View File

@ -8920,6 +8920,27 @@ C = <dates: 1951Q1, 1951Q2, 1951Q3, 1951Q4>
@sp 1
@deftypefn{dates} {@var{C} =} setdiff(@var{A}, @var{B})
Overloads the Matlab/Octave @code{setdiff} function. All the input arguments must be @dates objects. The returned argument is a @dates object all dates present in @var{A} but not in @var{B}. If @var{A} and @var{B} are disjoint @dates objects, the function returns @var{A}. Returned dates in @dates object @var{C} are sorted by increasing order.
@examplehead
@example
>> A = dates('1950Q1'):dates('1969Q4') ;
>> B = dates('1960Q1'):dates('1969Q4') ;
>> C = dates('1970Q1'):dates('1979Q4') ;
>> d1 = setdiff(d1,d2);
>> d2 = setdiff(d1,d3);
d1 = <dates: 1950Q1, 1950Q2, ..., 1959Q3, 1959Q4>
d2 = <dates: 1950Q1, 1950Q2, ..., 1969Q3, 1969Q4>
@end example
@end deftypefn
@sp 1
@deftypefn{dates} {@var{B} =} isempty (@var{A})
Overloads the Matlab/Octave isempty function for @dates object.

88
matlab/@dates/setdiff.m Normal file
View File

@ -0,0 +1,88 @@
function C = setdiff(A,B) % --*-- Unitary tests --*--
%@info:
%! @deftypefn {Function File} {@var{C} =} setdiff (@var{A},@var{B})
%! @anchor{@dates/intersect}
%! @sp 1
%! C of B and A.
%! if A and B are not disjoints.
%! @sp 2
%! @strong{Inputs}
%! @sp 1
%! @table @ @var
%! @item A
%! @ref{dates} object.
%! @item B
%! @ref{dates} object.
%! @end table
%! @sp 2
%! @strong{Outputs}
%! @sp 1
%! @table @ @var
%! @item C
%! @ref{dates} object.
%! @end table
%! @end deftypefn
%@eod:
% Copyright (C) 2013 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 ~isa(A,'dates') || ~isa(B,'dates')
error(['dates::plus: Input arguments ''' inputname(1) ''' and ''' inputname(2) ''' must be dates objects!'])
end
if eq(A,B)
C = A;
return
end
if ~isequal(A.freq,B.freq)
C = dates();
return
end
if isoctave || matlab_ver_less_than('8.1.0')
time = setdiff(A.time,B.time,'rows');
else
time = setdiff(A.time,B.time,'rows','legacy');
end
C = dates();
if isempty(time)
return
end
C.freq = A.freq;
C.time = time;
C.ndat = rows(time);
%@test:1
%$ % Define some dates objects
%$ d1 = dates('1950Q1'):dates('1969Q4') ;
%$ d2 = dates('1960Q1'):dates('1969Q4') ;
%$ d3 = dates('1970Q1'):dates('1979Q4') ;
%$
%$ % Call the tested routine.
%$ c1 = intersect(d1,d2);
%$ c2 = intersect(d1,d3);
%$
%$ % Check the results.
%$ t(1) = dyn_assert(isequal(c1,d2),1);
%$ t(2) = dyn_assert(isempty(c2),1);
%$ T = all(t);
%@eof:1