rename_.m 2.86 KB
Newer Older
1 2 3 4
function o = rename_(o, old, new) % --*-- Unitary tests --*--

% Renames variables in a dseries object.
%
5
% INPUTS
6 7 8 9
% - o     [dseries]
% - old   [string, cell]
% - new   [string, cell]
%
10
% OUTPUTS
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
% - o     [dseries]

% Copyright (C) 2013-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 isempty(o)
    error('dseries::rename: Cannot rename variable(s) because the object is empty!')
end

if nargin<3
    if isequal(vobs(o), 1) || isequal(vobs(o), length(old))
        new = old;
    else
        error('dseries::rename: Missing argument!')
    end
    if ~ischar(new) && ~(iscellstr(new) && isequal(vobs(o), length(new)))
        error(['dseries::rename: Input argument ''' ...
               inputname(2) ...
               ''' has to be either a string or a cellstring that has the same number of entries as observed variables!'])
    end
    idname = 1;
else
    if ~ischar(old) || ~ischar(new)
        error(['dseries::rename: Input arguments ''' inputname(2) ''' and ''' inputname(3) '''  have to be strings!'])
    end
    idname = find(strcmp(old,o.name));
    if isempty(idname)
        error(['dseries::rename: Variable ' old ' is unknown in dseries object ' inputname(1)  '!'])
    end
end

if iscellstr(new)
57
    o.name = new(:);
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
else
    o.name(idname) = {new};
end

%@test:1
%$ ts = dseries([transpose(1:5), transpose(6:10)],'1950q1',{'Output'; 'Consumption'}, {'Y_t'; 'C_t'});
%$ try
%$     ts.rename_('Output','Production');
%$     t(1) = 1;
%$ catch
%$     t(1) = 0;
%$ end
%$
%$ if t(1)>1
%$     t(2) = dassert(ts.freq,4);
%$     t(3) = dassert(ts.init.freq,4);
%$     t(4) = dassert(ts.init.time,[1950, 1]);
%$     t(5) = dassert(ts.vobs,2);
%$     t(6) = dassert(ts.nobs,5);
%$     t(7) = dassert(ts.name,{'Production'; 'Consumption'});
%$     t(8) = dassert(ts.tex,{'Y_t'; 'C_t'});
%$ end
%$
%$ T = all(t);
%@eof:1

%@test:2
%$ ts = dseries(randn(10,1));
%$ try
%$     ts.rename_('Dora');
%$     t(1) = 1;
%$ catch
%$     t(1) = 0;
%$ end
%$
%$ if t(1)>1
%$     t(2) = dassert(ts.name,{'Dora'});
%$ end
%$
%$ T = all(t);
%@eof:2

%@test:3
%$ ts = dseries(randn(10,3));
%$ try
%$     ts.rename_({'Dora', 'The', 'Explorer'});
%$     t(1) = 1;
%$ catch
%$     t(1) = 0;
%$ end
%$
%$ if t(1)
110
%$     t(2) = dassert(ts.name, {'Dora'; 'The'; 'Explorer'});
111 112 113 114
%$ end
%$
%$ T = all(t);
%@eof:3