Mercurial > octave
annotate scripts/special-matrix/magic.m @ 25235:27e6b38571d3
magic.m: Issue an error if input N is negative (bug #53441).
* magic.m: Check for negative N and call error() if found.
Add BIST test to check new code.
author | Dildar Sk <dildarsk101010@gmail.com> |
---|---|
date | Fri, 23 Mar 2018 19:03:45 -0400 |
parents | 6652d3823428 |
children | 00f796120a6d |
rev | line source |
---|---|
25054
6652d3823428
maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents:
24534
diff
changeset
|
1 ## Copyright (C) 1999-2018 Paul Kienzle |
5827 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23573
diff
changeset
|
5 ## Octave is free software: you can redistribute it and/or modify it |
5827 | 6 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23573
diff
changeset
|
7 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22489
diff
changeset
|
8 ## (at your option) any later version. |
5827 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22489
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22489
diff
changeset
|
13 ## GNU General Public License for more details. |
5827 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23573
diff
changeset
|
17 ## <https://www.gnu.org/licenses/>. |
5827 | 18 |
19 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20162
diff
changeset
|
20 ## @deftypefn {} {} magic (@var{n}) |
5827 | 21 ## |
20162
2645f9ef8c88
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
22 ## Create an @var{n}-by-@var{n} magic square. |
2645f9ef8c88
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
23 ## |
2645f9ef8c88
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
24 ## A magic square is an arrangement of the integers @code{1:n^2} such that the |
2645f9ef8c88
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
25 ## row sums, column sums, and diagonal sums are all equal to the same value. |
5827 | 26 ## |
21751
b571fc85953f
maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
27 ## Note: @var{n} must be a scalar greater than or equal to 3. If you supply |
20854
cdf08aacfd86
magic.m: magic(N) accepting all integers (matlab compatibility)
Bernardo Sulzbach <mafagafogigante@gmail.com>
parents:
20852
diff
changeset
|
28 ## @var{n} less than 3, magic returns either a nonmagic square, or else the |
cdf08aacfd86
magic.m: magic(N) accepting all integers (matlab compatibility)
Bernardo Sulzbach <mafagafogigante@gmail.com>
parents:
20852
diff
changeset
|
29 ## degenerate magic squares 1 and []. |
5827 | 30 ## @end deftypefn |
31 | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
32 function A = magic (n) |
5827 | 33 |
34 if (nargin != 1) | |
35 print_usage (); | |
36 endif | |
37 | |
20881
7234cbd04292
magic.m:Fix failing tests after cset cdf08aacfd86
Andreas Weber <andy.weber.aw@gmail.com>
parents:
20854
diff
changeset
|
38 n = fix (n); |
25235
27e6b38571d3
magic.m: Issue an error if input N is negative (bug #53441).
Dildar Sk <dildarsk101010@gmail.com>
parents:
25054
diff
changeset
|
39 if (n < 0) |
27e6b38571d3
magic.m: Issue an error if input N is negative (bug #53441).
Dildar Sk <dildarsk101010@gmail.com>
parents:
25054
diff
changeset
|
40 error ("magic: N must be non-negative"); |
27e6b38571d3
magic.m: Issue an error if input N is negative (bug #53441).
Dildar Sk <dildarsk101010@gmail.com>
parents:
25054
diff
changeset
|
41 elseif (n < 1) |
5827 | 42 A = []; |
43 elseif (mod (n, 2) == 1) | |
44 | |
45 shift = floor ((0:n*n-1)/n); | |
46 c = mod ([1:n*n] - shift + (n-3)/2, n); | |
47 r = mod ([n*n:-1:1] + 2*shift, n); | |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
48 A(c*n+r+1) = 1:n*n; |
5827 | 49 A = reshape (A, n, n); |
50 | |
51 elseif (mod (n, 4) == 0) | |
52 | |
53 A = reshape (1:n*n, n, n)'; | |
54 I = [1:4:n, 4:4:n]; | |
55 J = fliplr (I); | |
56 A(I,I) = A(J,J); | |
57 I = [2:4:n, 3:4:n]; | |
58 J = fliplr (I); | |
59 A(I,I) = A(J,J); | |
60 | |
61 elseif (mod (n, 4) == 2) | |
62 | |
63 m = n/2; | |
64 A = magic (m); | |
65 A = [A, A+2*m*m; A+3*m*m, A+m*m]; | |
66 k = (m-1)/2; | |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
67 if (k > 1) |
5827 | 68 I = 1:m; |
69 J = [2:k, n-k+2:n]; | |
70 A([I,I+m],J) = A([I+m,I],J); | |
71 endif | |
72 I = [1:k, k+2:m]; | |
73 A([I,I+m],1) = A([I+m,I],1); | |
74 I = k + 1; | |
75 A([I,I+m],I) = A([I+m,I],I); | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
76 |
5827 | 77 endif |
78 | |
79 endfunction | |
80 | |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
81 |
5827 | 82 %!test |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
83 %! for i = 3:30 |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
84 %! A = magic (i); |
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
85 %! assert (norm(diff([sum(diag(A)),sum(diag(flipud(A))),sum(A),sum(A')])),0); |
5827 | 86 %! endfor |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
87 |
22489
93ea313301f9
test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
88 ## Not a magic square but we must return something (bug #46672). |
20891
95c0d4c07c56
magic: add tests for magic(2) (bug #46672)
Carnë Draug <carandraug@octave.org>
parents:
20881
diff
changeset
|
89 ## While one day we may change the actual return of magic (2), |
95c0d4c07c56
magic: add tests for magic(2) (bug #46672)
Carnë Draug <carandraug@octave.org>
parents:
20881
diff
changeset
|
90 ## this properties still must be true. |
23573
1b4f4ec53b4a
use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents:
23572
diff
changeset
|
91 %!test <*46672> |
20891
95c0d4c07c56
magic: add tests for magic(2) (bug #46672)
Carnë Draug <carandraug@octave.org>
parents:
20881
diff
changeset
|
92 %! m = magic (2); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
20891
diff
changeset
|
93 %! assert (size (m), [2 2]); |
25235
27e6b38571d3
magic.m: Issue an error if input N is negative (bug #53441).
Dildar Sk <dildarsk101010@gmail.com>
parents:
25054
diff
changeset
|
94 %! assert (m, [4 3; 1 2]); |
20891
95c0d4c07c56
magic: add tests for magic(2) (bug #46672)
Carnë Draug <carandraug@octave.org>
parents:
20881
diff
changeset
|
95 |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
96 %!assert (isempty (magic (0))) |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
97 %!assert (magic (1), 1) |
20881
7234cbd04292
magic.m:Fix failing tests after cset cdf08aacfd86
Andreas Weber <andy.weber.aw@gmail.com>
parents:
20854
diff
changeset
|
98 %!assert (magic (1.5), 1) |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
99 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
100 ## Test input validation |
13891
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
101 %!error magic () |
5180791b8d9e
magic.m: Use Octave spacing convention. Add more input validation tests.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
102 %!error magic (1, 2) |
25235
27e6b38571d3
magic.m: Issue an error if input N is negative (bug #53441).
Dildar Sk <dildarsk101010@gmail.com>
parents:
25054
diff
changeset
|
103 %!error <N must be non-negative> magic (-5) |