Renamed dynDates2decimal as double, added doc/header and unitary tests.

The advantage of this  change is that we can put dates  in an array of
doubles. For instance, assuming that A is a 2*1 vector, the following
syntax is allowed:

A(1) = dates('1945Q3');
A(2) = dates('1938Q4');

Matlab/Octave calls the overload double function to convert the dates as
a double.
time-shift
Stéphane Adjemian (Charybdis) 2013-10-21 11:50:21 +02:00
parent bfb5421182
commit d31a2674e8
2 changed files with 81 additions and 23 deletions

81
matlab/@dates/double.m Normal file
View File

@ -0,0 +1,81 @@
function [B, C] = double(A)
% Returns a vector of doubles with the fractional part corresponding
% to the subperiod. Used for plots and to store dates in a matrix.
%
% INPUTS
% o A dates object.
%
% OUTPUTS
% o B A.ndat*1 vector of doubles.
% o C integer scalar, the frequency (1, 4, 12 or 52).
%
% REMARKS
% Obviously the frequency is lost during the conversion.
% 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/>.
B = A.time(:,1)+(A.time(:,2)-1)/A.freq;
if nargout>1
C = A.freq;
end
%@test:1
%$ % Define a dates object
%$ qq = dates('Q');
%$ B = qq(1950,1):qq(1951,1);
%$
%$ % Call the tested routine.
%$ try
%$ C = double(B);
%$ t(1) = 1;
%$ catch
%$ t(1) = 0;
%$ end
%$
%$ % Define expected results.
%$ E = [ones(4,1)*1950; 1951];
%$ E = E + [(transpose(1:4)-1)/4; 0];
%$ if t(1)
%$ t(2) = dyn_assert(isequal(C,E),1);
%$ end
%$ T = all(t);
%@eof:1
%@test:2
%$ % Define a dates object
%$ qq = dates('Q');
%$
%$ % Call the tested routine.
%$ try
%$ C = NaN(2,1);
%$ C(1) = double(qq(1950,1));
%$ C(2) = double(qq(1950,2));
%$ t(1) = 1;
%$ catch
%$ t(1) = 0;
%$ end
%$
%$ % Define expected results.
%$ E = ones(2,1)*1950;
%$ E = E + [0; .25];
%$ if t(1)
%$ t(2) = dyn_assert(isequal(C,E),1);
%$ end
%$ T = all(t);
%@eof:2

View File

@ -1,23 +0,0 @@
function y = dates2decimal(dd)
% function y = dates2decimal(dd)
% returns a vector of doubles with the fractional part corresponding
% to the subperiod. Mostly used for plots.
% 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/>.
y = dd.time(:,1)+(dd.time(:,2)-1)/dd.freq;