annotate scripts/general/isequal.m @ 9899:9f25290a35e8

more private function and subfunction changes
author John W. Eaton <jwe@octave.org>
date Tue, 01 Dec 2009 22:40:37 -0500
parents a1dbe9d80eee
children c776f063fefe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2005, 2006, 2007 William Poetra Yoga Hadisoeseno
5178
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
2 ##
5181
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe]
jwe
parents: 5178
diff changeset
3 ## This file is part of Octave.
5178
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
5181
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe]
jwe
parents: 5178
diff changeset
9 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## General Public License for more details.
5178
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
14 ##
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5178
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
18
5182
5b361aa47dff [project @ 2005-03-03 06:21:47 by jwe]
jwe
parents: 5181
diff changeset
19 ## -*- texinfo -*-
5550
815926a781f6 [project @ 2005-11-30 03:22:53 by jwe]
jwe
parents: 5549
diff changeset
20 ## @deftypefn {Function File} {} isequal (@var{x1}, @var{x2}, @dots{})
815926a781f6 [project @ 2005-11-30 03:22:53 by jwe]
jwe
parents: 5549
diff changeset
21 ## Return true if all of @var{x1}, @var{x2}, @dots{} are equal.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5550
diff changeset
22 ## @seealso{isequalwithequalnans}
5182
5b361aa47dff [project @ 2005-03-03 06:21:47 by jwe]
jwe
parents: 5181
diff changeset
23 ## @end deftypefn
5178
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
24
5550
815926a781f6 [project @ 2005-11-30 03:22:53 by jwe]
jwe
parents: 5549
diff changeset
25 function retval = isequal (x, varargin)
5181
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe]
jwe
parents: 5178
diff changeset
26
5550
815926a781f6 [project @ 2005-11-30 03:22:53 by jwe]
jwe
parents: 5549
diff changeset
27 if (nargin > 1)
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
28 retval = __isequal__ (false, x, varargin{:});
5550
815926a781f6 [project @ 2005-11-30 03:22:53 by jwe]
jwe
parents: 5549
diff changeset
29 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5720
diff changeset
30 print_usage ();
5550
815926a781f6 [project @ 2005-11-30 03:22:53 by jwe]
jwe
parents: 5549
diff changeset
31 endif
5181
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe]
jwe
parents: 5178
diff changeset
32
5178
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe]
jwe
parents:
diff changeset
33 endfunction
5549
6db3a5df1eab [project @ 2005-11-30 03:15:19 by jwe]
jwe
parents: 5393
diff changeset
34
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
35 ## test size and shape
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
36 %!assert(isequal([1,2,3,4],[1,2,3,4]), true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
37 %!assert(isequal([1;2;3;4],[1;2;3;4]), true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
38 %!assert(isequal([1,2,3,4],[1;2;3;4]), false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
39 %!assert(isequal([1,2,3,4],[1,2;3,4]), false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
40 %!assert(isequal([1,2,3,4],[1,3;2,4]), false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
41
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
42 %!test
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
43 %! A = 1:8;
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
44 %! B = reshape (A, 2, 2, 2);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
45 %! assert (isequal (A, B), false);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
46
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
47 %!test
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
48 %! A = reshape (1:8, 2, 2, 2);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
49 %! B = A;
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
50 %! assert (isequal (A, B), true);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
51
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
52 %!test
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
53 %! A = reshape (1:8, 2, 4);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
54 %! B = reshape (A, 2, 2, 2);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
55 %! assert (isequal (A, B), false);
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
56
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
57 ## test for equality
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
58 %!assert(isequal([1,2,3,4],[1,2,3,4]), true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
59 %!assert(isequal(['a','b','c','d'],['a','b','c','d']), true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
60 ## Test multi-line strings
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
61 %!assert(isequal(["test";"strings"],["test";"strings"],["test";"strings"]), true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
62 ## test for inequality
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
63 %!assert(isequal([1,2,3,4],[1;2;3;4]),false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
64 %!assert(isequal({1,2,3,4},[1,2,3,4]),false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
65 %!assert(isequal([1,2,3,4],{1,2,3,4}),false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
66 %!assert(isequal([1,2,NaN,4],[1,2,NaN,4]),false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
67 %!assert(isequal(['a','b','c','d'],['a';'b';'c';'d']),false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
68 %!assert(isequal({'a','b','c','d'},{'a';'b';'c';'d'}),false)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
69 ## test for equality (struct)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
70 %!assert(isequal(struct('a',1,'b',2),struct('a',1,'b',2)),true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
71 %!assert(isequal(struct('a',1,'b',2),struct('a',1,'b',2),struct('a',1,'b',2)),true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
72 %!assert(isequal(struct('a','abc','b',2),struct('a','abc','b',2)),true)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
73 ## test for inequality (struct)
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
74 %!assert(isequal(struct('a',NaN,'b',2),struct('a',NaN,'b',2),struct('a',NaN,'b',2)),false)