annotate scripts/general/blkdiag.m @ 5552:bcc328604953

[project @ 2005-11-30 05:48:59 by jwe]
author jwe
date Wed, 30 Nov 2005 05:48:59 +0000
parents 71cfd8fedd5d
children f7b4dfd541d1
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 -*-
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
18 ## @deftypefn {Function File} {} blkdiag (@var{a}, @var{b}, @var{c}, ...)
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
19 ## Build a block diagonal matrix from @var{a}, @var{b}, @var{c}, ... .
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.
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
22 ## @end deftypefn
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
23 ##
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
24 ## @seealso{diag, horzcat, vertcat}
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
25
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
26 ## Author: Daniel Calvelo
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
27 ## Modified by: William Poetra Yoga Hadisoeseno
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
28
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
29 function retval = blkdiag (varargin)
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
30
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
31 if (nargin < 1)
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
32 usage ("blkdiag (a, b, c, ...)");
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
33 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
34
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
35 if (! all (cell2mat (cellfun (@isnumeric, varargin))))
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
36 error ("blkdiag: all arguments must be numeric");
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
37 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
38
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
39 ## Note: trailing singletons are automatically (correctly) ignored.
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
40 if (! all (cellfun (@ndims, varargin) == 2))
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
41 error ("all of the arguments to blkdiag must be two-dimensional matrices");
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
42 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
43
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
44 ## Ignore empty matrices.
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
45 notempty = ! cellfun (@isempty, varargin);
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
46 varargin = varargin(notempty);
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
47
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
48 ## 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
49 ## calling size directly.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
50 csz = cumsum ([0 0; (cell2mat (cellfun (@size, varargin')))], 1);
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
51 retval = zeros (csz(end,:));
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
52 for p = 1:(length (notempty(notempty)))
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
53 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
54 endfor
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
55
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
56 endfunction
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
57
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
58 # regular tests
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
59 %!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
60 %!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
61 %!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
62 %!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
63 # tests involving empty matrices
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
64 %!assert(blkdiag([],[],[]),[])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
65 %!assert(blkdiag([],[1,2;3,4],[],5,[]),[1,2,0;3,4,0;0,0,5])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
66 %!assert(blkdiag(zeros(1,0,1),[1,2,3],1,0,5,zeros(0,1,1)),[1,2,3,0,0,0;0,0,0,1,0,0;0,0,0,0,0,0;0,0,0,0,0,5]);
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
67 # sanity checks
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
68 %!test
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
69 %! A = rand (round (rand (1, 2) * 10));
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
70 %! assert (blkdiag (A), A);