annotate scripts/special-matrix/sylvester_matrix.m @ 8517:81d6ab3ac93c

Allow documentation tobe built for other formats than tex and info
author sh@sh-laptop
date Wed, 14 Jan 2009 20:44:25 -0500
parents 83a8781b529d
children eb63fbe60fab
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) 1996, 1997, 1998, 1999, 2000, 2002, 2004, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2007 John W. Eaton
3140
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
3 ##
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
5 ##
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## 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
9 ## your option) any later version.
3140
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
10 ##
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
15 ##
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
3140
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
19
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
20 ## -*- texinfo -*-
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
21 ## @deftypefn {Function File} {} sylvester_matrix (@var{k})
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
22 ## Return the Sylvester matrix of order
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
23 ## @iftex
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
24 ## @tex
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
25 ## $n = 2^k$.
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
26 ## @end tex
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
27 ## @end iftex
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 7411
diff changeset
28 ## @ifnottex
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
29 ## n = 2^k.
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 7411
diff changeset
30 ## @end ifnottex
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
31 ## @seealso{hankel, vander, hilb, invhilb, toeplitz}
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
32 ## @end deftypefn
3140
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
33
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
34 ## Author: jwe
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
35
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
36 function retval = sylvester_matrix (k)
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
37
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
38 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
39 print_usage ();
3140
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
40 endif
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
41
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3408
diff changeset
42 if (isscalar (k))
3140
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
43 if (k < 1)
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
44 retval = 1;
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
45 else
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
46 tmp = sylvester_matrix (k-1);
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
47 retval = [tmp, tmp; tmp, -tmp];
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
48 endif
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
49 else
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
50 error ("sylvester_matrix: expecting scalar argument");
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
51 endif
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
52
990ea337e950 [project @ 1998-02-03 08:07:51 by jwe]
jwe
parents:
diff changeset
53 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
54
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
55 %!assert((sylvester_matrix (1) == [1, 1; 1, -1]
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
56 %! && (sylvester_matrix (2)
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
57 %! == [1, 1, 1, 1; 1, -1, 1, -1; 1, 1, -1, -1; 1, -1, -1, 1])));
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
58
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
59 %!error sylvester_matrix ([1, 2; 3, 4]);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
60
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
61 %!error sylvester_matrix ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
62
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
63 %!error sylvester_matrix (1, 2);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
64