annotate scripts/linear-algebra/commutation_matrix.m @ 3499:3e3e14ad5149

[project @ 2000-01-31 05:18:07 by jwe]
author jwe
date Mon, 31 Jan 2000 05:18:13 +0000
parents 434790acb067
children 38c61cbf086c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1995, 1996 Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
2 ##
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
5 ## the Free Software Foundation; either version 2, or (at your option)
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
6 ## any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
7 ##
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful, but
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
9 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
11 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
12 ##
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
14 ## along with this file. If not, write to the Free Software Foundation,
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
15 ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
16
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
17 ## -*- texinfo -*-
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
18 ## @deftypefn {Function File} {} commutation_matrix (@var{m}, @var{n})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
19 ## Return the commutation matrix
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
20 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
21 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
22 ## $K_{m,n}$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
23 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
24 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
25 ## @ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
26 ## K(m,n)
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
27 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
28 ## which is the unique
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
29 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
30 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
31 ## $m n \times m n$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
32 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
33 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
34 ## @ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
35 ## @var{m}*@var{n} by @var{m}*@var{n}
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
36 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
37 ## matrix such that
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
38 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
39 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
40 ## $K_{m,n} \cdot {\rm vec} (A) = {\rm vec} (A^T)$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
41 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
42 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
43 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3456
diff changeset
44 ## @math{K(m,n) * vec(A) = vec(A')}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
45 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
46 ## for all
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
47 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
48 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
49 ## $m\times n$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
50 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
51 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
52 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3456
diff changeset
53 ## @math{m} by @math{n}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
54 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
55 ## matrices
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
56 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
57 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
58 ## $A$.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
59 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
60 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
61 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3456
diff changeset
62 ## @math{A}.
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
63 ## @end ifinfo
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
64 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
65 ## If only one argument @var{m} is given,
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
66 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
67 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
68 ## $K_{m,m}$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
69 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
70 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
71 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3456
diff changeset
72 ## @math{K(m,m)}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
73 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
74 ## is returned.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
75 ##
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
76 ## See Magnus and Neudecker (1988), Matrix differential calculus with
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
77 ## applications in statistics and econometrics.
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
78 ## @end deftypefn
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
79
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
80 ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
81 ## Created: 8 May 1995
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
82 ## Adapted-By: jwe
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
83
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
84 function k = commutation_matrix (m, n)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
85
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
86 if (nargin < 1 || nargin > 2)
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
87 usage ("commutation_matrix (m, n)");
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
88 else
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
89 if (! (is_scalar (m) && m == round (m) && m > 0))
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
90 error ("commutation_matrix: m must be a positive integer");
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
91 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
92 if (nargin == 1)
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
93 n = m;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
94 elseif (! (is_scalar (n) && n == round (n) && n > 0))
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
95 error ("commutation_matrix: n must be a positive integer");
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
96 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
97 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
98
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
99 ## It is clearly possible to make this a LOT faster!
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
100 k = zeros (m * n, m * n);
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
101 for i = 1 : m
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
102 for j = 1 : n
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
103 k ((i - 1) * n + j, (j - 1) * m + i) = 1;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
104 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
105 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
106
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
107 endfunction