subsref.m 6.31 KB
Newer Older
Stéphane Adjemian's avatar
Stéphane Adjemian committed
1
2
3
function us = subsref(ts, S)
%@info:
%! @deftypefn {Function File} {@var{us} =} subsref (@var{ts},S)
Stéphane Adjemian's avatar
Stéphane Adjemian committed
4
%! @anchor{@dynSeries/subsref}
Stéphane Adjemian's avatar
Stéphane Adjemian committed
5
6
7
8
9
10
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
%! @sp 1
%! Overloads the subsref method for the Dynare time series class (@ref{dynSeries}).
%! @sp 2
%! @strong{Inputs}
%! @sp 1
%! @table @ @var
%! @item ts
%! Dynare time series object instantiated by @ref{dynSeries}.
%! @item S
%! Matlab's structure array S with two fields, type and subs. The type field is string containing '()', '@{@}', or '.', where '()' specifies
%! integer subscripts, '@{@}' specifies cell array subscripts, and '.' specifies subscripted structure fields. The subs field is a cell array
%! or a string containing the actual subscripts (see matlab's documentation).
%! @end table
%! @sp 1
%! @strong{Outputs}
%! @sp 1
%! @table @ @var
%! @item us
%! Dynare time series object. Depending on the calling sequence @var{us} is a transformation of @var{ts} obtained by applying a public method on @var{ts},
%! or a dynSeries object built by extracting a variable from @var{ts}, or a dynSeries object containing a subsample of the all the variable in @var{ts}.
%! @end table
%! @sp 2
%! @strong{Example 1.} Let @var{ts} be a dynSeries object containing three variables named 'A1', 'A2' and 'A3'. Then the following syntax:
%! @example
%!   us = ts.A1;
%! @end example
%!will create a new dynSeries object @var{us} containing the variable 'A1'.
%! @sp 1
%! @strong{Example 2.} Let @var{ts} be a dynSeries object. Then the following syntax:
%! @example
%!   us = ts.log;
%! @end example
%!will create a new dynSeries object @var{us} containing all the variables of @var{ts} transformed by the neperian logarithm.
%! @sp 1
%! @strong{Example 3.} Let @var{ts} be a dynSeries object. The following syntax:
%! @example
%!   us = ts(3:50);
%! @end example
%!will create a new dynSeries object @var{us} by selecting a subsample out of @var{ts}.
%! @sp 2
%! @strong{This function is called by:}
%! @sp 2
%! @strong{This function calls:}
%! @ref{dynSeries}, @ref{log}, @ref{exp}
%!
%! @end deftypefn
%@eod:

Stéphane Adjemian's avatar
Stéphane Adjemian committed
53
% Copyright (C) 2011, 2012 Dynare Team
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
%
% 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/>.

% AUTHOR(S) stephane DOT adjemian AT univ DASH lemans DOT fr

72
if length(S)==1 && isequal(S.type,'.')
Stéphane Adjemian's avatar
Stéphane Adjemian committed
73
    switch S.subs
74
      case {'data','nobs','vobs','name','tex','freq','time','init'}        % Public members.
Stéphane Adjemian's avatar
Stéphane Adjemian committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
        us = builtin('subsref', ts, S);
      case {'log','exp'}                                                   % Give "dot access" to public methods.
        us = feval(S.subs,ts);
      otherwise                                                            % Extract a sub-object by selecting one variable.
        ndx = strmatch(S.subs,ts.name);
        if ~isempty(ndx)
            us = dynSeries();
            us.data = ts.data(:,ndx);
            us.name = deblank(ts.name(ndx,:));
            us.tex  = deblank(ts.tex(ndx,:));
            us.nobs = ts.nobs;
            us.vobs = 1;
            us.freq = ts.freq;
            us.init = ts.init;
            return
        else
            error('dynSeries::subsref: Unknown public method, public member or variable!')
92
93
        end
    end
Stéphane Adjemian's avatar
Stéphane Adjemian committed
94
95
    return
end
96
97

if length(S)==1 && isequal(S.type,'()')                                                    % Extract a sub-object by selecting a sub-sample.
Stéphane Adjemian's avatar
Stéphane Adjemian committed
98
99
100
    us = dynSeries();
    if size(ts.data,2)>1
        S.subs = [S.subs, ':'];
101
    end
Stéphane Adjemian's avatar
Stéphane Adjemian committed
102
103
104
105
106
    us.data = builtin('subsref', ts.data, S);
    us.nobs = size(us.data,1);
    us.vobs = ts.vobs;
    us.freq = ts.freq;
    us.time = builtin('subsref', ts.time, S);
107
    us.init = ts.init+S.subs{1}(1);
Stéphane Adjemian's avatar
Stéphane Adjemian committed
108
109
    us.name = ts.name;
    us.tex  = ts.tex;
110
    return
Stéphane Adjemian's avatar
Stéphane Adjemian committed
111
end
112

113
114
115
if (length(S)==2) && (isequal(S(1).subs,'init'))
    if isequal(S(2).type,'.') && ( isequal(S(2).subs,'freq') || isequal(S(2).subs,'time') )
        us = builtin('subsref', ts.init, S(2));
116
117
118
119
120
    else
        error('dynSeries:subsref:: I don''t understand what you are trying to do!')
    end
end

121
122
123
124
125
%@test:1
%$ % Define a data set.
%$ A = [transpose(1:10),2*transpose(1:10)];
%$
%$ % Define names
126
%$ A_name = {'A1';'A2'};
127
128
129
130
131
132
133
134
135
136
137
%$
%$ % Instantiate a time series object.
%$ ts1 = dynSeries(A,[],A_name,[]);
%$
%$ % Call the tested method.
%$ a = ts1(2:9);
%$
%$ % Expected results.
%$ e.data = [transpose(2:9),2*transpose(2:9)];
%$ e.nobs = 8;
%$ e.vobs = 2;
138
%$ e.name = {'A1';'A2'};
139
%$ e.freq = 1;
140
%$ e.init = dynDate(2);
141
142
143
%$
%$ % Check the results.
%$ t(1) = dyn_assert(a.data,e.data);
144
145
146
147
%$ t(2) = dyn_assert(a.nobs,e.nobs);
%$ t(3) = dyn_assert(a.vobs,e.vobs);
%$ t(4) = dyn_assert(a.freq,e.freq);
%$ t(5) = dyn_assert(a.init,e.init);
148
149
150
151
152
153
154
155
%$ T = all(t);
%@eof:1

%@test:2
%$ % Define a data set.
%$ A = [transpose(1:10),2*transpose(1:10)];
%$
%$ % Define names
156
%$ A_name = {'A1';'A2'};
157
158
159
160
161
162
163
164
165
166
167
%$
%$ % Instantiate a time series object.
%$ ts1 = dynSeries(A,[],A_name,[]);
%$
%$ % Call the tested method.
%$ a = ts1.A1;
%$
%$ % Expected results.
%$ e.data = transpose(1:10);
%$ e.nobs = 10;
%$ e.vobs = 1;
168
%$ e.name = {'A1'};
169
%$ e.freq = 1;
170
%$ e.init = dynDate(1);
171
172
173
%$
%$ % Check the results.
%$ t(1) = dyn_assert(a.data,e.data);
174
%$ t(2) = dyn_assert(a.init,e.init);
175
176
177
178
179
180
181
182
183
184
185
%$ t(3) = dyn_assert(a.nobs,e.nobs);
%$ t(4) = dyn_assert(a.vobs,e.vobs);
%$ t(5) = dyn_assert(a.freq,e.freq);
%$ T = all(t);
%@eof:2

%@test:3
%$ % Define a data set.
%$ A = [transpose(1:10),2*transpose(1:10)];
%$
%$ % Define names
186
%$ A_name = {'A1';'A2'};
187
188
189
190
191
192
193
194
195
196
197
%$
%$ % Instantiate a time series object.
%$ ts1 = dynSeries(A,[],A_name,[]);
%$
%$ % Call the tested method.
%$ a = ts1.log;
%$
%$ % Expected results.
%$ e.data = log(A);
%$ e.nobs = 10;
%$ e.vobs = 2;
198
%$ e.name = {'A1';'A2'};
199
%$ e.freq = 1;
200
%$ e.init = dynDate(1);
201
202
203
%$
%$ % Check the results.
%$ t(1) = dyn_assert(a.data,e.data);
204
205
206
207
%$ t(2) = dyn_assert(a.nobs,e.nobs);
%$ t(3) = dyn_assert(a.vobs,e.vobs);
%$ t(4) = dyn_assert(a.freq,e.freq);
%$ t(5) = dyn_assert(a.init,e.init);
208
209
%$ T = all(t);
%@eof:3