annotate scripts/linear-algebra/duplication_matrix.m @ 4720:e759d01692db ss-2-1-53

[project @ 2004-01-23 04:13:37 by jwe]
author jwe
date Fri, 23 Jan 2004 04:13:37 +0000
parents 22bd65326ec1
children 4c8a2e4e0717
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 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
6 ## under the terms of the GNU General Public License as published by
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
7 ## 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
8 ## any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
9 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
12 ## 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
13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
14 ##
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3499
diff changeset
18 ## 02111-1307, USA.
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
19
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
20 ## -*- texinfo -*-
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
21 ## @deftypefn {Function File} {} duplication_matrix (@var{n})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
22 ## Return the duplication matrix
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
23 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
24 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
25 ## $D_n$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
26 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
27 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
28 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3426
diff changeset
29 ## @math{Dn}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
30 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
31 ## which is the unique
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
32 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
33 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
34 ## $n^2 \times n(n+1)/2$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
35 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
36 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
37 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3426
diff changeset
38 ## @math{n^2} by @math{n*(n+1)/2}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
39 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
40 ## matrix such that
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
41 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
42 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
43 ## $D_n * {\rm vech} (A) = {\rm vec} (A)$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
44 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
45 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
46 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3426
diff changeset
47 ## @math{Dn vech (A) = vec (A)}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
48 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
49 ## for all symmetric
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
50 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
51 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
52 ## $n \times n$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
53 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
54 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
55 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3426
diff changeset
56 ## @math{n} by @math{n}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
57 ## @end ifinfo
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
58 ## matrices
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
59 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
60 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
61 ## $A$.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
62 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
63 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
64 ## @ifinfo
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3426
diff changeset
65 ## @math{A}.
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
66 ## @end ifinfo
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
67 ##
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
68 ## See Magnus and Neudecker (1988), Matrix differential calculus with
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
69 ## applications in statistics and econometrics.
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2540
diff changeset
70 ## @end deftypefn
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
71
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
72 ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
73 ## Created: 8 May 1995
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
74 ## Adapged-By: jwe
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
75
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
76 function d = duplication_matrix (n)
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
77
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
78 if (nargin != 1)
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
79 usage ("duplication_matrix (n)");
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
80 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
81
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
82 if (! (isscalar (n) && n == round (n) && n > 0))
2540
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
83 error ("duplication_matrix: n must be a positive integer");
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
84 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
85
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
86 d = zeros (n * n, n * (n + 1) / 2);
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
87
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
88 ## It is clearly possible to make this a LOT faster!
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
89 count = 0;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
90 for j = 1 : n
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
91 d ((j - 1) * n + j, count + j) = 1;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
92 for i = (j + 1) : n
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
93 d ((j - 1) * n + i, count + i) = 1;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
94 d ((i - 1) * n + j, count + i) = 1;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
95 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
96 count = count + n - j;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
97 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
98
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe]
jwe
parents:
diff changeset
99 endfunction