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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
########################################################################
##
## Copyright (C) 2000-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave 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.
##
## Octave 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 Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{tf} =} isequaln (@var{x1}, @var{x2}, @dots{})
## Return true if all of @var{x1}, @var{x2}, @dots{} are equal under the
## additional assumption that NaN == NaN (no comparison of NaN placeholders
## in dataset).
## @seealso{isequal}
## @end deftypefn
## Algorithm:
##
## 1. Verify the class of x.
## a. All objects are of the same class
## b. All objects are of a generic "numeric" class which includes
## numeric, logical, and character arrays
## 2. Verify size of all objects match.
## 3. Convert objects to struct, and then compare as stated below.
## 4. For each argument after x, compare it for equality with x:
## a. char compare each member with strcmp
## b. numeric compare each member with '==', and assume NaN == NaN
## c. struct compare number of fieldnames, value of fieldnames,
## and then each field with isequaln (recursive)
## d. cellstr compare each cellstr member with strcmp
## e. cell compare each member with isequaln (recursive)
## f. fcn_handle compare using overloaded "eq" operator
function tf = isequaln (x, varargin)
if (nargin < 2)
print_usage ();
endif
nvarargin = nargin - 1;
two_args = (nvarargin == 1); # Optimization for base case of just 2 args
if (two_args)
y = varargin{1}; # alias y to second input for comparison
endif
############################################################
## Generic tests for equality
## All arguments must either be of the same class,
## or they must be "numeric" values.
if (two_args)
tf = (strcmp (class (x), class (y))
|| ((isreal (x) || iscomplex (x)) && (isreal (y) || iscomplex (y))));
else
tf = (all (cellfun ("isclass", varargin, class (x)))
|| ((isreal (x) || iscomplex (x))
&& all (cellfun ("isreal", varargin)
| cellfun ("isnumeric", varargin))));
endif
## Test that everything is the same size (which also tests dimensions)
if (tf)
tf = size_equal (x, varargin{:});
endif
## From here on, compare any objects as if they were structures.
if (tf && isobject (x))
## Locally suppress class-to-struct warning. We know what we are doing.
warning ("off", "Octave:classdef-to-struct", "local");
x = builtin ("struct", x);
if (two_args)
clear y; # break link to existing variable
varargin(1) = builtin ("struct", varargin{1});
y = varargin{1}; # re-alias y to second input
else
for i = 1:nvarargin
varargin(i) = builtin ("struct", varargin{i});
endfor
endif
endif
############################################################
## Check individual classes.
if (tf)
if (two_args)
if (ischar (x) && ischar (y))
## char type. Optimization, strcmp is ~35% faster than '==' operator.
tf = strcmp (x, y);
elseif (isreal (x) || iscomplex (x))
## general "numeric" type. Use '==' operator.
m = (x == y);
tf = all (m(:));
if (! tf && isfloat (x) && isfloat (y))
tf = isnan (x(! m)) && isnan (y(! m));
endif
elseif (isstruct (x))
## struct type. Compare # of fields, fieldnames, then field values.
## Test number of fields are equal.
tf = (numfields (x) == numfields (y));
## Test that all the field names are equal.
if (tf)
s_fnm_x = sort (fieldnames (x));
tf = all (strcmp (s_fnm_x, sort (fieldnames (y))));
endif
## Test that all field values are equal. Slow because of recursion.
if (tf)
if (isscalar (x))
for fldnm = s_fnm_x.'
tf = isequaln (x.(fldnm{1}), y.(fldnm{1}));
if (! tf)
break;
endif
endfor
else
## struct arrays have to have the contents of each field wrapped
## in a cell since it expands to a collection of values.
for fldnm = s_fnm_x.'
tf = isequaln ({x.(fldnm{1})}, {y.(fldnm{1})});
if (! tf)
break;
endif
endfor
endif
endif
elseif (iscellstr (x) && iscellstr (y))
## cellstr type. Optimization over cell type by using strcmp.
## FIXME: It would be faster to use strcmp on whole cellstr arrays,
## but bug #51412 needs to be fixed. Instead, time/space trade-off.
## Convert to char (space) for faster processing with strcmp (time).
tf = strcmp (char (x), char (y));
elseif (iscell (x))
## cell type. Check that each element of a cell is equal. Slow.
n = numel (x);
idx = 1;
while (tf && idx <= n)
tf = isequaln (x{idx}, y{idx});
idx += 1;
endwhile
elseif (is_function_handle (x))
## function type. Use '==' operator which is overloaded.
tf = (x == y);
else
error ("isequaln: Impossible to reach code. File a bug report.");
endif
else # More than two args. This is going to be slower in general.
if (ischar (x) && all (cellfun ("isclass", varargin, "char")))
## char type. Optimization, strcmp is ~35% faster than '==' operator.
idx = 1;
while (tf && idx <= nvarargin)
tf = strcmp (x, varargin{idx});
idx += 1;
endwhile
elseif (isreal (x) || iscomplex (x))
## general "numeric" type. Use '==' operator.
idx = 1;
while (tf && idx <= nvarargin)
y = varargin{idx};
m = (x == y);
tf = all (m(:));
if (! tf && isfloat (x) && isfloat (y))
tf = isnan (x(! m)) && isnan (y(! m));
endif
idx += 1;
endwhile
elseif (isstruct (x))
## struct type. Compare # of fields, fieldnames, then field values.
## Test number of fields are equal.
fnm_x = fieldnames (x);
n = numel (fnm_x);
fnm_v = cellfun ("fieldnames", varargin, "uniformoutput", false);
tf = all (n == cellfun ("numel", fnm_v));
## Test that all the field names are equal.
if (tf)
fnm_x = sort (fnm_x);
idx = 1;
while (tf && idx <= nvarargin)
## Allow the fieldnames to be in a different order.
tf = all (strcmp (fnm_x, sort (fnm_v{idx})));
idx += 1;
endwhile
endif
## Test that all field values are equal. Slow because of recursion.
if (tf)
args = cell (1, 1 + nvarargin);
if (isscalar (x))
for fldnm = fnm_x.'
args{1} = x.(fldnm{1});
for argn = 1:nvarargin
args{argn+1} = varargin{argn}.(fldnm{1});
endfor
tf = isequaln (args{:});
if (! tf)
break;
endif
endfor
else
## struct arrays have to have the contents of each field wrapped
## in a cell since it expands to a collection of values.
for fldnm = fnm_x.'
args{1} = { x.(fldnm{1}) };
for argn = 1:nvarargin
args{argn+1} = { varargin{argn}.(fldnm{1}) };
endfor
tf = isequaln (args{:});
if (! tf)
break;
endif
endfor
endif
endif
elseif (iscellstr (x) && all (cellfun (@iscellstr, varargin)))
## cellstr type. Optimization over cell type by using strcmp.
## FIXME: It would be faster to use strcmp on whole cellstr arrays,
## but bug #51412 needs to be fixed. Instead, time/space trade-off.
## Convert to char (space) for faster processing with strcmp (time).
idx = 1;
x = char (x);
while (tf && idx <= nvarargin)
tf = strcmp (x, char (varargin{idx}));
idx += 1;
endwhile
elseif (iscell (x))
## cell type. Check that each element of a cell is equal. Slow.
n = numel (x);
args = cell (1, 1 + nvarargin);
idx = 1;
while (tf && idx <= n)
args(1) = x{idx};
args(2:end) = [cellindexmat(varargin, idx){:}];
tf = isequaln (args{:});
idx += 1;
endwhile
elseif (is_function_handle (x))
## function type. Use '==' operator which is overloaded.
tf = all (cellfun ("eq", {x}, varargin));
else
error ("isequaln: Impossible to reach code. File a bug report.");
endif
endif
endif
tf = full (tf); # Always return full logical value for Matlab compatibility.
endfunction
## test for equality
%!assert (isequaln (1,1), true)
%!assert (isequaln (1,1,1), true)
%!assert (isequaln ({1,2,NaN,4}, {1,2,NaN,4}), true)
%!assert (isequaln ({1,2,NaN,4}, {1,2,NaN,4}, {1,2,NaN,4}), true)
%!assert (isequaln ([1,2,NaN,4], [1,2,NaN,4]), true)
%!assert (isequaln ([1,2,NaN,4], [1,2,NaN,4], [1,2,NaN,4]), true)
## test for inequality
%!assert (isequaln (1,2), false)
%!assert (isequaln (1,1,2), false)
%!assert (isequaln ([1,2,NaN,4], [1,NaN,3,4]), false)
%!assert (isequaln ([1,2,NaN,4], [1,2,NaN,4], [1,NaN,3,4]), false)
%!assert (isequaln ([1,2,NaN,4], [1,2,3,4]), false)
%!assert (isequaln ([1,2,NaN,4], [1,2,NaN,4], [1,2,3,4]), false)
## test for equality (struct)
%!shared st
%! st = struct ("a",NaN,"b",2);
%!assert (isequaln (st, st), true)
%!assert (isequaln (st, st, st), true)
## Input validation
%!error <Invalid call> isequaln ()
%!error <Invalid call> isequaln (1)
|
