annotate scripts/general/blkdiag.m @ 5657:fb1de6e6343b

[project @ 2006-03-09 19:21:39 by jwe]
author jwe
date Thu, 09 Mar 2006 19:21:39 +0000
parents 2618a0750ae6
children 067948dc39bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2000 Daniel Calvelo
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
2 ##
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
6 ## (at your option) any later version.
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
7 ##
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
11 ## GNU General Public License for more details.
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
12 ##
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
16
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
17 ## -*- texinfo -*-
5657
fb1de6e6343b [project @ 2006-03-09 19:21:39 by jwe]
jwe
parents: 5642
diff changeset
18 ## @deftypefn {Function File} {} blkdiag (@var{a}, @var{b}, @var{c}, @dots{})
fb1de6e6343b [project @ 2006-03-09 19:21:39 by jwe]
jwe
parents: 5642
diff changeset
19 ## Build a block diagonal matrix from @var{a}, @var{b}, @var{c}, @dots{}.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
20 ## All the arguments must be numeric and are two-dimensional matrices or
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
21 ## scalars.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5601
diff changeset
22 ## @seealso{diag, horzcat, vertcat}
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
23 ## @end deftypefn
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
24
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
25 ## Author: Daniel Calvelo
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
26 ## Modified by: William Poetra Yoga Hadisoeseno
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
27
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
28 function retval = blkdiag (varargin)
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
29
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
30 if (nargin < 1)
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
31 usage ("blkdiag (a, b, c, ...)");
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
32 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
33
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
34 if (! all (cell2mat (cellfun (@isnumeric, varargin))))
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
35 error ("blkdiag: all arguments must be numeric");
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
36 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
37
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
38 ## Note: trailing singletons are automatically (correctly) ignored.
5569
f7b4dfd541d1 [project @ 2005-12-08 16:57:31 by jwe]
jwe
parents: 5552
diff changeset
39 if (! all (cellfun ("ndims", varargin) == 2))
5657
fb1de6e6343b [project @ 2006-03-09 19:21:39 by jwe]
jwe
parents: 5642
diff changeset
40 error ("blkdiag: all arguments must be two-dimensional matrices");
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
41 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
42
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
43 ## size is an option for cellfun, but it's a bit different from
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
44 ## calling size directly.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
45 csz = cumsum ([0 0; (cell2mat (cellfun (@size, varargin')))], 1);
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
46 retval = zeros (csz(end,:));
5592
61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman]
dbateman
parents: 5574
diff changeset
47
61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman]
dbateman
parents: 5574
diff changeset
48 for p = 1:nargin
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
49 retval((csz(p,1)+1):csz(p+1,1),(csz(p,2)+1):csz(p+1,2)) = varargin{p};
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
50 endfor
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
51
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
52 endfunction
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
53
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
54 # regular tests
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
55 %!assert(blkdiag(1,ones(2),1),[1,0,0,0;0,1,1,0;0,1,1,0;0,0,0,1])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
56 %!assert(blkdiag([1,2],[3,4],[5,6]),[1,2,0,0,0,0;0,0,3,4,0,0;0,0,0,0,5,6])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
57 %!assert(blkdiag([1,2],[3;4],[5,6]),[1,2,0,0,0;0,0,3,0,0;0,0,4,0,0;0,0,0,5,6])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
58 %!assert(blkdiag([1,2;3,4],[5,6,7]),[1,2,0,0,0;3,4,0,0,0;0,0,5,6,7])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
59 # tests involving empty matrices
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
60 %!assert(blkdiag([],[],[]),[])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
61 %!assert(blkdiag([],[1,2;3,4],[],5,[]),[1,2,0;3,4,0;0,0,5])
5601
c8ed37d87923 [project @ 2006-01-21 20:08:33 by dbateman]
dbateman
parents: 5592
diff changeset
62 %!assert(blkdiag(zeros(1,0,1),[1,2,3],1,0,5,zeros(0,1,1)),[0,0,0,0,0,0,0;1,2,3,0,0,0,0;0,0,0,1,0,0,0;0,0,0,0,0,0,0;0,0,0,0,0,5,0]);
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
63 # sanity checks
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
64 %!test
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
65 %! A = rand (round (rand (1, 2) * 10));
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
66 %! assert (blkdiag (A), A);