summaryrefslogtreecommitdiff
path: root/inst/arrays/@stk_dataframe/vertcat.m
blob: 902da9fa9ed3619e2f2229fad31e819867673ba3 (plain)
1
2
3
4
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
53
54
55
56
57
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
% VERTCAT [overload base function]

% Copyright Notice
%
%    Copyright (C) 2015, 2017 CentraleSupelec
%    Copyright (C) 2013, 2014 SUPELEC
%
%    Author:  Julien Bect  <julien.bect@centralesupelec.fr>

% Copying Permission Statement
%
%    This file is part of
%
%            STK: a Small (Matlab/Octave) Toolbox for Kriging
%               (https://github.com/stk-kriging/stk/)
%
%    STK 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.
%
%    STK 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 STK.  If not, see <http://www.gnu.org/licenses/>.

function x = vertcat (x, y, varargin)

if nargin < 2
    y = [];
end

%--- Get raw data and concatenate -----------------------------------------

x_data = double (x);
y_data = double (y);

% We let the base vertcat function generate an error if needed
data = [x_data; y_data];

%--- Get column and row names  of inputs ----------------------------------

if isa (x, 'stk_dataframe')
    x_colnames = get (x, 'colnames');
    x_rownames = get (x, 'rownames');
else
    x_colnames = {};
    x_rownames = {};
end

if isa (y, 'stk_dataframe')
    y_colnames = get (y, 'colnames');
    y_rownames = get (y, 'rownames');
else
    y_colnames = {};
    y_rownames = {};
end

%--- Create output column names -------------------------------------------

if isempty (x_colnames)
    
    colnames = y_colnames;
    
elseif isempty (y_colnames)
    
    colnames = x_colnames;
    
else
    
    x_empty = cellfun (@isempty, x_colnames);
    y_empty = cellfun (@isempty, y_colnames);
    xy_equal = strcmp (x_colnames, y_colnames);
    
    if all (x_empty | y_empty | xy_equal)
        colnames = x_colnames;
        colnames(x_empty) = y_colnames(x_empty);
    else
        warning ('STK:vertcat:IncompatibleColNames', sprintf ( ...
            ['Incompatible column names !\nThe output of vertcat ' ...
            'will have no column names.']));  colnames = {};
    end
    
end

%--- Create output row names ----------------------------------------------

bx = isempty (x_rownames);
by = isempty (y_rownames);

if bx && by  % none of the argument has row names
    
    rownames = {};
    
else  % at least of one the arguments has row names
    
    if bx,  x_rownames = repmat ({''}, size (x_data, 1), 1);  end
    if by,  y_rownames = repmat ({''}, size (y_data, 1), 1);  end
    
    rownames = [x_rownames; y_rownames];
    
end

%--- Create output --------------------------------------------------------

if strcmp (class (x), 'stk_dataframe')  %#ok<STISA>
    % Optimize for speed (no need to call constructor)
    x.data = data;
    x.colnames = colnames;
    x.rownames = rownames;
else
    x = stk_dataframe (data, colnames, rownames);
end

if ~ isempty (varargin)
    x = vertcat (x, varargin{:});
end

end % function

%#ok<*SPWRN>


% IMPORTANT NOTE: [x; y; ...] fails to give the same result as vertcat (x, y,
% ...) in some releases of Octave. As a consequence, all tests must be written
% using vertcat explicitely.

%!shared u, v
%! u = rand (3, 2);
%! v = rand (3, 2);

%%
% Vertical concatenation of two dataframes

%!test
%! x = stk_dataframe (u);
%! y = stk_dataframe (v);
%! z = vertcat (x, y);
%! assert (isa (z, 'stk_dataframe') && isequal (double (z), [u; v]));

%!test  % the same, with row names this time
%! x = stk_dataframe (u, {}, {'a'; 'b'; 'c'});
%! y = stk_dataframe (v, {}, {'d'; 'e'; 'f'});
%! z = vertcat (x, y);
%! assert (isa (z, 'stk_dataframe') && isequal (double (z), [u; v]));
%! assert (all (strcmp (z.rownames, {'a'; 'b'; 'c'; 'd'; 'e'; 'f'})));

%!test  % the same, with row names only for the first argument
%! x = stk_dataframe (u, {}, {'a'; 'b'; 'c'});
%! y = stk_dataframe (v);
%! z = vertcat (x, y);
%! assert (isa (z, 'stk_dataframe') && isequal (double (z), [u; v]));

%!test  % incompatible variable names
%! u = rand (3, 1);  x = stk_dataframe (u, {'x'});
%! v = rand (3, 1);  y = stk_dataframe (v, {'y'});
%! z = vertcat (x, y);
%! assert (isequal (z.colnames, {}));

%%
% Vertical concatenation [dataframe; matrix]

%!test
%! x = stk_dataframe (u);
%! z = vertcat (x, v);
%! assert (isa (z, 'stk_dataframe') && isequal (double (z), [u; v]));

%!test  % the same, with row names for the first argument
%! x = stk_dataframe (u, {}, {'a'; 'b'; 'c'});
%! z = vertcat (x, v);
%! assert (isa (z, 'stk_dataframe') && isequal (double (z), [u; v]));

%%
% Vertical concatenation [matrix; dataframe]

%!test
%! y = stk_dataframe (v);
%! z = vertcat (u, y);
%! assert (isa (z, 'stk_dataframe') && (isequal (double (z), [u; v])));

%%
% Vertical concatenation of more than two elements

%!test
%! x = stk_dataframe (u);
%! y = stk_dataframe (v);
%! z = vertcat (x, y, u, v);
%! assert (isa (z, 'stk_dataframe') && isequal (double (z), [u; v; u; v]));

%%
% Vertical concatenation with missing column names

%!shared x, y
%! x = stk_dataframe (rand (2, 3), {'a', 'b', 'c'});
%! y = stk_dataframe (rand (3, 2), {'a', 'b'});
%! y = horzcat (y, rand(3, 1));  % last column name is missing

%!test
%! z = vertcat (x, y);
%! assert (isequal (z.colnames, {'a' 'b' 'c'}))

%!test
%! z = vertcat (y, x);
%! assert (isequal (z.colnames, {'a' 'b' 'c'}))