-
Notifications
You must be signed in to change notification settings - Fork 3
/
catstruct.m
180 lines (158 loc) · 6.29 KB
/
catstruct.m
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
function A = catstruct(varargin)
% CATSTRUCT Concatenate or merge structures with different fieldnames
% X = CATSTRUCT(S1,S2,S3,...) merges the structures S1, S2, S3 ...
% into one new structure X. X contains all fields present in the various
% structures. An example:
%
% A.name = 'Me' ;
% B.income = 99999 ;
% X = catstruct(A,B)
% % -> X.name = 'Me' ;
% % X.income = 99999 ;
%
% If a fieldname is not unique among structures (i.e., a fieldname is
% present in more than one structure), only the value from the last
% structure with this field is used. In this case, the fields are
% alphabetically sorted. A warning is issued as well. An axample:
%
% S1.name = 'Me' ;
% S2.age = 20 ; S3.age = 30 ; S4.age = 40 ;
% S5.honest = false ;
% Y = catstruct(S1,S2,S3,S4,S5) % use value from S4
%
% The inputs can be array of structures. All structures should have the
% same size. An example:
%
% C(1).bb = 1 ; C(2).bb = 2 ;
% D(1).aa = 3 ; D(2).aa = 4 ;
% CD = catstruct(C,D) % CD is a 1x2 structure array with fields bb and aa
%
% The last input can be the string 'sorted'. In this case,
% CATSTRUCT(S1,S2, ..., 'sorted') will sort the fieldnames alphabetically.
% To sort the fieldnames of a structure A, you could use
% CATSTRUCT(A,'sorted') but I recommend ORDERFIELDS for doing that.
%
% When there is nothing to concatenate, the result will be an empty
% struct (0x0 struct array with no fields).
%
% NOTE: To concatenate similar arrays of structs, you can use simple
% concatenation:
% A = dir('*.mat') ; B = dir('*.m') ; C = [A ; B] ;
% NOTE: This function relies on unique. Matlab changed the behavior of
% its set functions since 2013a, so this might cause some backward
% compatibility issues when dulpicated fieldnames are found.
%
% See also CAT, STRUCT, FIELDNAMES, STRUCT2CELL, ORDERFIELDS
% version 4.1 (feb 2015), tested in R2014a
% (c) Jos van der Geest
% email: jos@jasen.nl
% History
% Created in 2005
% Revisions
% 2.0 (sep 2007) removed bug when dealing with fields containing cell
% arrays (Thanks to Rene Willemink)
% 2.1 (sep 2008) added warning and error identifiers
% 2.2 (oct 2008) fixed error when dealing with empty structs (thanks to
% Lars Barring)
% 3.0 (mar 2013) fixed problem when the inputs were array of structures
% (thanks to Tor Inge Birkenes).
% Rephrased the help section as well.
% 4.0 (dec 2013) fixed problem with unique due to version differences in
% ML. Unique(...,'last') is no longer the deafult.
% (thanks to Isabel P)
% 4.1 (feb 2015) fixed warning with narginchk
%Copyright (c) 2015, Jos van der Geest
%All rights reserved.
%
%Redistribution and use in source and binary forms, with or without
%modification, are permitted provided that the following conditions are
%met:
%
% * Redistributions of source code must retain the above copyright
% notice, this list of conditions and the following disclaimer.
% * Redistributions in binary form must reproduce the above copyright
% notice, this list of conditions and the following disclaimer in
% the documentation and/or other materials provided with the distribution
%
%THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
%AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
%IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
%ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
%LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
%CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
%SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
%INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
%CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
%ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
%POSSIBILITY OF SUCH DAMAGE.
narginchk(1,Inf) ;
N = nargin ;
if ~isstruct(varargin{end}),
if isequal(varargin{end},'sorted'),
narginchk(2,Inf) ;
sorted = 1 ;
N = N-1 ;
else
error('catstruct:InvalidArgument','Last argument should be a structure, or the string "sorted".') ;
end
else
sorted = 0 ;
end
sz0 = [] ; % used to check that all inputs have the same size
% used to check for a few trivial cases
NonEmptyInputs = false(N,1) ;
NonEmptyInputsN = 0 ;
% used to collect the fieldnames and the inputs
FN = cell(N,1) ;
VAL = cell(N,1) ;
% parse the inputs
for ii=1:N,
X = varargin{ii} ;
if ~isstruct(X),
error('catstruct:InvalidArgument',['Argument #' num2str(ii) ' is not a structure.']) ;
end
if ~isempty(X),
% empty structs are ignored
if ii > 1 && ~isempty(sz0)
if ~isequal(size(X), sz0)
error('catstruct:UnequalSizes','All structures should have the same size.') ;
end
else
sz0 = size(X) ;
end
NonEmptyInputsN = NonEmptyInputsN + 1 ;
NonEmptyInputs(ii) = true ;
FN{ii} = fieldnames(X) ;
VAL{ii} = struct2cell(X) ;
end
end
if NonEmptyInputsN == 0
% all structures were empty
A = struct([]) ;
elseif NonEmptyInputsN == 1,
% there was only one non-empty structure
A = varargin{NonEmptyInputs} ;
if sorted,
A = orderfields(A) ;
end
else
% there is actually something to concatenate
FN = cat(1,FN{:}) ;
VAL = cat(1,VAL{:}) ;
FN = squeeze(FN) ;
VAL = squeeze(VAL) ;
[UFN,ind] = unique(FN, 'last') ;
% If this line errors, due to your matlab version not having UNIQUE
% accept the 'last' input, use the following line instead
% [UFN,ind] = unique(FN) ; % earlier ML versions, like 6.5
if numel(UFN) ~= numel(FN),
warning('catstruct:DuplicatesFound','Fieldnames are not unique between structures.') ;
sorted = 1 ;
end
if sorted,
VAL = VAL(ind,:) ;
FN = FN(ind,:) ;
end
A = cell2struct(VAL, FN);
A = reshape(A, sz0) ; % reshape into original format
end